[Typo3-dev] Documentation revision numbers.
wes currier
typo3 at wesfx.com
Fri May 14 07:41:10 CEST 2004
I do not know if this is the correct place or time, but here goes.
I have followed the lists for awhile and have just started using typo3. Yes there is a lot of
documentation. It is also all over the board as far as location and document level.
For example I realized I need to look at the typoscript by example document to learn some things I
could not pick up in TS ref. Here is the link.
http://typo3.org/typo3temp/manual-doc_core_tsbyex-14-12-2002_02-38-25.sxw
It states at the top of the document "revised spring 2001" yet clearly the date on the extension in
the file above is 2002. Also what revision is this for? -- 3.2b, 3.3, 3.5, 3.6RC1, 3.6RC2, 3.6.0,
3.6.1. Yes I know in this instance I am being a nitpick.
My point is that it would help us new users to have documents linked to version numbers also with
revisions and have all documentation in one location.
For example Kasper stated here a few days ago that there were some new configurations in the TS REF
regarding attaching external javaScript files. But when I downloaded the TS ref it was not in there.
So one had to go to sourceforge to find the document. So why is not all documentation in one
location. Or if it needs to be in multiple locations why not have a link to all the places documents
are stored? for example: "Additional documents located at these links. . ."
So, currently we have documents in the following locations.
http://typo3.com/Documentation.1242.0.html (takes you to typo3.org)
http://typo3.org/documents
http://130.228.0.33/t3dl/src/
http://typo3.sunsite.dk/documentation/
http://sourceforge.net/projects/typo3/
http://sourceforge.net/project/showfiles.php?group_id=20391&package_id=14725
(which realistically is the same as the one above it)
The second this is that because there have been changes to the underlying structure of typo3, some
documentation is clearly out of date and obsolete. Unfortunately nothing about the document states
that issue.
My suggestion is to implement some sort of major.minor.rev for the documents that also matches the
source code revisions. That way I know I do have the latest revision of a document. It would also
help me eliminate certain older obsolete documents from my searches.
Thanks for listening
wes currier
More information about the TYPO3-dev
mailing list