From fsu-lists at cobweb.ch  Wed Aug  1 12:32:57 2012
From: fsu-lists at cobweb.ch (=?windows-1252?Q?Fran=E7ois_Suter?=)
Date: Wed, 01 Aug 2012 12:32:57 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.431.1343632797.626.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
	<mailman.10852.1343400249.658.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343496908.21052.typo3-project-documentation@lists.typo3.org>
	<mailman.431.1343632797.626.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343817178.19997.typo3-project-documentation@lists.typo3.org>

Hi,

> Basically it's all in http://www.ietf.org/rfc/rfc4646.txt ? but to simplify things a bit, you can take a shortcut an look at the Locale class in FLOW3.
>
> The regex we are using takes most cases of the standard into account:
>
> /^(?P<language>[a-zA-Z]{2,3})(?:[-_](?P<script>[a-zA-Z]{4}))?(?:[-_](?P<region>[a-zA-Z]{2}|[0-9]{3})){0,1}(?:[-_](?P<variant>(?:[a-zA-Z0-9]{5,8})|(?:[0-9][a-zA-Z0-9]{3})))?(?:[-_].+)*$/

I've just found that there's actually a LocaleIdentifierValidator, so 
that's all I need :-)

BTW any idea how long a fully qualified locale identifier can be? I had 
start with a naive 5-character length (assuming the form was xx_YY), but 
I see that it can be much longer. I've settled on 50 for now, is that 
safe enough?

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Wed Aug  1 12:59:52 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Wed, 01 Aug 2012 12:59:52 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>

Hi all,

I pushed a new version of the domain model to 
https://github.com/typo3/TYPO3.Docs

Here are the changes, all as discussed in this thread:

- the "Documentation" model has become "Document". All references, 
methods, properties, etc., related to that across all models have been 
renamed accordingly.
- a "type" field was added to the "Document" model. This would be an 
arbitrary string defining the type of document, e.g. a "manual".
- for the "version" field of the "Document" model, I didn't apply any 
specific validation (except for NotEmpty) as it seems a bit hairy to 
properly test if a given string is compatible with version_compare() 
(which accepts pretty much anything, although results might be 
unpredictable). I just added a note in the property declaration, that it 
should adhere to version_compare() standards.
- for the "language" field, I followed Robert's hint and actually found 
that there was a locale validator already in FLOW3. So I just used that. 
I made the field longer, though, as the locale identifier can be quite long.
- added an "Author" model, which extends the Person model from 
TYPO3.Party. Right now it's only used for having a "documents" property 
allowing to have a reverse relation to documents. I didn't add things 
like a "company" property, because it's not clear whether we will need 
that for now. At least our manuals don't include such information. 
Furthermore we must keep in mind that this database is meant to contain 
information about what manuals are available, but not necessarily every 
little detail about each manual.

Feedback welcome, as usual.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Wed Aug  1 13:30:36 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Wed, 01 Aug 2012 13:30:36 +0200
Subject: [TYPO3-doc] Restoring the official manual example
In-Reply-To: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>

Hi,

> I worked on restoring the official manual example, adapted to
> ReStructured Text. This is meant - as before - to be the basis for new
> official manuals. I have pushed a first version to Gerrit:

I just pushed patchset #4 and #5 to https://review.typo3.org/#/c/13084/

The main changes are - as discussed elsewhere in the thread:

