[TYPO3-english] ext. manuals on typo3.org not accessible
François Suter
fsu-lists at cobweb.ch
Tue Mar 4 23:19:24 CET 2014
Hi Pero,
There are rules to follow for manuals to be rendered correctly. If
documentation is based on reStructuredText, it is expected either to be
a full structure beginning with Documentation/Index.rst, or a single
file at the root of the extension called README.rst. If based on
OpenOffice, it must be located in doc/manual.sxw.
Any other combination will not work.
> http://docs.typo3.org/typo3cms/extensions/gridelements/2.0.2
I checked that one recently, it uses Documentation/manual.sxw, which
will not work.
> http://docs.typo3.org/typo3cms/extensions/flux/6.0.2
This one has a README.md (not .rst) and only a couple of image files in
Documentation. This does not work either.
What is wrong, though, is that the TER should not have a link to a
documentation that cannot be rendered. I'm not entirely sure, but I
think it bases itself on a file provided by docs.typo3.org (at least I
know we provide one, but I'm not sure if the TER uses it), so it may be
our file that is wrong.
So you're right that there's something to dig into.
Cheers
--
Francois Suter
Work: Cobweb Development Sarl - http://www.cobweb.ch
TYPO3: Help the project! - http://typo3.org/contribute/
Appreciate my work? Support me -
http://www.monpetitcoin.com/en/francois/support-me/
More information about the TYPO3-english
mailing list