- the removal of the underline role. IMO we should really stick to 
emphasis and strong emphasis. Underline is not an appropriate style to 
carry over to HTML rendering. For the other media, we are still free to 
interpret various levels of emphasis as underline.
- I have changed the use of "image" to the use of "figure". There have 
been side-effects though. The image now appears on top of the "Chapter1" 
page rather than at the bottom and the reference still appears at the 
bottom (the caption appears fine, after the correction applied in 
patchset #5). What did I do wrong?

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From m.bless at gmx.de  Wed Aug  1 17:58:35 2012
From: m.bless at gmx.de (Martin Bless)
Date: Wed, 01 Aug 2012 17:58:35 +0200
Subject: [TYPO3-doc] Restoring the official manual example
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>

Fran?ois Suter,

>- I have changed the use of "image" to the use of "figure". There have 
>been side-effects though. The image now appears on top of the "Chapter1" 
>page rather than at the bottom and the reference still appears at the 
>bottom (the caption appears fine, after the correction applied in 
>patchset #5). What did I do wrong?

It turns out that we can't use the replacement technique for figures.
Docutils defines the replacement directive:

.. |name| replace:: paragraph

Which allows to use |name| instead of the paragraph. Paragraph is
restricted to text with "inline markup".

Sphinx has extended the replacement technique so that it works for
"image::" as well. But there is no such thing for "figure::". My first
impulse was: "Wow, that's inconsistent, I should add a feature request
to the Sphinx bugtracker." But then I came to the conclusion that the
current situation - probably - is there very much on purpose. The
answer will probably be: Figures with caption and description usually
occur only once. They should therefor go directly into the text. And
the caption and description belong to the text to make the ReST source
complete und understandable.

I did that change in Patchset #6. At least I wanted it to become #6.
What I got instead was this:
http://review.typo3.org/13415

Hhm, what did I do wrong? It's the first time I just tried the -m
"Change-Id: ..." on the commandline, that's probably the error. I
should have use the exect existing commit message!? 

-F "../commit-msg.txt"

is what I had been using before.


marble at SANDYMAX
/d/Repositories/git.typo3.org/Documentation/TYPO3/Example/kannweg/OfficialManual.git
(patchset13084#6)
$ git commit --amend -a -m " Change-Id:
Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f "
[patchset13084#6 d6cd673]  Change-Id:
Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f
 Author: Francois Suter <francois at typo3.org>
 13 files changed, 1144 insertions(+)
 create mode 100644 Documentation/Chapter1/Index.rst
 create mode 100644 Documentation/Images.txt
 create mode 100644
Documentation/Images/IntroductionPackageLoginScreen.png
 create mode 100644 Documentation/Includes.txt
 create mode 100644 Documentation/Index.rst
 create mode 100644 Documentation/Introduction/Index.rst
 create mode 100644 Documentation/NextSteps/Index.rst
 create mode 100644 Documentation/_make/Makefile
 create mode 100644 Documentation/_make/_not_versioned/.gitignore
 create mode 100644 Documentation/_make/build/.gitignore
 create mode 100644 Documentation/_make/conf.py
 create mode 100644 Documentation/_make/make-html.bat
 create mode 100644 Documentation/_make/make.bat
 delete mode 100644 Readme

marble at SANDYMAX
/d/Repositories/git.typo3.org/Documentation/TYPO3/Example/kannweg/OfficialManual.git
(patchset13084#6)
$ git push origin HEAD:refs/for/master
Counting objects: 22, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (15/15), done.
Writing objects: 100% (21/21), 109.76 KiB, done.
Total 21 (delta 0), reused 0 (delta 0)
remote:
remote: New Changes:
remote:   http://review.typo3.org/13415
remote:
To
ssh://marble at review.typo3.org:29418/Documentation/TYPO3/Example/OfficialManual.git
 * [new branch]      HEAD -> refs/for/master



This is the result of my change. The figure appears as desired:
http://preview.docs.typo3.org/TYPO3/OfficialManualExample/Chapter1/Index.html

The corresponding ReST:
http://preview.docs.typo3.org/TYPO3/OfficialManualExample/_sources/Chapter1/Index.txt

Since the Images.txt file is empty I removed it and removed the "..
include:: Images.txt" line.

Over!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From fsu-lists at cobweb.ch  Wed Aug  1 18:35:52 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Wed, 01 Aug 2012 18:35:52 +0200
Subject: [TYPO3-doc] Restoring the official manual example
In-Reply-To: <mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343838954.13785.typo3-project-documentation@lists.typo3.org>

Hi Martin,

> It turns out that we can't use the replacement technique for figures.
> Docutils defines the replacement directive:

I see.

> They should therefor go directly into the text. And
> the caption and description belong to the text to make the ReST source
> complete und understandable.

Yes, it makes sense and is fine this way. Thanks for digging.

> I did that change in Patchset #6. At least I wanted it to become #6.
> What I got instead was this:
> http://review.typo3.org/13415
>
> Hhm, what did I do wrong? It's the first time I just tried the -m
> "Change-Id: ..." on the commandline, that's probably the error. I
> should have use the exect existing commit message!?

Indeed you created a new review:

https://review.typo3.org/#/c/13415/

You should have done a "git commit -a --amend". This adds your changes 
to the current change and lets you edit the commit message (which you 
generally want to leave as is). Then since the ChangeId is the same, 
when you push again, it becomes a new patchset in the existing submission.

I'll try to see if I can bring you patchset "back home".

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Wed Aug  1 18:49:06 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Wed, 01 Aug 2012 18:49:06 +0200
Subject: [TYPO3-doc] Restoring the official manual example
In-Reply-To: <mailman.1.1343838954.13785.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343838954.13785.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343839747.15705.typo3-project-documentation@lists.typo3.org>

> I'll try to see if I can bring you patchset "back home".

Basically works, but no time to finish tonight. Will push that tomorrow.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From m.bless at gmx.de  Thu Aug  2 09:46:07 2012
From: m.bless at gmx.de (Martin Bless)
Date: Thu, 02 Aug 2012 09:46:07 +0200
Subject: [TYPO3-doc] Restoring the official manual example
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343838954.13785.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343893572.27399.typo3-project-documentation@lists.typo3.org>


>You should have done a "git commit -a --amend".

Yes, I did that, but the commit message wasn't "good" it seems. I
tried to use just the minimum:

$ git commit --amend -a \
-m " Change-Id: Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f "

Martin

From fsu-lists at cobweb.ch  Thu Aug  2 11:03:44 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 02 Aug 2012 11:03:44 +0200
Subject: [TYPO3-doc] Restoring the official manual example
In-Reply-To: <mailman.1.1343893572.27399.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343838954.13785.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343893572.27399.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343898225.8920.typo3-project-documentation@lists.typo3.org>

Hi Martin,

> $ git commit --amend -a \
> -m  " Change-Id: Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f"

But why did you add the ChangeId with the -m option. This became the new 
commit message. And I guess it introduced a confusion which led Git to 
generate a new ChangeId, hence a new review request.

Anyway, I'll finish merging your stuff later today. No worries.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Thu Aug  2 14:44:08 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 02 Aug 2012 14:44:08 +0200
Subject: [TYPO3-doc] Restoring the official manual example
In-Reply-To: <mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343911449.11861.typo3-project-documentation@lists.typo3.org>

Hi Martin,

> I did that change in Patchset #6. At least I wanted it to become #6.
> What I got instead was this:
> http://review.typo3.org/13415

I thought I could salvage your changes with some Git manipulation, but 
this is obviously beyond my current Git foo, which is limited.

Anyway the change was small so I applied it manually to my local copy 
and submitted patchset #6. If you find it ok, I'll merge it.

Could you please abandon https://review.typo3.org/#/c/13415/1 ? Only the 
owner can abandon a review request.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From philipp.gampe at typo3.org  Thu Aug  2 15:57:22 2012
From: philipp.gampe at typo3.org (Philipp Gampe)
Date: Thu, 02 Aug 2012 15:57:22 +0200
Subject: [TYPO3-doc] Restoring the official manual example
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343838954.13785.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343893572.27399.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343915842.22874.typo3-project-documentation@lists.typo3.org>

Hi Martin,

Martin Bless wrote:

> 
>>You should have done a "git commit -a --amend".
> 
> Yes, I did that, but the commit message wasn't "good" it seems. I
> tried to use just the minimum:
> 
> $ git commit --amend -a \
> -m " Change-Id: Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f "

I can only recommend you to spend some time with the git book:
http://git-scm.com/book/de

Note: -m modifies the entire commit message. You changed the subject (the 
first line) to the change id line. Then the hook generated a new change ID, 
because it did not find the change id in the message body.
You should read commit messages like emails (actually they are supposed to 
be emails ;) ). The first line is the subject, followed by a blank line and 
then the message body.

Cheers
-- 
Philipp Gampe ? PGP-Key 0AD96065 ? TYPO3 UG Bonn/K?ln
Documentation ? linkvalidator
TYPO3 .... inspiring people to share!


From fsu-lists at cobweb.ch  Thu Aug  2 18:34:57 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 02 Aug 2012 18:34:57 +0200
Subject: [TYPO3-doc]  Organization for the next steps
Message-ID: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>

Hi all,

I'll be on holiday for 2 weeks starting this coming Saturday. I wanted 
to recap the situation before I leave.

- work on the official documentation has started on the ReST files. A 
couple of patches have already been committed. Besides that there's a 
lot of work needed renaming images to useful names and changing from 
using the "image" directive to the "figure" directive, as discussed in a 
recent thread. The main impact is that the current inclusion system 
cannot be used anymore and the directives have to be moved back to their 
respective places inside the documents.

- the FLOW3-side of things has also made progress, with Fabien working 
on the automation of the rendering process and myself on the domain 
model. This will continue in the coming weeks and is where the most work 
is needed as soon as possible.

- Philipp Gampe is ready to work on the the Extension Manager 
integration. This is not just about having links pointing to the new 
documentation site, but about migration all manuals from the system 
extensions to ReST format. The EM would gain the ability to view the raw 
ReST files in the TYPO3 BE, in case people don't have an internet 
connection to view the manuals online. Philipp will need help with this 
migration, I'm particularly worried about old manuals, such as 
rtehtmlarea's.  This is all made in agreement with the RM team of TYPO3 
6.0 (I'll post to the Core list right after this mail) and may even come 
after feature freeze, as it's not a functional change. We will still try 
to make it happen as quickly as possible. BTW this should apply to the 
new-new EM, that should make it into 6.0.

I guess that should keep you busy for the next 2 weeks ;-)

If you have questions, don't hesitate to ask, I can still answer until 
tomorrow.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From jigal.van.hemert at typo3.org  Thu Aug  2 19:48:25 2012
From: jigal.van.hemert at typo3.org (Jigal van Hemert)
Date: Thu, 02 Aug 2012 19:48:25 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343929715.30410.typo3-project-documentation@lists.typo3.org>

Hi,

On 2-8-2012 18:34, Fran?ois Suter wrote:
> The EM would gain the ability to view the raw ReST files in the TYPO3
> BE,
[...]
> and may even come after feature freeze, as it's not a functional
> change.

Of course it's a functional change; it adds a functionality! Besides, 
it's a feature and that is enough to have it in before *feature* freeze...

-- 
Jigal van Hemert
TYPO3 Core Team member

TYPO3 .... inspiring people to share!
Get involved: typo3.org

From fsu-lists at cobweb.ch  Thu Aug  2 19:59:46 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 02 Aug 2012 19:59:46 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343929715.30410.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343929715.30410.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343930389.32423.typo3-project-documentation@lists.typo3.org>

Hi Jigal,

> Of course it's a functional change; it adds a functionality! Besides,
> it's a feature and that is enough to have it in before *feature* freeze...

In a sense it is functional, but anyway I have discussed this 
possibility with the RM team. I guess we'll see when the time comes, but 
we're definitely going to try and make it.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Thu Aug  2 22:02:02 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 02 Aug 2012 22:02:02 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343937723.17613.typo3-project-documentation@lists.typo3.org>

Hi all,

> I pushed a new version of the domain model to
> https://github.com/typo3/TYPO3.Docs

Just added a "uri" property to the Document domain model, meant to 
describe at which URI the document is available.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From erreti at gmail.com  Thu Aug  2 22:34:18 2012
From: erreti at gmail.com (Roberto Torresani)
Date: Thu, 2 Aug 2012 22:34:18 +0200
Subject: [TYPO3-doc] What tool for our meetings?
In-Reply-To: <mailman.1.1343381498.20670.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343074716.24661.typo3-project-documentation@lists.typo3.org>
	<mailman.9877.1343113787.658.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343118258.14942.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343122563.26252.typo3-project-documentation@lists.typo3.org>
	<mailman.10270.1343207751.658.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343381498.20670.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1323.1343939681.626.typo3-project-documentation@lists.typo3.org>

Hi Fran?ois!
I hope have time in the next two weeks to set up the connection
between openmeetings and Asterisk. In this way it will be able to
connect in videoconference with browser or with a sip-phone.
I think HTML5 will in the near future, but I have no roadmap on this evolution.

I'll update in the coming weeks.
Roberto


2012/7/27 Fran?ois Suter <fsu-lists at cobweb.ch>:
> Hi Roberto,
>
>
>> I set up a new OpenMeetings platform on a demo server.
>> After connecting to http://77.72.193.243/openmeetings/ you can click
>> on "Not a member" for register a new user.
>> It is a new demo server and I hope that I have installed and
>> configured all the packages (I haven't configured the sip module). If
>> you find any problem write me.
>>
>> Openmeetings is very intuitive, but if you have problems you find a
>> manual:
>> https://cwiki.apache.org/confluence/display/OPENMEETINGS/Manuals+user+OpenMeetings+various
>> or you can ask me.
>
>
> Thanks a lot for having made the effort of setting up this test server.
>
> I took a quick look at it this morning and I'm not really convinced. It
> seems actually more complete than BBB and has an impressive array of
> features, but we still have the problem that it is Flash-driven. Furthermore
> the interface has a tendency to flicker that is rather disturbing, but that
> might have been related to my client (Chrome on Mac).
>
> It would be good if those users who had trouble connecting to BBB (Jacob,
> I'm looking at you ;-) ) could give OpenMeeting a spin to see if it helps.
>
>
> Cheers
>
> --
>
> Francois Suter
> Cobweb Development Sarl - http://www.cobweb.ch
> _______________________________________________
> TYPO3-project-documentation mailing list
> TYPO3-project-documentation at lists.typo3.org
> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-project-documentation



-- 
Certified TYPO3 Integrator

From m.bless at gmx.de  Thu Aug  2 22:42:32 2012
From: m.bless at gmx.de (Martin Bless)
Date: Thu, 02 Aug 2012 22:42:32 +0200
Subject: [TYPO3-doc] Restoring the official manual example
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343911449.11861.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343940156.23820.typo3-project-documentation@lists.typo3.org>

Hello Fran?ois,

>I thought I could salvage your changes with some Git manipulation, but 
>this is obviously beyond my current Git foo, which is limited.

Yes, Git has wonderful features. But it takes some time to become a
Git Guru.

@Philipp: Thanks for your advice. Every now and then I spend some time
reading about Git and then I try using it. Making mistakes seems an
inevitable companion of learning ...

>Anyway the change was small so I applied it manually to my local copy 
>and submitted patchset #6. If you find it ok, I'll merge it.

Yes, looks ok to me. I supplemented the last sentence in
'NextSteps.rst' though and submitted it as #7 (yes, got it right this
time again). So you maybe better merge #7. The sentence now reads: 

"""
This is *some emphasis* and this is **strong emphasis**. There can
also be so-called ``inline literals`` rendered in monospaced font. To
write an asterisk, you have to escape it \*. The same is true for the
back-tick \`, the underscore \_, the vertical bar \| and the backslash
\\ itself.
"""

>Could you please abandon https://review.typo3.org/#/c/13415/1 ? Only the 
>owner can abandon a review request.

Did that! Over!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From m.bless at gmx.de  Thu Aug  2 22:45:58 2012
From: m.bless at gmx.de (Martin Bless)
Date: Thu, 02 Aug 2012 22:45:58 +0200
Subject: [TYPO3-doc] Restoring the official manual example
References: <mailman.1.1343333801.11577.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343820638.28001.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343836718.8045.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343911449.11861.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343940156.23820.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343940362.23820.typo3-project-documentation@lists.typo3.org>


>So you maybe better merge #7.

Ah, I forgot:

You can always request a rebuild of the current master by clicking:
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git.make/request_rebuild.php

To learn more about 'warnings.txt' or the build configuration see:
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git.make

And to see the result, of course, go to:
http://preview.docs.typo3.org/TYPO3/OfficialManualExample/

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From fabien.udriot at ecodev.ch  Fri Aug  3 00:19:10 2012
From: fabien.udriot at ecodev.ch (Fabien Udriot)
Date: Fri, 03 Aug 2012 00:19:10 +0200
Subject: [TYPO3-doc]  URL scheme for documentation
Message-ID: <mailman.1.1343945950.5446.typo3-project-documentation@lists.typo3.org>

Hi,

The topic was already discussed but I am confused with the conclusion. Have we already agreed with
the URL scheme regarding how documentation will be structured. I remember Martin has some note at
least about that. At the moment, I have in sight this link:

http://preview.docs.typo3.org/TYPO3/

... where extensions are into

http://preview.docs.typo3.org/TYPO3/Extensions/

More pointers?

Fb.

From fabien.udriot at ecodev.ch  Fri Aug  3 00:21:14 2012
From: fabien.udriot at ecodev.ch (Fabien Udriot)
Date: Fri, 03 Aug 2012 00:21:14 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>

Hi,

> The EM would gain the ability to view the raw ReST files in the TYPO3 BE,
> in case people don't have an internet connection to view the manuals online. 

Couldn't be that the system grab the rendered HTML on-line and put it somewhere (e.g. typo3temp) for
off-line reading. Reading regular web pages looks a bit more comfortable than Rest files (even
though the format is human readable). And if we have a comment system at some point it could also be
displayed there when connected to the internet. Just an idea!

Fb.

From jigal.van.hemert at typo3.org  Fri Aug  3 06:49:12 2012
From: jigal.van.hemert at typo3.org (Jigal van Hemert)
Date: Fri, 03 Aug 2012 06:49:12 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>

Hi,

On 3-8-2012 0:21, Fabien Udriot wrote:
>> The EM would gain the ability to view the raw ReST files in the TYPO3 BE,
>> in case people don't have an internet connection to view the manuals online.
>
> Couldn't be that the system grab the rendered HTML on-line and put it
> somewhere (e.g. typo3temp) for off-line reading. Reading regular web
> pages looks a bit more comfortable than Rest files (even though the
> format is human readable).

 From what Fran?ois wrote in here and in the core list the ReST files 
will not be displayed as is, but rendered (as HTML).
It is also important that a TYPO3 installation can work as a whole, 
including documentation, if it's installed on a machine which has no 
internet connection at all (isolated intranet servers) or limited access 
(firewalls which only allow a TER connection). It may seem strange to 
have such a situation, but I've encountered it quite often.

Alle core manuals are already rendered as HTML and/or PDF or another 
widely available format. It is indeed a good idea IMO to include those 
in the core. This is far easier to build.

Why not have the following in the core:
- PDF; local; single file with images
- HTML; online; possibly with comments when they become available

Rendering ReST format manuals is far easier than .sxw formats, so it 
might even be an option to include the PDF and/or HTML formats in the 
.t3x/.zip files in TER. People are used to a delay between uploading an 
extension and the availability in TER. That delay can also be used to 
render the manual.

-- 
Jigal van Hemert
TYPO3 Core Team member

TYPO3 .... inspiring people to share!
Get involved: typo3.org

From robert at typo3.org  Fri Aug  3 08:53:35 2012
From: robert at typo3.org (Robert Lemke)
Date: Fri, 3 Aug 2012 08:53:35 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.1.1343937723.17613.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343937723.17613.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1366.1343976821.626.typo3-project-documentation@lists.typo3.org>

Hi Fran?ois,

On 02.08.2012, at 22:02, Fran?ois Suter <fsu-lists at cobweb.ch> wrote:

>> I pushed a new version of the domain model to
>> https://github.com/typo3/TYPO3.Docs
> 
> Just added a "uri" property to the Document domain model, meant to describe at which URI the document is available.


just one idea:

why don't you use the TYPO3\FLOW3\Http\Uri (in FLOW3 1.1) for the uri property and TYPO3\FLOW3\I18n\Locale for the locale? Then you get the API and validation for free ;-)

Cheers,
Robert

-- 
Robert Lemke
Lead Developer TYPO3 Phoenix and FLOW3
Co-Founder TYPO3 Association

Blog: robertlemke.de/blog
Get involved: typo3.org ? flow3.org




From robert at typo3.org  Fri Aug  3 09:17:44 2012
From: robert at typo3.org (Robert Lemke)
Date: Fri, 3 Aug 2012 09:17:44 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.1366.1343976821.626.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343937723.17613.typo3-project-documentation@lists.typo3.org>
	<mailman.1366.1343976821.626.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1367.1343978268.626.typo3-project-documentation@lists.typo3.org>

> just one idea:
> 
> why don't you use the TYPO3\FLOW3\Http\Uri (in FLOW3 1.1) for the uri property and TYPO3\FLOW3\I18n\Locale for the locale? Then you get the API and validation for free ;-)


I created a little addendum to the HTTP chapter just for you ;-)

https://review.typo3.org/#/c/13434/

robert

-- 
Robert Lemke
Lead Developer TYPO3 Phoenix and FLOW3
Co-Founder TYPO3 Association

Blog: robertlemke.de/blog
Get involved: typo3.org ? flow3.org




From steffen.gebert at typo3.org  Fri Aug  3 09:43:48 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Fri, 03 Aug 2012 09:43:48 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343979828.5808.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

PDF rendering isn't so far, yet. I'm right now trying to get it
working again with Xavier.

The HTML output of the Rest docs is pretty.. why use a PDF.. we're in
a browser, so I think having it as HTML (single file or multiple?)
would be fine for me.

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/3/12 6:49 AM, schrieb Jigal van Hemert:
> Hi,
> 
> On 3-8-2012 0:21, Fabien Udriot wrote:
>>> The EM would gain the ability to view the raw ReST files in the
>>> TYPO3 BE, in case people don't have an internet connection to
>>> view the manuals online.
>> 
>> Couldn't be that the system grab the rendered HTML on-line and
>> put it somewhere (e.g. typo3temp) for off-line reading. Reading
>> regular web pages looks a bit more comfortable than Rest files
>> (even though the format is human readable).
> 
> From what Fran?ois wrote in here and in the core list the ReST
> files will not be displayed as is, but rendered (as HTML). It is
> also important that a TYPO3 installation can work as a whole, 
> including documentation, if it's installed on a machine which has
> no internet connection at all (isolated intranet servers) or
> limited access (firewalls which only allow a TER connection). It
> may seem strange to have such a situation, but I've encountered it
> quite often.
> 
> Alle core manuals are already rendered as HTML and/or PDF or
> another widely available format. It is indeed a good idea IMO to
> include those in the core. This is far easier to build.
> 
> Why not have the following in the core: - PDF; local; single file
> with images - HTML; online; possibly with comments when they become
> available
> 
> Rendering ReST format manuals is far easier than .sxw formats, so
> it might even be an option to include the PDF and/or HTML formats
> in the .t3x/.zip files in TER. People are used to a delay between
> uploading an extension and the availability in TER. That delay can
> also be used to render the manual.
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJQG4E0AAoJEIskG/rSlyw4YQsH/2kjUee9jopRyLQEy0EZI2tm
Ck4bEL4Yew8srecnFUdzewRBeYxPWE8FvVjSjkV/lt6rpEupQl2WlrdaRxNSWDds
t1txWLDyeESl0zyuDpJ41z0ZPs99AIc8l5OeA3E4X9Dh98h2Fm3AxzGu27UCiYuE
0I/AIH4RAdMGOwt3kihwh12kKi66+EbZSFY9qiE/qUtu9+oLCayNFKjvAbXgFQmf
PT2wCQqcLiM0HShDSQfr0nuWaluK6mu7CXB0LEg0sDrmuZME2A3XLFo7BiI72z59
KwWDIdG2TR3una70RGlrr5BgAMMQ5SCtLsDGC0cY+FPNxkhtYnHGsjC/gxuwYv0=
=yB5F
-----END PGP SIGNATURE-----

From m.bless at gmx.de  Fri Aug  3 09:44:51 2012
From: m.bless at gmx.de (Martin Bless)
Date: Fri, 03 Aug 2012 09:44:51 +0200
Subject: [TYPO3-doc] Organization for the next steps
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343979896.6739.typo3-project-documentation@lists.typo3.org>

Jigal,

>Why not have the following in the core:
>- PDF; local; single file with images
>- HTML; online; possibly with comments when they become available

I have not followed the details here but I just want to give a
reminder that we can have a single html file rendering as well.

Personnally I like that very much. The 'singlehtml' versions are
generally available already. For example try:

[1] http://preview.docs.typo3.org/TYPO3/CoreApiReference/singlehtml/
instead of
[2] http://preview.docs.typo3.org/TYPO3/CoreApiReference/

The current Layout/CSS isn't optimal at all for [1] but that should
change soon. But it shows what's possible and where the journey goes.

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From philipp.gampe at typo3.org  Fri Aug  3 10:17:46 2012
From: philipp.gampe at typo3.org (Philipp Gampe)
Date: Fri, 03 Aug 2012 10:17:46 +0200
Subject: [TYPO3-doc] Organization for the next steps
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343981866.11409.typo3-project-documentation@lists.typo3.org>

Hi Jigal van Hemert,

Jigal van Hemert wrote:

>  From what Fran?ois wrote in here and in the core list the ReST files
> will not be displayed as is, but rendered (as HTML).

Only if there is an online connection. Otherwise the EM will need to fall 
back to either PDF, local HTML or the plain reST version (in that order).
It is not possible to render the reST files without the toolchain being 
available on the server.

> Alle core manuals are already rendered as HTML and/or PDF or another
> widely available format. It is indeed a good idea IMO to include those
> in the core. This is far easier to build.
> 
> Why not have the following in the core:
> - PDF; local; single file with images
> - HTML; online; possibly with comments when they become available

The HTML version should be there almost immediately after triggering the 
rendering. The rendering is pretty fast and we do not have that many 
documentation changes.

> Rendering ReST format manuals is far easier than .sxw formats, so it
> might even be an option to include the PDF and/or HTML formats in the
> .t3x/.zip files in TER. People are used to a delay between uploading an
> extension and the availability in TER. That delay can also be used to
> render the manual.

If the extensions are repacked on the server already, this should be no 
problem once the rendering is fully automated.

Cheers
-- 
Philipp Gampe ? PGP-Key 0AD96065 ? TYPO3 UG Bonn/K?ln
Documentation ? linkvalidator
TYPO3 .... inspiring people to share!


From fsu-lists at cobweb.ch  Fri Aug  3 14:39:47 2012
From: fsu-lists at cobweb.ch (=?windows-1252?Q?Fran=E7ois_Suter?=)
Date: Fri, 03 Aug 2012 14:39:47 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.1366.1343976821.626.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343937723.17613.typo3-project-documentation@lists.typo3.org>
	<mailman.1366.1343976821.626.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343997588.21134.typo3-project-documentation@lists.typo3.org>

Hi Robert,

> why don't you use the TYPO3\FLOW3\Http\Uri (in FLOW3 1.1) for the uri
> property and TYPO3\FLOW3\I18n\Locale for the locale? Then you get the
> API and validation for free ;-)

Because I don't know FLOW3 well enough yet? ;-)

It's a good suggestion. I won't have time to take care of this now, but 
hopefully Fabien can pick it up later.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Fri Aug  3 14:44:28 2012
From: fsu-lists at cobweb.ch (=?UTF-8?B?RnJhbsOnb2lzIFN1dGVy?=)
Date: Fri, 03 Aug 2012 14:44:28 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343981866.11409.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343981866.11409.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343997870.22343.typo3-project-documentation@lists.typo3.org>

Hi,

> Only if there is an online connection. Otherwise the EM will need to fall
> back to either PDF, local HTML or the plain reST version (in that order).
> It is not possible to render the reST files without the toolchain being
> available on the server.

Yes, exactly, displaying raw ReST files is a kind of last possible 
fallback. Of course I support the idea of packaging rendered formats 
with the source (for example, PDF or single-page HTML), but my worry is 
one of timing. Can we really manage to get up to date and rendered 
manuals upon a given release? Of course, this could be part of the 
release script, but maybe it's too complicated and the question of 
timing remains. This is why I could imagine the Doc Team providing an 
extension to download one or more formats, which would then be linked to 
from the EM. This way the changes to the Core are minimal, we need just 
plan some hooks at the right places. The extension could even provide a 
Scheduler task to sync the manuals.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Fri Aug  3 14:50:34 2012
From: fsu-lists at cobweb.ch (=?windows-1252?Q?Fran=E7ois_Suter?=)
Date: Fri, 03 Aug 2012 14:50:34 +0200
Subject: [TYPO3-doc] Domain model for documentation
In-Reply-To: <mailman.1.1343997588.21134.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343398337.31484.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343818793.23936.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343937723.17613.typo3-project-documentation@lists.typo3.org>
	<mailman.1366.1343976821.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343997588.21134.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1343998236.23330.typo3-project-documentation@lists.typo3.org>

> It's a good suggestion. I won't have time to take care of this now, but
> hopefully Fabien can pick it up later.

Opened an issue in the github project in order not to forget: 
https://github.com/typo3/TYPO3.Docs/issues/1

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From jigal.van.hemert at typo3.org  Fri Aug  3 20:27:24 2012
From: jigal.van.hemert at typo3.org (Jigal van Hemert)
Date: Fri, 03 Aug 2012 20:27:24 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1343997870.22343.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343981866.11409.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343997870.22343.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1344018445.9913.typo3-project-documentation@lists.typo3.org>

Hi,

On 3-8-2012 14:44, Fran?ois Suter wrote:
> Hi,
>
>> Only if there is an online connection. Otherwise the EM will need to fall
>> back to either PDF, local HTML or the plain reST version (in that order).
>> It is not possible to render the reST files without the toolchain being
>> available on the server.
>
> Yes, exactly, displaying raw ReST files is a kind of last possible
> fallback. Of course I support the idea of packaging rendered formats
> with the source (for example, PDF or single-page HTML), but my worry is
> one of timing.

Sorry, I understood that the functional feature would be rendering ReST 
file in the core. If it's just the logic of which links to provide, that 
is indeed so marginal that it can be added as a last minute feature.

OTOH it would be fairly easy to implement the logic now with checks to 
see if the resource is available plus a hook to provide optional extra 
resources in extensions.
If the default locations of the resources / names / ... change these can 
of course be modified just before the release.

-- 
Jigal van Hemert
TYPO3 Core Team member

TYPO3 .... inspiring people to share!
Get involved: typo3.org

From fsu-lists at cobweb.ch  Fri Aug  3 20:53:37 2012
From: fsu-lists at cobweb.ch (=?UTF-8?B?RnJhbsOnb2lzIFN1dGVy?=)
Date: Fri, 03 Aug 2012 20:53:37 +0200
Subject: [TYPO3-doc] Organization for the next steps
In-Reply-To: <mailman.1.1344018445.9913.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343925298.19738.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343946074.5739.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343969363.28536.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343981866.11409.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1343997870.22343.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1344018445.9913.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1344020020.11884.typo3-project-documentation@lists.typo3.org>

Hi Jigal,

> Sorry, I understood that the functional feature would be rendering ReST
> file in the core. If it's just the logic of which links to provide, that
> is indeed so marginal that it can be added as a last minute feature.

Rendering ReST is not so trivial in that it requires tools like Sphinx, 
which runs on Python. Fabien has designed a service to render ReST 
manuals online, but all of this is not standard and can't really be 
packaged with the Core.

> OTOH it would be fairly easy to implement the logic now with checks to
> see if the resource is available plus a hook to provide optional extra
> resources in extensions.
> If the default locations of the resources / names / ... change these can
> of course be modified just before the release.

The base logic can certainly be implemented pretty quickly. Philipp 
Gampe has agreed to take care of that, but the deadline is still awfully 
short as feature freeze is in just 10 days. But yes, the logic can 
probably be already planned in the new EM.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From typo3 at t3node.com  Fri Aug 10 19:51:13 2012
From: typo3 at t3node.com (=?UTF-8?B?U3RlZmZlbiBNw7xsbGVy?=)
Date: Fri, 10 Aug 2012 19:51:13 +0200
Subject: [TYPO3-doc]  ReST Editor for Linux
Message-ID: <mailman.1.1344621073.21072.typo3-project-documentation@lists.typo3.org>

Hi.

Do you have a suggestion for a good ReST editor for Linux?


-- 
cheers,
Steffen

TYPO3 Blog: http://www.t3node.com/
Twitter: @t3node - http://twitter.com/t3node

From philipp.gampe at typo3.org  Fri Aug 10 22:25:51 2012
From: philipp.gampe at typo3.org (Philipp Gampe)
Date: Fri, 10 Aug 2012 22:25:51 +0200
Subject: [TYPO3-doc] ReST Editor for Linux
References: <mailman.1.1344621073.21072.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1344630351.10923.typo3-project-documentation@lists.typo3.org>

Hi Steffen M?ller,

Steffen M?ller wrote:

> Do you have a suggestion for a good ReST editor for Linux?

Have a look at that list:
http://stackoverflow.com/questions/2746692/restructuredtext-tool-support

I think PhpStorm has now a plugin for it.
Otherwise choose your favorit editor and look for rest support and maybe set 
up a save hook or a shortcut to trigger the rendering.
 
Cheers
-- 
Philipp Gampe ? PGP-Key 0AD96065 ? TYPO3 UG Bonn/K?ln
Documentation ? linkvalidator
TYPO3 .... inspiring people to share!


From m.bless at gmx.de  Wed Aug 15 09:56:02 2012
From: m.bless at gmx.de (Martin Bless)
Date: Wed, 15 Aug 2012 09:56:02 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for configuration
	in your ReST documentation
Message-ID: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>

New feature
===========

I've implemented a new feature yesterday that enhances the
capabilities of Sphinx for our TYPO3 ReST documentation projects.

Sphinx is the tool that takes our ReST files as input and builds HTML
or PDF or whatever on output. A standard Sphinx project uses a
'conf.py' file for configuration of the build process. Unfortunately
this ((ansatz)) has some drawbacks. One is that it's potentially
dangerous executable code. And another on is that it may contain
machine specific technical settings that a normal editor shouldn't be
bothered with. So we were looking for a better solution. It is now
available. And here is how it works:

We have agreed on that your documentation starts somewhere in a folder
"Documentation" with the master document "Index.rst". You may now add
a project specific 'Settings.yml' file that is versioned all along
with the project. It goes to the folder where your master document
resides. This is step 1: Add a Settings.yml file:

Step 1
------

  SomePackage.git/
  |- Documentation/
     |- Index.rst
     |- Settings.yml


Step 2 (optional)
-----------------

You only need to do step 2 if you're rendering ReST projects locally
for yourself. Then please add a TYPO3 specific codeblock manually to
the end of your 'conf.py'. You can grab the codeblock from [1]


Step 3 (optional)
-----------------

You only need to do step 3 if you're rendering ReST projects locally
for yourself. This means that you have Python, Docutils, Sphinx and so
on installed on your machine as described in [2]. I would encourage
you to do so.

  1. Get a snapshot of [3]
  2. Go to folder 'ExtendingSphinxForTYPO3' on the command line
  3. Run ``python setup.py install`` or 
     ``sudo python setup.py install``. This will add a package
     't3sphinx' to your Python interpreter.

Verify that the package is properly installed and find out where your
files reside:

  Microsoft Windows [Version 6.1.7601]
  Copyright (c) 2009 Microsoft Corporation. Alle Rechte vorbehalten.

  C:\Users\marble>python
  Python 2.7.3 (default, Apr 10 2012, 23:31:26) [MSC v.1500 ...] 
  Type "help", "copyright", "credits" or "license" for ... information
  >>> import t3sphinx
  >>> dir(t3sphinx)
  ['__builtins__', '__doc__', '__file__', '__name__', 
   '__package__',   '__path__', '__version__', 'os', 'package_dir',
   'pathToGlobalYamlSettings', typo3_codeblock_for_conf_py',
   'yamlsettings']
  >>> t3sphinx.pathToGlobalYamlSettings

'D:\\Python27\\lib\\site-packages\\t3sphinx\\settings\\GlobalSettings.yml'
  >>> t3sphinx.typo3_codeblock_for_conf_py

'D:\\Python27\\lib\\site-packages\\t3sphinx\\resources\\typo3_codeblock_for_conf.py'
  >>> exit()
  
  C:\Users\marble>



How it works
============

During the Sphinx build process the Python configuration file
'conf.py' is executed. Variables defined there are 'conf.py' module
variables and influence the build process. With the above
modifications we will also create several Yaml files for instructional
and diagnostic purposes. This is what happens:

  1. Sphinx proceeds normally and prepares the variables in 'conf.py'.

  2. We take those current settings of 'conf.py' and dump them as file
     '10_conf_py.yml' in the directory that we have chosen for
     logging. See [4] for such a folder on the server or
     ``Documentation/_make/_not_versioned/`` in your local project.

  3. Following ``t3sphinx.pathToGlobalYamlSettings`` we try to find a
     global Yaml file 'GlobalSettings.yml'. This is meant to exist
     only once on a machine and should be maintained by the 
     TYPO3 Docteam.

  4. We read the 'GlobalSettings.yml' file and dump what we have
     parsed from Yaml to '20_GlobalSettings.yml' in our logging
     directory.

  5. We override values in 'conf.py' with those found in our global
     settings file. If values existed they are replaced completely.
     This means: there is *no* deep replacement. Instead variables
     are replaced completely at the top level.

  7. We dump the now current 'conf.py' to ``10_20_conf_py.yml``
     in our logging directory.

  8. We try to find and read the project specific
     ``Documentation/Settings.yml`` file.

  9. We dump what we have parsed from Yaml to '30_Settings.yml'
     in our logging directory.

  10. We override values in 'conf.py' with those now found in our
      global prject specific settings file 'Settings.yml'. 

      If values existed they are replaced completely.
      This means: there is *no* deep replacement. Instead variables
      are replaced or created completely at the top level.

  11. We dump the now current 'conf.py' to ``10_20_30_conf_py.yml``
      in our logging directory.

      ``10_20_30_conf_py.yml`` shows the **final settings** that
      are actually being used in the Sphinx build process.


In short this means:
====================

- You now may use a ``Documentation/Settings.yml`` file to
  selectively define values you otherwise would have written
  directly in ``conf.py`` file.

- You only need to specify values you want to be different.

- Watch the logging directory [4] or [6] for instructional and 
  "diagnostic" Yaml files that tell you what has happened and what can
  be done how.

Finally
=======

For question please ask here or in [5].
For feature requests or bug reports create an issure on [5].

Thanks for your attention - and keep the flow!

Martin

[1]
http://git.typo3.org/Documentation/RestTools.git?a=blob;f=ExtendingSphinxForTYPO3/src/t3sphinx/resources/typo3_codeblock_for_conf.py;hb=master
[2] http://wiki.typo3.org/Rest (-> Installation)
[3] http://git.typo3.org/Documentation/RestTools.git
[4] as existing example:
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git.make/
[5] https://forge.typo3.org/projects/tools-rest
[6] local logging directory: Documentation/_make/_not_versioned/

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From steffen.gebert at typo3.org  Wed Aug 15 12:45:25 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Wed, 15 Aug 2012 12:45:25 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
 configuration in your ReST documentation
In-Reply-To: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345027525.31325.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Awesome!


Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/15/12 9:56 AM, schrieb Martin Bless:
> New feature ===========
> 
> I've implemented a new feature yesterday that enhances the 
> capabilities of Sphinx for our TYPO3 ReST documentation projects.
> 
> Sphinx is the tool that takes our ReST files as input and builds
> HTML or PDF or whatever on output. A standard Sphinx project uses
> a 'conf.py' file for configuration of the build process.
> Unfortunately this ((ansatz)) has some drawbacks. One is that it's
> potentially dangerous executable code. And another on is that it
> may contain machine specific technical settings that a normal
> editor shouldn't be bothered with. So we were looking for a better
> solution. It is now available. And here is how it works:
> 
> We have agreed on that your documentation starts somewhere in a
> folder "Documentation" with the master document "Index.rst". You
> may now add a project specific 'Settings.yml' file that is
> versioned all along with the project. It goes to the folder where
> your master document resides. This is step 1: Add a Settings.yml
> file:
> 
> Step 1 ------
> 
> SomePackage.git/ |- Documentation/ |- Index.rst |- Settings.yml
> 
> 
> Step 2 (optional) -----------------
> 
> You only need to do step 2 if you're rendering ReST projects
> locally for yourself. Then please add a TYPO3 specific codeblock
> manually to the end of your 'conf.py'. You can grab the codeblock
> from [1]
> 
> 
> Step 3 (optional) -----------------
> 
> You only need to do step 3 if you're rendering ReST projects
> locally for yourself. This means that you have Python, Docutils,
> Sphinx and so on installed on your machine as described in [2]. I
> would encourage you to do so.
> 
> 1. Get a snapshot of [3] 2. Go to folder 'ExtendingSphinxForTYPO3'
> on the command line 3. Run ``python setup.py install`` or ``sudo
> python setup.py install``. This will add a package 't3sphinx' to
> your Python interpreter.
> 
> Verify that the package is properly installed and find out where
> your files reside:
> 
> Microsoft Windows [Version 6.1.7601] Copyright (c) 2009 Microsoft
> Corporation. Alle Rechte vorbehalten.
> 
> C:\Users\marble>python Python 2.7.3 (default, Apr 10 2012,
> 23:31:26) [MSC v.1500 ...] Type "help", "copyright", "credits" or
> "license" for ... information
>>>> import t3sphinx dir(t3sphinx)
> ['__builtins__', '__doc__', '__file__', '__name__', '__package__',
> '__path__', '__version__', 'os', 'package_dir', 
> 'pathToGlobalYamlSettings', typo3_codeblock_for_conf_py', 
> 'yamlsettings']
>>>> t3sphinx.pathToGlobalYamlSettings
> 
> 'D:\\Python27\\lib\\site-packages\\t3sphinx\\settings\\GlobalSettings.yml'
>
> 
>>> t3sphinx.typo3_codeblock_for_conf_py
> 
> 'D:\\Python27\\lib\\site-packages\\t3sphinx\\resources\\typo3_codeblock_for_conf.py'
>
> 
>>> exit()
> 
> C:\Users\marble>
> 
> 
> 
> How it works ============
> 
> During the Sphinx build process the Python configuration file 
> 'conf.py' is executed. Variables defined there are 'conf.py'
> module variables and influence the build process. With the above 
> modifications we will also create several Yaml files for
> instructional and diagnostic purposes. This is what happens:
> 
> 1. Sphinx proceeds normally and prepares the variables in
> 'conf.py'.
> 
> 2. We take those current settings of 'conf.py' and dump them as
> file '10_conf_py.yml' in the directory that we have chosen for 
> logging. See [4] for such a folder on the server or 
> ``Documentation/_make/_not_versioned/`` in your local project.
> 
> 3. Following ``t3sphinx.pathToGlobalYamlSettings`` we try to find
> a global Yaml file 'GlobalSettings.yml'. This is meant to exist 
> only once on a machine and should be maintained by the TYPO3
> Docteam.
> 
> 4. We read the 'GlobalSettings.yml' file and dump what we have 
> parsed from Yaml to '20_GlobalSettings.yml' in our logging 
> directory.
> 
> 5. We override values in 'conf.py' with those found in our global 
> settings file. If values existed they are replaced completely. This
> means: there is *no* deep replacement. Instead variables are
> replaced completely at the top level.
> 
> 7. We dump the now current 'conf.py' to ``10_20_conf_py.yml`` in
> our logging directory.
> 
> 8. We try to find and read the project specific 
> ``Documentation/Settings.yml`` file.
> 
> 9. We dump what we have parsed from Yaml to '30_Settings.yml' in
> our logging directory.
> 
> 10. We override values in 'conf.py' with those now found in our 
> global prject specific settings file 'Settings.yml'.
> 
> If values existed they are replaced completely. This means: there
> is *no* deep replacement. Instead variables are replaced or created
> completely at the top level.
> 
> 11. We dump the now current 'conf.py' to ``10_20_30_conf_py.yml`` 
> in our logging directory.
> 
> ``10_20_30_conf_py.yml`` shows the **final settings** that are
> actually being used in the Sphinx build process.
> 
> 
> In short this means: ====================
> 
> - You now may use a ``Documentation/Settings.yml`` file to 
> selectively define values you otherwise would have written directly
> in ``conf.py`` file.
> 
> - You only need to specify values you want to be different.
> 
> - Watch the logging directory [4] or [6] for instructional and 
> "diagnostic" Yaml files that tell you what has happened and what
> can be done how.
> 
> Finally =======
> 
> For question please ask here or in [5]. For feature requests or bug
> reports create an issure on [5].
> 
> Thanks for your attention - and keep the flow!
> 
> Martin
> 
> [1] 
> http://git.typo3.org/Documentation/RestTools.git?a=blob;f=ExtendingSphinxForTYPO3/src/t3sphinx/resources/typo3_codeblock_for_conf.py;hb=master
>
> 
[2] http://wiki.typo3.org/Rest (-> Installation)
> [3] http://git.typo3.org/Documentation/RestTools.git [4] as
> existing example: 
> http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git.make/
>
> 
[5] https://forge.typo3.org/projects/tools-rest
> [6] local logging directory: Documentation/_make/_not_versioned/
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJQK33FAAoJEIskG/rSlyw4rfEH/i5licqot+mEydC2U3AckTzy
C4lNLLew89Vh2nTQSXMRIlRzqpMJxBmAUGEa8eyl9beoltcI7/Xvp9yVmPQ0L8Cg
2gxRWamtXUFsJiZMU1GzVpVEVtPVK0As/lcCPZsmEEslyyPB1ScuNExb19Qnddfk
ZzX8vIwf+hYgzkjPDQcQCOwzqvoxkkx4pl/U1e1xf5hqAsfBTwLYEWOHMquyRNMc
7k0ABZlVK58KPt+/C7hXx2z+M9kY994OUwU30E3+IIJYBUTa18WH3MMrUKrE19yL
rAvp0ccSMV7cFwdZvYDgF9B8nlgpWCvmYTHRY7t255olxSyyeKkNtEVcJjrkqUQ=
=I8pO
-----END PGP SIGNATURE-----

From cognifloyd at gmail.com  Fri Aug 17 06:18:42 2012
From: cognifloyd at gmail.com (Jacob Floyd)
Date: Thu, 16 Aug 2012 21:18:42 -0700 (PDT)
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
 configuration in your ReST documentation
In-Reply-To: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>

So, apparently t3sphinx depends on Python 2.*, as it didn't import 
successfully on Python 3.2. Would you include a note about that in the 
readme?

Cheers,
Jacob Floyd

From m.bless at gmx.de  Fri Aug 17 08:34:14 2012
From: m.bless at gmx.de (Martin Bless)
Date: Fri, 17 Aug 2012 08:34:14 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
	configuration in your ReST documentation
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
	<mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>

Hi Jacob,

>So, apparently t3sphinx depends on Python 2.*, as it didn't import 
>successfully on Python 3.2.

thanks for the feedback. I created http://forge.typo3.org/issues/39875

> Would you include a note about that in the readme?

You're right.

BTW: I've checked http://forge.typo3.org/issues/39872 in yesterday.

After reinstalling 't3sphinx' in ReST you can then write:

  I've checked :forge:`39872` in yesterday.

We should still check with Fran?ois about that but I think everybody
will like it.

BTW, language: Do you run a program "on" Windows? Preposition examples
welcome!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From cognifloyd at gmail.com  Fri Aug 17 22:31:31 2012
From: cognifloyd at gmail.com (Jacob Floyd)
Date: Fri, 17 Aug 2012 13:31:31 -0700 (PDT)
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
 configuration in your ReST documentation
In-Reply-To: <mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
	<mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.4835.1345235494.626.typo3-project-documentation@lists.typo3.org>

Yah, when talking about running programs, we run them on the computer, on 
windows, on linux, on a mac or on the moon... (jk about the moon).

Also, you might want to change the title of that issue to say t3sphinx 
instead of tsphinx :D

Plus, we could probably use something very similar to link to the api docs. 
:api:'TYPO3\FLOW3\MagicClassJustForFun'

On Friday, August 17, 2012 12:34:14 AM UTC-6, Martin Bless wrote:
>
> Hi Jacob, 
>
> >So, apparently t3sphinx depends on Python 2.*, as it didn't import 
> >successfully on Python 3.2. 
>
> thanks for the feedback. I created http://forge.typo3.org/issues/39875 
>
> > Would you include a note about that in the readme? 
>
> You're right. 
>
> BTW: I've checked http://forge.typo3.org/issues/39872 in yesterday. 
>
> After reinstalling 't3sphinx' in ReST you can then write: 
>
>   I've checked :forge:`39872` in yesterday. 
>
> We should still check with Fran?ois about that but I think everybody 
> will like it. 
>
> BTW, language: Do you run a program "on" Windows? Preposition examples 
> welcome! 
>
> Martin 
>
> -- 
> Certified TYPO3 Integrator | TYPO3 Documentation Team Member 
>
> http://mbless.de 
> _______________________________________________ 
> TYPO3-project-documentation mailing list 
> TYPO3-project... at lists.typo3.org <javascript:> 
> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-project-documentation 
>

From m.bless at gmx.de  Sat Aug 18 11:37:23 2012
From: m.bless at gmx.de (Martin Bless)
Date: Sat, 18 Aug 2012 11:37:23 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
	configuration in your ReST documentation
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
	<mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
	<mailman.4835.1345235494.626.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345282651.12987.typo3-project-documentation@lists.typo3.org>

Jacob,

>Yah, when talking about running programs, we run them on the computer, on 
>windows, on linux, on a mac or on the moon... (jk about the moon).

Isn't it Mars these days? Just for curiosity ...


>Also, you might want to change the title of that issue to say t3sphinx 
>instead of tsphinx :D

Yes, thanks. Did that. My eyes had adapted already and would probably
never ever had discovered that typo.

>Plus, we could probably use something very similar to link to the api docs. 
>:api:'TYPO3\FLOW3\MagicClassJustForFun'

Would you like to give that a try in one of your documentation
projects? Then please add this to your Settings.yml file. That's all
you have to do:


conf.py:

  extlinks:
    forge:
    - http://forge.typo3.org/issues/%s
    - 'forge: '
    api:
    - http://typo3.org/api/%s
    - 'API: '


With the above you could write

  :api:`typo3/class_ajax_login.html`

and you would get:

  <a href="http://typo3.org/api/typo3/class_ajax_login.html">\
    API: typo3/class_ajax_login.html</a>

It it's the nice solution you're looking for we could add that to the
GlobalSettings.yml. OTH I'm afraid we still have a large variety in
how api links are constructed. Some pages are even framed.

But it looks like a good way to go!

Martin, always enjoing your posts ...

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From fsu-lists at cobweb.ch  Sun Aug 19 13:04:49 2012
From: fsu-lists at cobweb.ch (=?UTF-8?B?RnJhbsOnb2lzIFN1dGVy?=)
Date: Sun, 19 Aug 2012 13:04:49 +0200
Subject: [TYPO3-doc] URL scheme for documentation
In-Reply-To: <mailman.1.1343945950.5446.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1343945950.5446.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345374290.16271.typo3-project-documentation@lists.typo3.org>

Hi,

> The topic was already discussed but I am confused with the conclusion. Have we already agreed with
> the URL scheme regarding how documentation will be structured. I remember Martin has some note at
> least about that. At the moment, I have in sight this link:
>
> http://preview.docs.typo3.org/TYPO3/
>
> ... where extensions are into
>
> http://preview.docs.typo3.org/TYPO3/Extensions/

I don't remember what we decided, maybe we didn't decided on anything. 
We have a team meeting this coming Thursday. I propose that we discuss 
this again at that point and present a proposal in this ML afterwards. I 
will also present what I have been thinking about with regards to 
versions and languages.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Mon Aug 20 20:18:33 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Mon, 20 Aug 2012 20:18:33 +0200
Subject: [TYPO3-doc]  Next team meeting: Thursday, August 23, 21:00 CET
Message-ID: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>

Hi all,

Our next team meeting will take place this coming Thursday (August 23) 
at 21:00 CET.

We will give Big Blue Button one more try 
(http://bigbluebutton.typo3.org/), but if anyone has trouble connecting 
we will promptly switch to Skype. So if you aren't yet in contact with 
me via Skype, please prompt me. My account is "fsuter".

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Mon Aug 20 20:21:02 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Mon, 20 Aug 2012 20:21:02 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
 configuration in your ReST documentation
In-Reply-To: <mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
	<mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345486863.14160.typo3-project-documentation@lists.typo3.org>

Hi Martin,

> After reinstalling 't3sphinx' in ReST you can then write:
>
>    I've checked :forge:`39872` inyesterday.
>
> We should still check with Fran?ois about that but I think everybody
> will like it.

It's definitely not something I would have put as a top priority, but 
since it seems like it was very easy to do, yes, it's absolutely fine. 
The general mechanism is very useful and opens up a lot of uses.

PS: now I'll read the start of the thread, I needed a bit of time to 
digest ;-)

Thanks

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Mon Aug 20 20:24:19 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Mon, 20 Aug 2012 20:24:19 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
 configuration in your ReST documentation
In-Reply-To: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345487060.14160.typo3-project-documentation@lists.typo3.org>

Hi Martin,

> Finally
> =======
>
> For question please ask here or in [5].
> For feature requests or bug reports create an issure on [5].
>
> Thanks for your attention - and keep the flow!

All clear and very nice. Thanks for this work!

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From steffen.gebert at typo3.org  Mon Aug 20 20:31:38 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Mon, 20 Aug 2012 20:31:38 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345487499.16089.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

nice that you give it another try. I can just advice everybody to just
create an own meeting and execute the mike check before joining the
real meeting!

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/20/12 8:18 PM, schrieb Fran?ois Suter:
> Hi all,
> 
> Our next team meeting will take place this coming Thursday (August
> 23) at 21:00 CET.
> 
> We will give Big Blue Button one more try 
> (http://bigbluebutton.typo3.org/), but if anyone has trouble
> connecting we will promptly switch to Skype. So if you aren't yet
> in contact with me via Skype, please prompt me. My account is
> "fsuter".
> 
> Cheers
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJQMoKKAAoJEIskG/rSlyw4TyUIAIhMG10jx7auz4IBYCxkK1uc
HVQvlsj1C355AadDZM9ds2QRNq901d6ubTZHiFWFRT2GzkX8J6g4CyI4clwc1pXO
G2A/A7OUuNnrUwXkY5kWxscn1pc+3zRpBX00brwb1ba1N1oNdcjkHoHqgJMLMtUq
DRy2WIFvuZ7ALNEL8EzgE90jE63RAyUINJJsDiWUtn9fwC3Dl+hkflqW6fLqKyEE
iWdbIoGKnFeXtD3Rb7wfSaJ/7SVpfR3AVUMtmQDRr4FmuEYOAtVIZbYnrqljHpoB
CT1tkdXJmFZxbPRb8iRAJkWpFSngjNAqvbT6xQ6YGavkDxdstyXZKi8r7o1MRsY=
=M20q
-----END PGP SIGNATURE-----

From fsu-lists at cobweb.ch  Mon Aug 20 20:42:54 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Mon, 20 Aug 2012 20:42:54 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345487499.16089.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345487499.16089.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345488175.17546.typo3-project-documentation@lists.typo3.org>

Hi Steffen,

> I can just advice everybody to just
> create an own meeting and execute the mike check before joining the
> real meeting!

Good advice. Please run this test, all those who plan to attend (and had 
problems in the past or never attended before). Thanks in advance.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From m.bless at gmx.de  Tue Aug 21 10:00:10 2012
From: m.bless at gmx.de (Martin Bless)
Date: Tue, 21 Aug 2012 10:00:10 +0200
Subject: [TYPO3-doc] New: "t3-field-list-table" directive now availble for
	ReST markup in our Sphinx documentation projects
Message-ID: <mailman.1.1345536013.16073.typo3-project-documentation@lists.typo3.org>

Hello friends,

I'm happy to announce the the "t3-field-list-table" directive is now available for us in
the Sphinx documentation projects.

Short history
=============

Creating tables is sort of a problem in any editor. But it's important to as as there are
often very long tables in the existing documentation. That's why I spent some effort last
year to offer a better solution. And that was implementing a "field-list-table" directive
for the Docutils (= basic ReST toolset). It goes back to ideas of 2005 in the Docutils
community and was presented in [1]. To see some examples of how it is used see [2].

Unfortuneately in the meantime there was no manpower to get that into the Docutils core.
That simply meant that we could not use it because it was not commonly available without
"hacking".

In the meantime the "t3sphinx" Python package has been created and provides a way to
easily spread all TYPO3 specific amendmends and extensions to everybody. Yesterday I spent
a whole day to find - in the end - the three lines of code that give us the - new name! -
"t3-field-list-table" directive back in our Sphinx projects.

This means: We can start using it!

Installation
============

Do this:

- Read [4] and 
- follow the "Installation" chapter.
- See [3] and
- add the TYPO3 specific codeblock manually to your "conf.py"

That's it.


How does it work?
=================

In ReST markup you write a doubly nested list. An unordered list is the outer one and
constructs table rows. It's a "bullet-list" [5] in Docutil's terms:

- row1
- row2
- row3
- ...

Each row is a "field-list" [6] which means that each item is a key-value pair and creates
a cell. The key is the column name. The value is the cell content. So a complete example
may look like this:

.. t3-field-list-table::
 :header-rows: 1

 - :Property,20:    Property
   :Data type,20:   Data type
   :Description,50: Description
   :Default,10:     Default

 - :Property:    allWrap
   :Data type:   wrap / stdWrap
   :Description: Wraps the whole item

 - :Property:    wrapItemAndSub

   :Data type:   wrap / stdWrap

   :Description:
         Wraps the whole item and
         any submenu concatenated to it.

The table has three rows. The first on is a header row. And there a four named columns
with desired widths 20%, 20%, 50%, 10%. The unnumbered list markup and the field-list
markup follows the normal standard ReST syntax rules. Without our directive you would have
to use the "grid table" markup of the Docutils to produce the same result:

+----------------+---------------+---------------------------------+-------------+
| Property       | Data type     | Description                     |  Default    |
+================+===============+=================================+=============+
| allWrap        | wrap /stdWrap | Wraps the whole item            |             |
+----------------+---------------+---------------------------------+-------------+
| wrapItemAndSub | wrap /stdWrap | Wraps the whole item and        |             |
|                |               | any submenu concatenated to it. |             |
+----------------+---------------+---------------------------------+-------------+


Implications ...
================

Just a few notes, mainly for the TYPO3 documentation team:

1. We had given up the idea of keeping tables because we couldn't handle then in markup.

2. Now we can handle them! (using "t3-field-list-table")

3. We had found a "definition list markup" as workaround to write existings tables in
OpenOffice documents in ReST markup. And that's how all our official documents are now in
the Git repositories.

4. It would be much nicer to have (2.) instead of (3.) for the existing tables!

5. If we want to have (4.) - yes, we do! - this means we either have to do it manually or
generate everything once again and push it once again to Git.

6. To achieve (5.) manually is not as much work as it sounds because the ReST markup is
very similar. So that's what I would propose.

7. IN GENERAL there was an agreement when we asked in the documentation list that we in
general should not use those big tables as there are, for example, in the
TyposcriptReferenceManual. Where appropriate stuff should be rewritten using other
"normal" text constructs. But this can only be done manually. That's another argument, I'd
say, to keep the current docs as they are (see 3.) and to improve manually as in (6.).

8. And, KEEP IN MIND, the kind of voting mentioned in (7.) should not mean at all that you
should avoid tables in general. Yes, please do use tables wherever you find them
appropriate. If you have table like data you should write that as table.

I'm hoping you can follow my numbers =:-) I feel a bit like a lawyer ... But don't worry,
I'm not at all.



[1] http://lists.typo3.org/pipermail/typo3-project-documentation/2011-November/003517.html

[2]
http://mbless.de/4us/typo3-oo2rest/06-The-%5Bfield-list-table%5D-directive/1-demo.rst.html

[3] http://lists.typo3.org/pipermail/typo3-project-documentation/2012-August/004048.html

[4]
http://git.typo3.org/Documentation/RestTools.git?a=blob_plain;f=ExtendingSphinxForTYPO3/README.txt;hb=HEAD

[5] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists

[6] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists

From karsten at typo3.org  Tue Aug 21 10:17:36 2012
From: karsten at typo3.org (Karsten Dambekalns)
Date: Tue, 21 Aug 2012 10:17:36 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
 configuration in your ReST documentation
In-Reply-To: <mailman.1.1345282651.12987.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
	<mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
	<mailman.4835.1345235494.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345282651.12987.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345537056.18306.typo3-project-documentation@lists.typo3.org>

Hi.

On 18.08.12 11:37, Martin Bless wrote:
> It it's the nice solution you're looking for we could add that to the
> GlobalSettings.yml. OTH I'm afraid we still have a large variety in
> how api links are constructed. Some pages are even framed.

Since there should be one machine to render API docs for all projects
using the same tool, that problem should cease to exist.


Regards,
Karsten
-- 
Karsten Dambekalns
TYPO3 Core Developer, FLOW3 / Phoenix Team

TYPO3 .... inspiring people to share!
Get involved: typo3.org

From m.bless at gmx.de  Tue Aug 21 11:06:48 2012
From: m.bless at gmx.de (Martin Bless)
Date: Tue, 21 Aug 2012 11:06:48 +0200
Subject: [TYPO3-doc] New: Use a YAML file "Settings.yml" for
	configuration in your ReST documentation
References: <mailman.1.1345017365.5055.typo3-project-documentation@lists.typo3.org>
	<mailman.4595.1345177125.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345185260.14662.typo3-project-documentation@lists.typo3.org>
	<mailman.4835.1345235494.626.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345282651.12987.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345537056.18306.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345540011.26446.typo3-project-documentation@lists.typo3.org>

[Karsten Dambekalns] wrote & schrieb:

>Hi.
>
>On 18.08.12 11:37, Martin Bless wrote:
>> It it's the nice solution you're looking for we could add that to the
>> GlobalSettings.yml. OTH I'm afraid we still have a large variety in
>> how api links are constructed. Some pages are even framed.
>
>Since there should be one machine to render API docs for all projects
>using the same tool, that problem should cease to exist.

Yes, that's very good. In the meantime I found out that it is not difficult at all (for me
;-) to create a Sphinx extension that does some specialized processing for a TYPO3
specific textrole 'api'. It could recognize the relpaths of the API links and react on
that. So it could produce different URLs. Examples::

  :api:`` -> http://api.typo3.org/  
        as http://typo3.org/api/ gives a 404 error

  :api:`typo3v4/46/html/annotated.html` ->
        http://api.typo3.org/typo3v4/46/html/annotated.html

  :api:`typo3/_about_controller_8php.html` ->
        http://typo3.org/api/typo3/_about_controller_8php.html

The logic we would need can probably be derived from page http://api.typo3.org/.


**Is that the complete logic we have?:**

  Rule 1:
     direct everything that's not empty and starts with /typo3/ to
     http://typo3.org/api/typo3/...

  Rule 2:
     direct everything else to http://api.typo3.org/...



To really be able to create a solution we need a list of all of the different use cases:

  1. ReST markup
  2. destination URL
  3. caption (= linktext, =what text in HTML should carry the link?)


Invented example A:

  1: :api:`typo3/_about_controller_8php.html`
  2: http://typo3.org/api/typo3/_about_controller_8php.html
  3: typo3/3/_about_controller_8php


Over!

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From fabien.udriot at ecodev.ch  Tue Aug 21 12:11:25 2012
From: fabien.udriot at ecodev.ch (Fabien Udriot)
Date: Tue, 21 Aug 2012 12:11:25 +0200
Subject: [TYPO3-doc]  Updated Document model
Message-ID: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>

Hi folks,

FYI, I have updated the Document Model while properly working on the implementation of the
rendering. For the time being, (some) changes are on a pending Git branch.

* Added the property "status". We (with Martin) faced the need for such a property enabling to store
status from the rendering. I went for a string field which enables human comprehensive message vs
numeric values which are hard to guess without referring to a guide.

* Added the property "origin". I am not totally happy with the name, I must say. I have other
suggestion such as "source" or "subtype". I would need to track the info where the package comes
from:  ter, git, svn because documents are going to be handled differently. We could also exploit
more the field "type" to make the distinguish but I am not convinced. Would you have an opinion?

* Following a suggestion from Robert, I have changed property "uri" and "locale" (old name was
language) to be handled as object since F3 1.1 is shipping an API. I have created a branch for
discussing the change / implementation if needed. You will notice I have added a few classes:

* Classes/Domain/Model/Uri.php extending \TYPO3\FLOW3\Http\Uri
* Classes/Domain/Model/Locale.php extending \TYPO3\FLOW3\I18n\Locale
* Classes/Domain/Repository/UriRepository.php enabling to query the URI repository.

The Git branch: https://github.com/typo3/TYPO3.Docs/commit/5ae448433c7fa7377dbfbe76e9bb938aa29724bf

Fabien

From m.bless at gmx.de  Tue Aug 21 17:58:47 2012
From: m.bless at gmx.de (Martin Bless)
Date: Tue, 21 Aug 2012 17:58:47 +0200
Subject: [TYPO3-doc] Updated Document model
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345564730.26751.typo3-project-documentation@lists.typo3.org>

[Fabien Udriot] wrote & schrieb:

>Hi folks,
>
>FYI, I have updated the Document Model while properly working on the implementation of the
>rendering. For the time being, (some) changes are on a pending Git branch.
>
>* Added the property "status". We (with Martin) faced the need for such a property enabling to store
>status from the rendering. I went for a string field which enables human comprehensive message vs
>numeric values which are hard to guess without referring to a guide.
>
>* Added the property "origin". I am not totally happy with the name, I must say. I have other
>suggestion such as "source" or "subtype". I would need to track the info where the package comes
>from:  ter, git, svn because documents are going to be handled differently. We could also exploit
>more the field "type" to make the distinguish but I am not convinced. Would you have an opinion?

I can imagine that we definitely need that information. And the name? Some
"brainstormers":

homesite
homeland
livingAt
livingPlace
livingSpace
livingRoom
peerGroup
homeRepository
sourceRepository


-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From philipp.gampe at typo3.org  Tue Aug 21 19:23:41 2012
From: philipp.gampe at typo3.org (Philipp Gampe)
Date: Tue, 21 Aug 2012 19:23:41 +0200
Subject: [TYPO3-doc] Updated Document model
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345564730.26751.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345569821.7333.typo3-project-documentation@lists.typo3.org>

Hi Martin,

>>* Added the property "origin". I am not totally happy with the name, I
>>must say. I have other suggestion such as "source" or "subtype". I would
>>need to track the info where the package comes
>>from:  ter, git, svn because documents are going to be handled
>>differently. We could also exploit more the field "type" to make the
>>distinguish but I am not convinced. Would you have an opinion?
> 
> I can imagine that we definitely need that information. And the name? Some
> "brainstormers":
> 
> homesite
> homeland
> livingAt
> livingPlace
> livingSpace
> livingRoom
> peerGroup

no nerdy names for fields please

> homeRepository
> sourceRepository

more something like sourceType

Cheers
-- 
Philipp Gampe ? PGP-Key 0AD96065 ? TYPO3 UG Bonn/K?ln
Documentation ? linkvalidator
TYPO3 .... inspiring people to share!


From m.bless at gmx.de  Tue Aug 21 21:35:23 2012
From: m.bless at gmx.de (Martin Bless)
Date: Tue, 21 Aug 2012 21:35:23 +0200
Subject: [TYPO3-doc] Updated Document model
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345564730.26751.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345569821.7333.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345577726.26985.typo3-project-documentation@lists.typo3.org>

[Philipp Gampe] wrote & schrieb:

>> I can imagine that we definitely need that information. And the name? Some
>> "brainstormers":
>> 
>> homesite
>> homeland
>> livingAt
>> livingPlace
>> livingSpace
>> livingRoom
>> peerGroup
>
>no nerdy names for fields please
>
>> homeRepository
>> sourceRepository
>
>more something like sourceType

which is pretty ambigous and misleading. Maybe

"documentationType" ?

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From fsu-lists at cobweb.ch  Tue Aug 21 22:18:24 2012
From: fsu-lists at cobweb.ch (=?UTF-8?B?RnJhbsOnb2lzIFN1dGVy?=)
Date: Tue, 21 Aug 2012 22:18:24 +0200
Subject: [TYPO3-doc] Updated Document model
In-Reply-To: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345580305.802.typo3-project-documentation@lists.typo3.org>

Hi Fabien,

> FYI, I have updated the Document Model while properly working on the implementation of the
> rendering. For the time being, (some) changes are on a pending Git branch.

Great!

> * Added the property "status". We (with Martin) faced the need for such a property enabling to store
> status from the rendering. I went for a string field which enables human comprehensive message vs
> numeric values which are hard to guess without referring to a guide.

Sounds good.

> * Added the property "origin". I am not totally happy with the name, I must say. I have other
> suggestion such as "source" or "subtype". I would need to track the info where the package comes
> from:  ter, git, svn because documents are going to be handled differently. We could also exploit
> more the field "type" to make the distinguish but I am not convinced. Would you have an opinion?

It's not clear enough to me what you want to track (and I guess that 
explains partly the diverging opinions on naming). Is it just the type 
of source (as you mention "ter", "git" or "svn") or would it be URIs to 
these resources (i.e. URL of SVN or Git repository, URL of TER archive)? 
If the latter, then "source" is a good choice IMO. If the former, I 
would quite go with "sourceType" too.

> * Classes/Domain/Model/Uri.php extending \TYPO3\FLOW3\Http\Uri
> * Classes/Domain/Model/Locale.php extending \TYPO3\FLOW3\I18n\Locale

Just to understand, was it necessary to create the two models? Can't the 
base classes be used directly? Do you expect us to have specials and 
thus have to extend the original classes anyway?

> * Classes/Domain/Repository/UriRepository.php enabling to query the URI repository.

Do we need the repository because the URIs are handled as objects? But 
then why not a locale repository? I guess my FLOW3 notions are not yet 
stellar ;-)

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From philipp.gampe at typo3.org  Wed Aug 22 08:27:57 2012
From: philipp.gampe at typo3.org (Philipp Gampe)
Date: Wed, 22 Aug 2012 08:27:57 +0200
Subject: [TYPO3-doc] Updated Document model
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345564730.26751.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345569821.7333.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345577726.26985.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345616877.3435.typo3-project-documentation@lists.typo3.org>

Hi Martin,

>>> homeRepository
>>> sourceRepository
>>
>>more something like sourceType
> 
> which is pretty ambigous and misleading. Maybe
> 
> "documentationType" ?

As Francois said, this really depends on what is stored inside.

As there really the type of documentation stored or an URI or a type of 
repository?

Cheers
-- 
Philipp Gampe ? PGP-Key 0AD96065 ? TYPO3 UG Bonn/K?ln
Documentation ? linkvalidator
TYPO3 .... inspiring people to share!


From fabien.udriot at ecodev.ch  Wed Aug 22 10:21:56 2012
From: fabien.udriot at ecodev.ch (Fabien Udriot)
Date: Wed, 22 Aug 2012 10:21:56 +0200
Subject: [TYPO3-doc] Updated Document model
In-Reply-To: <mailman.1.1345580305.802.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345580305.802.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345623716.22373.typo3-project-documentation@lists.typo3.org>

Hi!

Thanks for all your replies.

>> * Added the property "origin". I am not totally happy with the name, I must say. I have other
>> suggestion such as "source" or "subtype". I would need to track the info where the package comes
>> from:  ter, git, svn because documents are going to be handled differently. We could also exploit
>> more the field "type" to make the distinguish but I am not convinced. Would you have an opinion?
> 
> It's not clear enough to me what you want to track (and I guess that explains partly the diverging
> opinions on naming). Is it just the type of source (as you mention "ter", "git" or "svn") or would
> it be URIs to these resources (i.e. URL of SVN or Git repository, URL of TER archive)? If the
> latter, then "source" is a good choice IMO. If the former, I would quite go with "sourceType" too.

I rather need to track the type of the source ("ter", "git" or "svn") and "sourceType" sounds good
for this purpose.

FYI, URL of TER extensions can easily be computed through helper functions given an extension name
and a version. Though, for Git URL it could be more tricky to calculate the path given a package
name and we could possibly store the source URL as well. Though, let see in the implementation what
are the real needs. I am not finished with the Git part.

>> * Classes/Domain/Model/Uri.php extending \TYPO3\FLOW3\Http\Uri
>> * Classes/Domain/Model/Locale.php extending \TYPO3\FLOW3\I18n\Locale
> 
> Just to understand, was it necessary to create the two models? Can't the base classes be used
> directly? Do you expect us to have specials and thus have to extend the original classes anyway?

It was necessary (to my knowledge) to extend the class and thus create models for two reasons:

1. The extended class adds an entity annotation (@FLOW3\Entity) in order to be persistable.
2. The extended class overrides the constructor, which will set default empty value to properties
that are NULL by default. Otherwise, the entity will not be persisted with a complain of Doctrine.

Check the example of property:

protected $host = NULL (parent class)

-> should be set to $this->host = '' to be persisted.


>> * Classes/Domain/Repository/UriRepository.php enabling to query the URI repository.
> 
> Do we need the repository because the URIs are handled as objects? But then why not a locale
> repository? I guess my FLOW3 notions are not yet stellar ;-)

Well, making myself the first steps with FLOW3, let me expose the problematic. I am using the URI as
kind of identifier to retrieve one document in the database. The URI will also be used for the final
online URL which could look something like: http://docs.typo3.org/[URI].

Before, we had the URI object, I could write the code below to check whether a document exist:

$uri = '/TYPO3/Extensions/a21glossary/0.4.7'
$document = $documentRepository->findOneByUri($uri)
if (count(document) == 1) echo 'Good, there is one!!'

Since now, we are dealing with uri object, I had to change the code like that:

$path = '/TYPO3/Extensions/a21glossary/0.4.7'
$uri = $uriRepository->findOneByPath($path)
$document = $documentRepository->findOneByUri($uri)
if (count(document) == 1) echo 'Good, there is one!!'

This is not very straight forward... I am not aware of something better. Though, what we could
introduce is an "identifier" property which corresponds to the path of the uri. Furthermore, we can
add a constrain to have the unique values to this property. Then, we could have this code:

$identifier = '/TYPO3/Extensions/a21glossary/0.4.7'
$document = $documentRepository->findOneByIdentifier($identifier)
if (count(document) == 1) echo 'Good, there is one!!'

Having that, we could drop the uriRepository.

I hope it is clear enough...

Fb.

From ben.vantende at typo3.org  Wed Aug 22 16:45:16 2012
From: ben.vantende at typo3.org (ben van 't ende)
Date: Wed, 22 Aug 2012 16:45:16 +0200
Subject: [TYPO3-doc] New: "t3-field-list-table" directive now availble
 for ReST markup in our Sphinx documentation projects
In-Reply-To: <mailman.1.1345536013.16073.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345536013.16073.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345646717.19728.typo3-project-documentation@lists.typo3.org>

Heyla Martin,

It looks like you put quite some energy into this again. My major question would
if we will get rid of the wide tables that mess up the layout of the manual and
the html pages? There was a suggestion at one point to convert tables into
definition lists, which sounded very attractive to me.

Can you say something about that?

gRTz ben




On 21/08/12 10:00, Martin Bless wrote:
> Hello friends,
> 
> I'm happy to announce the the "t3-field-list-table" directive is now
> available for us in the Sphinx documentation projects.
> 
> Short history =============
> 
> Creating tables is sort of a problem in any editor. But it's important to as
> as there are often very long tables in the existing documentation. That's why
> I spent some effort last year to offer a better solution. And that was
> implementing a "field-list-table" directive for the Docutils (= basic ReST
> toolset). It goes back to ideas of 2005 in the Docutils community and was
> presented in [1]. To see some examples of how it is used see [2].
> 
> Unfortuneately in the meantime there was no manpower to get that into the
> Docutils core. That simply meant that we could not use it because it was not
> commonly available without "hacking".
> 
> In the meantime the "t3sphinx" Python package has been created and provides a
> way to easily spread all TYPO3 specific amendmends and extensions to
> everybody. Yesterday I spent a whole day to find - in the end - the three
> lines of code that give us the - new name! - "t3-field-list-table" directive
> back in our Sphinx projects.
> 
> This means: We can start using it!
> 
> Installation ============
> 
> Do this:
> 
> - Read [4] and - follow the "Installation" chapter. - See [3] and - add the
> TYPO3 specific codeblock manually to your "conf.py"
> 
> That's it.
> 
> 
> How does it work? =================
> 
> In ReST markup you write a doubly nested list. An unordered list is the outer
> one and constructs table rows. It's a "bullet-list" [5] in Docutil's terms:
> 
> - row1 - row2 - row3 - ...
> 
> Each row is a "field-list" [6] which means that each item is a key-value pair
> and creates a cell. The key is the column name. The value is the cell
> content. So a complete example may look like this:
> 
> .. t3-field-list-table:: :header-rows: 1
> 
> - :Property,20:    Property :Data type,20:   Data type :Description,50:
> Description :Default,10:     Default
> 
> - :Property:    allWrap :Data type:   wrap / stdWrap :Description: Wraps the
> whole item
> 
> - :Property:    wrapItemAndSub
> 
> :Data type:   wrap / stdWrap
> 
> :Description: Wraps the whole item and any submenu concatenated to it.
> 
> The table has three rows. The first on is a header row. And there a four
> named columns with desired widths 20%, 20%, 50%, 10%. The unnumbered list
> markup and the field-list markup follows the normal standard ReST syntax
> rules. Without our directive you would have to use the "grid table" markup of
> the Docutils to produce the same result:
> 
> +----------------+---------------+---------------------------------+-------------+
>
> 
| Property       | Data type     | Description                     |  Default    |
> +================+===============+=================================+=============+
>
> 
| allWrap        | wrap /stdWrap | Wraps the whole item            |             |
> +----------------+---------------+---------------------------------+-------------+
>
> 
| wrapItemAndSub | wrap /stdWrap | Wraps the whole item and        |             |
> |                |               | any submenu concatenated to it. |
> | 
> +----------------+---------------+---------------------------------+-------------+
>
> 
> 
> Implications ... ================
> 
> Just a few notes, mainly for the TYPO3 documentation team:
> 
> 1. We had given up the idea of keeping tables because we couldn't handle then
> in markup.
> 
> 2. Now we can handle them! (using "t3-field-list-table")
> 
> 3. We had found a "definition list markup" as workaround to write existings
> tables in OpenOffice documents in ReST markup. And that's how all our
> official documents are now in the Git repositories.
> 
> 4. It would be much nicer to have (2.) instead of (3.) for the existing
> tables!
> 
> 5. If we want to have (4.) - yes, we do! - this means we either have to do it
> manually or generate everything once again and push it once again to Git.
> 
> 6. To achieve (5.) manually is not as much work as it sounds because the ReST
> markup is very similar. So that's what I would propose.
> 
> 7. IN GENERAL there was an agreement when we asked in the documentation list
> that we in general should not use those big tables as there are, for example,
> in the TyposcriptReferenceManual. Where appropriate stuff should be rewritten
> using other "normal" text constructs. But this can only be done manually.
> That's another argument, I'd say, to keep the current docs as they are (see
> 3.) and to improve manually as in (6.).
> 
> 8. And, KEEP IN MIND, the kind of voting mentioned in (7.) should not mean at
> all that you should avoid tables in general. Yes, please do use tables
> wherever you find them appropriate. If you have table like data you should
> write that as table.
> 
> I'm hoping you can follow my numbers =:-) I feel a bit like a lawyer ... But
> don't worry, I'm not at all.
> 
> 
> 
> [1]
> http://lists.typo3.org/pipermail/typo3-project-documentation/2011-November/003517.html
>
>  [2] 
> http://mbless.de/4us/typo3-oo2rest/06-The-%5Bfield-list-table%5D-directive/1-demo.rst.html
>
>  [3]
> http://lists.typo3.org/pipermail/typo3-project-documentation/2012-August/004048.html
>
>  [4] 
> http://git.typo3.org/Documentation/RestTools.git?a=blob_plain;f=ExtendingSphinxForTYPO3/README.txt;hb=HEAD
>
>  [5]
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists
>
>  [6]
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists
>
> 
-- 
TYPO3 Community Manager

From m.bless at gmx.de  Thu Aug 23 00:05:21 2012
From: m.bless at gmx.de (Martin Bless)
Date: Thu, 23 Aug 2012 00:05:21 +0200
Subject: [TYPO3-doc] New: "t3-field-list-table" directive now availble
	for ReST markup in our Sphinx documentation projects
References: <mailman.1.1345536013.16073.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345646717.19728.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345673125.21305.typo3-project-documentation@lists.typo3.org>

Heyla heyla heyla (which song was it?) Ben,

>Heyla Martin,
>
>It looks like you put quite some energy into this again. My major question would
>if we will get rid of the wide tables that mess up the layout of the manual and
>the html pages? There was a suggestion at one point to convert tables into
>definition lists, which sounded very attractive to me.
>
>Can you say something about that?

Sure. I even tried in that paragraph 7.:

>> 7. IN GENERAL there was an agreement when we asked in the documentation list
>> that we in general should not use those big tables as there are, for example,
>> in the TyposcriptReferenceManual. Where appropriate stuff should be rewritten
>> using other "normal" text constructs. But this can only be done manually.
>> That's another argument, I'd say, to keep the current docs as they are (see
>> 3.) and to improve manually as in (6.).

But I agree that it was more lawyer's diction and hard to understand. Natural language
goes like this:

It's cool that we now CAN use tables much easier. When you write documentation use the
most natural way of writing (headlines, text, lists, definitions, indentation, codeblocks,
...). Use tables where appropriate. Real table data can best be expressed by tables:

===== ========
Name   gender
===== ========
Peter  male
Paul   male
Mary   female
===== ========

Do not create those big large tables any more like we had in for example the Tsref.

But what do we do with those big tables we still have? For example:
http://preview.docs.typo3.org/TYPO3/Extensions/powermail/1.6.9/#constants-table

which is directly taken from the OpenOffice document. Current state is: We want to get rid
of them. We can transform them automatically to that "definition list" structure. But we
don't have a nice "frontend layout" for that. The definition list structure is by far not
as understandable as the table. We chose the definition list structure (a) in the hope to
find a nice JS/CSS trick for it, which we haven't yet and (b) because the ReST can best be
edited manually. Or even easily editited back to the now possible "t3-field-list-table"
format.

I know about the big pressure we have to get a good rendering done on typo3.org. If we
don't present tables as tables there people will complain and not understand what's being
shown there.

I think it need human intelligence and an editor to rewrite stuff that had been in tables
before to create the new and modern form.

Hhm, it's late, I'm tired, do you get what I mean?

cu!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From ben.vantende at typo3.org  Thu Aug 23 12:39:15 2012
From: ben.vantende at typo3.org (ben van 't ende)
Date: Thu, 23 Aug 2012 12:39:15 +0200
Subject: [TYPO3-doc] New: "t3-field-list-table" directive now availble
 for ReST markup in our Sphinx documentation projects
In-Reply-To: <mailman.1.1345673125.21305.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345536013.16073.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345646717.19728.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345673125.21305.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345718356.16343.typo3-project-documentation@lists.typo3.org>

Heyla,

Thanks for the human readable explanation. It is totally clear and  would love
to see this stuff in production. Now even I can join in writing documantation.

gRTz ben



On 23/08/12 00:05, Martin Bless wrote:
> Heyla heyla heyla (which song was it?) Ben,
> 
>> Heyla Martin,
>>
>> It looks like you put quite some energy into this again. My major question would
>> if we will get rid of the wide tables that mess up the layout of the manual and
>> the html pages? There was a suggestion at one point to convert tables into
>> definition lists, which sounded very attractive to me.
>>
>> Can you say something about that?
> 
> Sure. I even tried in that paragraph 7.:
> 
>>> 7. IN GENERAL there was an agreement when we asked in the documentation list
>>> that we in general should not use those big tables as there are, for example,
>>> in the TyposcriptReferenceManual. Where appropriate stuff should be rewritten
>>> using other "normal" text constructs. But this can only be done manually.
>>> That's another argument, I'd say, to keep the current docs as they are (see
>>> 3.) and to improve manually as in (6.).
> 
> But I agree that it was more lawyer's diction and hard to understand. Natural language
> goes like this:
> 
> It's cool that we now CAN use tables much easier. When you write documentation use the
> most natural way of writing (headlines, text, lists, definitions, indentation, codeblocks,
> ...). Use tables where appropriate. Real table data can best be expressed by tables:
> 
> ===== ========
> Name   gender
> ===== ========
> Peter  male
> Paul   male
> Mary   female
> ===== ========
> 
> Do not create those big large tables any more like we had in for example the Tsref.
> 
> But what do we do with those big tables we still have? For example:
> http://preview.docs.typo3.org/TYPO3/Extensions/powermail/1.6.9/#constants-table
> 
> which is directly taken from the OpenOffice document. Current state is: We want to get rid
> of them. We can transform them automatically to that "definition list" structure. But we
> don't have a nice "frontend layout" for that. The definition list structure is by far not
> as understandable as the table. We chose the definition list structure (a) in the hope to
> find a nice JS/CSS trick for it, which we haven't yet and (b) because the ReST can best be
> edited manually. Or even easily editited back to the now possible "t3-field-list-table"
> format.
> 
> I know about the big pressure we have to get a good rendering done on typo3.org. If we
> don't present tables as tables there people will complain and not understand what's being
> shown there.
> 
> I think it need human intelligence and an editor to rewrite stuff that had been in tables
> before to create the new and modern form.
> 
> Hhm, it's late, I'm tired, do you get what I mean?
> 
> cu!
> 
> Martin
> 

-- 
TYPO3 Community Manager

From fsu-lists at cobweb.ch  Thu Aug 23 20:56:11 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 23 Aug 2012 20:56:11 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345748172.30338.typo3-project-documentation@lists.typo3.org>

Hi,

> We will give Big Blue Button one more try
> (http://bigbluebutton.typo3.org/), but if anyone has trouble connecting
> we will promptly switch to Skype. So if you aren't yet in contact with
> me via Skype, please prompt me. My account is "fsuter".

The server seems to have trouble again. Every time I create the meeting 
and try to enter it, I get a pop-up window telling me that I am logged 
out and sending me back to the home page.

Unless Steffen is out there now and can do something about it, we'll use 
Skype.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Thu Aug 23 21:06:35 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Thu, 23 Aug 2012 21:06:35 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345748172.30338.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345748172.30338.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345748796.32418.typo3-project-documentation@lists.typo3.org>

> Unless Steffen is out there now and can do something about it, we'll use
> Skype.

We *are* using Skype.

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Fri Aug 24 17:11:02 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Fri, 24 Aug 2012 17:11:02 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>

Hi all,

> Our next team meeting will take place this coming Thursday (August 23)
> at 21:00 CET.

And here are the minutes: 
http://forge.typo3.org/projects/team-docteam/wiki/2012-08-23

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Fri Aug 24 17:12:45 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Fri, 24 Aug 2012 17:12:45 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345748796.32418.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345748172.30338.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345748796.32418.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345821167.3291.typo3-project-documentation@lists.typo3.org>

Hi,

>> Unless Steffen is out there now and can do something about it, we'll use
>> Skype.
>
> We *are* using Skype.

Fabien restarted the server and we could get a bit further. Martin and 
Fabien could access the meeting room, but I was stuck with the 
confirmation dialog about allowing access to the headset. So we switched 
to Skype and - as far as I'm concerned - that was the last chance I gave 
to BBB. The next meeting will probably be on Skype right away, it seems 
convenient for most.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From fsu-lists at cobweb.ch  Fri Aug 24 17:13:39 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Fri, 24 Aug 2012 17:13:39 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1345821220.3291.typo3-project-documentation@lists.typo3.org>

> And here are the minutes:
> http://forge.typo3.org/projects/team-docteam/wiki/2012-08-23

*Please note* the next meeting has been postponed one week to September 
27th, to accommodate for Martin's holidays (or vacations as some would 
have it ;-) ).

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From steffen.gebert at typo3.org  Mon Aug 27 23:47:01 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Mon, 27 Aug 2012 23:47:01 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

regarding the manuals shipped with 6.0: Do you want to update the sxw
files, again?

What about shipping PDFs? You could render them out of the ReST
markup... and people would enjoy having PDFs instead of SXWs.

Adding such a functionality - to prefer PDFs (if existant) - shouldn't
be a big deal.

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/24/12 5:11 PM, schrieb Fran?ois Suter:
> Hi all,
> 
>> Our next team meeting will take place this coming Thursday
>> (August 23) at 21:00 CET.
> 
> And here are the minutes: 
> http://forge.typo3.org/projects/team-docteam/wiki/2012-08-23
> 
> Cheers
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iQEcBAEBAgAGBQJQO+rVAAoJEIskG/rSlyw4iTIIAJUofqfMQSNw7ZVS8vNuZnMH
0iTUNcSYko+COmJkCt/WC8hMlPgfVCe7fpmnel/BNecuTYiIQoknWEqPd9uoKb8+
jPh1M38rtZly3z7eRllvn3YtFxc89EVp7WrTbMVGWBNSBNTnOGFupyQ38X+QJX0G
uoCJjo9UuPDpZVre3aMQCUTEppmzw1ZHp6Z9Vl5I0maEJ0+X++uU6OSVYM70HnI+
vUbeJrI5yrLbvkkHFiMrswW4KQw5gnhJAvOPLIX2BtPtQ+z6q12RVj3iCIfhqsP0
Qruo1zVtE1QGp8RXpPCEiC0rzO1tSZYbPeuQ0PtAXWxgwAlmTEHjbKIwJNUceaQ=
=r1k9
-----END PGP SIGNATURE-----

From fsu-lists at cobweb.ch  Tue Aug 28 08:47:54 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Tue, 28 Aug 2012 08:47:54 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346136475.6400.typo3-project-documentation@lists.typo3.org>

Hi Steffen,

> regarding the manuals shipped with6.0:  Do you want to update the sxw
> files, again?

Some have been updated already AFAIK. I know someone updated the 
Scheduler's manual at least, I don't know for the others.

> What about shipping PDFs? You could render them out of the ReST
> markup... and people would enjoy having PDFs instead of SXWs.
>
> Adding such a functionality - to prefer PDFs (if existant) - shouldn't
> be a big deal.

Well, PDFs could be produced out of the OO files anyway. I guess we 
should have done this a long time ago already, as it is far more 
convenient as you say. Still I wouldn't do the effort now. And we're not 
quite ready to render PDFs from ReST (I mean, it works, but it has 
definitely not been streamlined yet).

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From steffen.gebert at typo3.org  Tue Aug 28 09:03:13 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Tue, 28 Aug 2012 09:03:13 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1346136475.6400.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346136475.6400.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346137392.9040.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

We have also pushed changes for some other manuals.
It would be a pity to require this work to be done in SWX.

And yes, I think we should convert everything to PDF. And we could
deciced, whether we create that PDF from SXW or from ReST.

Don't you think it would be possible to create a usable PDF version
(Xavier?).

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/28/12 8:47 AM, schrieb Fran?ois Suter:
> Hi Steffen,
> 
>> regarding the manuals shipped with6.0:  Do you want to update the
>> sxw files, again?
> 
> Some have been updated already AFAIK. I know someone updated the 
> Scheduler's manual at least, I don't know for the others.
> 
>> What about shipping PDFs? You could render them out of the ReST 
>> markup... and people would enjoy having PDFs instead of SXWs.
>> 
>> Adding such a functionality - to prefer PDFs (if existant) -
>> shouldn't be a big deal.
> 
> Well, PDFs could be produced out of the OO files anyway. I guess
> we should have done this a long time ago already, as it is far
> more convenient as you say. Still I wouldn't do the effort now. And
> we're not quite ready to render PDFs from ReST (I mean, it works,
> but it has definitely not been streamlined yet).
> 
> Cheers
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iQEcBAEBAgAGBQJQPG0wAAoJEIskG/rSlyw4+JQIAJiLCeRgORho2fjQpG3rTeO0
0KwV0VtCo9Q8mE+qGRW8DJARSEIr/ZnPJEbUniltGXeaCB2PwzWvbBHDEzYiWNga
c+EK/YU1A+oze4vfEz1LRztFc+L32Ws94djHlpIv+7wJYgSAsg3enlqGO6ob1cmn
Z0GBBs+YptjqvlbwUPGzOfXbiajXKYNHYMW7y3Lv4Yyvc0toEMRn8+atekxrlJRC
dv2bZNqfdpDuDgc5M0BcIppjZ8r6lM9ALmUXveVsJxFT6p0rIGHQFTagaeyDCCu1
VWrygE3GZYnrIrLoRYjz6IKpuVrlQBhM8yCL23+z37i3JcyV3zNJ3ZM148QIuFs=
=5yUX
-----END PGP SIGNATURE-----

From fsu-lists at cobweb.ch  Tue Aug 28 10:10:49 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Tue, 28 Aug 2012 10:10:49 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1346137392.9040.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346136475.6400.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346137392.9040.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346141450.20311.typo3-project-documentation@lists.typo3.org>

Hi Steffen,

> We have also pushed changes for some other manuals.
> It would be a pity to require this work to be done in SWX.

Don't confuse system extension manuals and official manuals. The 
official manuals are definitely migrated to ReST and the changes that 
have been submitted are going to be merged indeed. No need to redo 
anything in SXW format.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

From philipp.gampe at typo3.org  Tue Aug 28 19:38:41 2012
From: philipp.gampe at typo3.org (Philipp Gampe)
Date: Tue, 28 Aug 2012 19:38:41 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346175521.12079.typo3-project-documentation@lists.typo3.org>

Hi Steffen Gebert,

Steffen Gebert wrote:

> What about shipping PDFs? You could render them out of the ReST
> markup... and people would enjoy having PDFs instead of SXWs.

Adding more binary files will pollute the git even more. They will be in the 
history and every new clone of TYPO3 will have to download all version. The 
binary diff works, but is not very effective if a lot changes between 
versions and of course doesn't help while adding new files.

I would carefully consider adding new files.

Best regards
-- 
Philipp Gampe ? PGP-Key 0AD96065 ? TYPO3 UG Bonn/K?ln
Documentation ? linkvalidator
TYPO3 .... inspiring people to share!


From steffen.gebert at typo3.org  Tue Aug 28 23:04:58 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Tue, 28 Aug 2012 23:04:58 +0200
Subject: [TYPO3-doc] Next team meeting: Thursday, August 23, 21:00 CET
In-Reply-To: <mailman.1.1346175521.12079.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345486715.14160.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345821064.3291.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346104021.14411.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346175521.12079.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346187898.9271.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Honestly, I don't care about 10 new PDFs at all..

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/28/12 7:38 PM, schrieb Philipp Gampe:
> Hi Steffen Gebert,
> 
> Steffen Gebert wrote:
> 
>> What about shipping PDFs? You could render them out of the ReST 
>> markup... and people would enjoy having PDFs instead of SXWs.
> 
> Adding more binary files will pollute the git even more. They will
> be in the history and every new clone of TYPO3 will have to
> download all version. The binary diff works, but is not very
> effective if a lot changes between versions and of course doesn't
> help while adding new files.
> 
> I would carefully consider adding new files.
> 
> Best regards
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iQEcBAEBAgAGBQJQPTJ6AAoJEIskG/rSlyw4s+QIALZQgXyT+oNurGwlyIb8vFKu
mjdAMk5Hv6WmKnqa0WMO8ZwYRqX6iv2cEeLsUpmjLmXdqnTCBySx57tSTRR6Twdn
9LDqdT8FK2RCt+Yw47EOJhDJfWnp5kTVKKlXRurh+xCZgQCb90kHnT/f0yMm6aEk
c2PkomX73SDaQJiBrXAWTuN1SHDXABvuKJhb12VuDbE5fRyaFgWKOMyCvUJCm4wF
vWZcszQWF3/iCS4Ygy2l9G+7hB5a3S9vRPUEc/tiK7F7ZCXdBf7XC9deeYaQjpEv
rwYQtvw9Y3GXGdf+rh3rsE7VfotvOhtp7YXDZtq2s/MyBMI1T7sz+nvjXNiLsf0=
=wT38
-----END PGP SIGNATURE-----

From fabien.udriot at ecodev.ch  Wed Aug 29 19:22:49 2012
From: fabien.udriot at ecodev.ch (Fabien Udriot)
Date: Wed, 29 Aug 2012 19:22:49 +0200
Subject: [TYPO3-doc] Updated Document model
In-Reply-To: <mailman.1.1345623716.22373.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345580305.802.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345623716.22373.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346260969.14822.typo3-project-documentation@lists.typo3.org>

Hi,

As reminder, we have a Document model with properties $uri and $local which are both of type string.
There has been the suggestion to use object \TYPO3\FLOW3\Http\Uri and \TYPO3\FLOW3\I18n\Locale newly
introduced in FLOW3 1.1 to benefit from an API and validation at the same time.

However, I faced the problem that declaring the $uri of type \TYPO3\FLOW3\Http\Uri (in the
annotation) was not sufficient for doctrine. The field was simply not created because
\TYPO3\FLOW3\Http\Uri is not an entity. A solution, would have been to create proper entity
extending the Uri object from F3. Though, it looks wrong since Uri would have been part of the
Domain Model which does not make sense considering DDD.

As a result, we sticked to the string property in the model but created an additional getter method
to fetch an object in case. For the curious ones, it roughly looks like below.

class Document {

 /**
  * @var string
  */
 protected $uri

 function getUri($uri) {
    return $uri;
 }

 function getUriObject($uri) {
    return \TYPO3\FLOW3\Http\Uri($uri);
 }
}

The whole Document model looks like that by now:
https://github.com/typo3/TYPO3.Docs/blob/master/Classes/Domain/Model/Category.php

Fabien

From robert at typo3.org  Thu Aug 30 13:43:57 2012
From: robert at typo3.org (Robert Lemke)
Date: Thu, 30 Aug 2012 13:43:57 +0200
Subject: [TYPO3-doc] Updated Document model
In-Reply-To: <mailman.1.1346260969.14822.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1345543885.4304.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345580305.802.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1345623716.22373.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346260969.14822.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.7976.1346327042.626.typo3-project-documentation@lists.typo3.org>

Hi Fabien,

On 29.08.2012, at 19:22, Fabien Udriot <fabien.udriot at ecodev.ch> wrote:

> However, I faced the problem that declaring the $uri of type \TYPO3\FLOW3\Http\Uri (in the
> annotation) was not sufficient for doctrine. The field was simply not created because
> \TYPO3\FLOW3\Http\Uri is not an entity. A solution, would have been to create proper entity
> extending the Uri object from F3. Though, it looks wrong since Uri would have been part of the
> Domain Model which does not make sense considering DDD.


I'd love to avoid that workaround. 

Have you tried annotating Http\Uri with @FLOW3\Entity? (don't forget to remove the @FLOW3\Proxy(false)).
If that works we can add some validation rules for each of the properties and make it part of FLOW3 1.2. 

I'd be glad if you could test this and if possible provide a patch.

Cheers,
Robert

-- 
Robert Lemke
Lead Developer TYPO3 Phoenix and FLOW3
Co-Founder TYPO3 Association

Blog: robertlemke.de/blog
Get involved: typo3.org ? flow3.org




From typo3 at t3node.com  Fri Aug 31 11:53:27 2012
From: typo3 at t3node.com (=?UTF-8?B?U3RlZmZlbiBNw7xsbGVy?=)
Date: Fri, 31 Aug 2012 11:53:27 +0200
Subject: [TYPO3-doc]  preview.docs.typo3.org:5000 down
Message-ID: <mailman.1.1346406807.24416.typo3-project-documentation@lists.typo3.org>

Hi.

I use to proofread my ReST docs on preview.docs.typo3.org:5000 which is
very convenient.

The service is down for some days, could someone please have a look?
Michael Stucki already tried to reboot the machine, without result.

Thanks.

-- 
cheers,
Steffen

TYPO3 Blog: http://www.t3node.com/
Twitter: @t3node - http://twitter.com/t3node

From m.bless at gmx.de  Fri Aug 31 12:38:53 2012
From: m.bless at gmx.de (Martin Bless)
Date: Fri, 31 Aug 2012 12:38:53 +0200
Subject: [TYPO3-doc] preview.docs.typo3.org:5000 down
References: <mailman.1.1346406807.24416.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346409536.32170.typo3-project-documentation@lists.typo3.org>

Hi Steffen [M?ller],

I'm sorry for the delay - this thing slipped out of my hands.

>Hi.
>
>I use to proofread my ReST docs on preview.docs.typo3.org:5000 which is
>very convenient.
>
>The service is down for some days, could someone please have a look?
>Michael Stucki already tried to reboot the machine, without result.

Yes, rebooting doesn't help because it is just kind of experimental.

Now it's running again.

It will not work after a reboot of srv123. To start the service do this:

  su mbless
  cd /home/mbless/rst-ninjs-org/rsted
  python application.py &


The advantage of http://preview.docs.typo3.org:5000 is that the style
"nature" uses CSS that looks already a bit like TYPO3 ...

Tip:
If it seems stuck with an syntax error simply reload the page.



Remember that you can use the website of the author of this tool as
well: 
http://rst.ninjs.org/

And there you have the "true nature" CSS.

... all the best ...

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de

From steffen.gebert at typo3.org  Fri Aug 31 13:13:42 2012
From: steffen.gebert at typo3.org (Steffen Gebert)
Date: Fri, 31 Aug 2012 13:13:42 +0200
Subject: [TYPO3-doc] preview.docs.typo3.org:5000 down
In-Reply-To: <mailman.1.1346409536.32170.typo3-project-documentation@lists.typo3.org>
References: <mailman.1.1346406807.24416.typo3-project-documentation@lists.typo3.org>
	<mailman.1.1346409536.32170.typo3-project-documentation@lists.typo3.org>
Message-ID: <mailman.1.1346411622.4973.typo3-project-documentation@lists.typo3.org>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

> It will not work after a reboot of srv123. To start the service do
> this:
> 
> su mbless cd /home/mbless/rst-ninjs-org/rsted python application.py
> &

weird, I tried that. But I don't remember the error message

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 v4 Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

Am 8/31/12 12:38 PM, schrieb Martin Bless:
> Hi Steffen [M?ller],
> 
> I'm sorry for the delay - this thing slipped out of my hands.
> 
>> Hi.
>> 
>> I use to proofread my ReST docs on preview.docs.typo3.org:5000
>> which is very convenient.
>> 
>> The service is down for some days, could someone please have a
>> look? Michael Stucki already tried to reboot the machine, without
>> result.
> 
> Yes, rebooting doesn't help because it is just kind of
> experimental.
> 
> Now it's running again.
> 
> It will not work after a reboot of srv123. To start the service do
> this:
> 
> su mbless cd /home/mbless/rst-ninjs-org/rsted python application.py
> &
> 
> 
> The advantage of http://preview.docs.typo3.org:5000 is that the
> style "nature" uses CSS that looks already a bit like TYPO3 ...
> 
> Tip: If it seems stuck with an syntax error simply reload the
> page.
> 
> 
> 
> Remember that you can use the website of the author of this tool
> as well: http://rst.ninjs.org/
> 
> And there you have the "true nature" CSS.
> 
> ... all the best ...
> 
> Martin
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iQEcBAEBAgAGBQJQQJxmAAoJEIskG/rSlyw4txQH/iMCCUfRJPQMRwUqWg7r9xRI
kX4gxdLHfEdj6q6v+go5dOl7c8/UPB1yAsNyPZYH/LLePevc+/0F73F7H1C/5atI
IBQF4oWf8M0SA+F6RcMhNJRA9USB+zluKXBzwIN5sgGDYImKOxsEde9FGuHGpxzL
70NfLOkAnDDLGVFre04uzB+mC7soRkHPt4i83KvsuP8PGIAZb+9izgOhhPNFTTLZ
7TSbcDhF3F2Hgb8zROUeFifolr6hEiXPZlt5oIaE1MVrPOl3yvPyteIkzYCQ1ujl
si0GZQQeg2hs67WNa6rhLRlJVxm8SHyNe8X2tN4vG9Ns0sQzwcjFBDdGpiJ7/ig=
=jGDE
-----END PGP SIGNATURE-----

From fsu-lists at cobweb.ch  Fri Aug 31 14:33:08 2012
From: fsu-lists at cobweb.ch (=?ISO-8859-1?Q?Fran=E7ois_Suter?=)
Date: Fri, 31 Aug 2012 14:33:08 +0200
Subject: [TYPO3-doc] Trouble rendering locally the official manual example
Message-ID: <mailman.1.1346416389.22665.typo3-project-documentation@lists.typo3.org>

Hi all,

Having changed laptop a couple of weeks back, I tried again rendering 
the official manual example to HTML, but I don't get the typo3sphinx 
theme applied. Could it be because of the change to using a global 
settings YAML file?

Or did something go wrong in my install? At least I don't see any error 
message. I ran:

sudo python setup.py install

(after having updated RestTools to latest master, and here's the output:

https://gist.github.com/3552146

I also updated the official manual to the latest master. When running 
"make html", I get the following output:

sphinx-build -b html -d build/doctrees  -c . -a -E -w 
./_not_versioned/warnings.txt .. build/html
Running Sphinx v1.1.3
building [html]: all source files
updating environment: 4 added, 0 changed, 0 removed
reading sources... [100%] NextSteps/Index 
 

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] NextSteps/Index 
 

writing additional files... genindex search
copying images... [100%] 
Chapter1/../Images/IntroductionPackageLoginScreen.png 

copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in build/html.

Again no visible error. Any idea why I am not getting the typo3sphinx them?

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch