[TYPO3-english] Bye-bye OpenOffice, welcome ReST
Xavier Perseguers
xavier at typo3.org
Wed Aug 21 13:56:18 CEST 2013
Hi Stephen,
Stephen Bungert wrote:
> Are there any screenshots of what this mark up looks like? I have never
> heard of REST.
Go to any manual on docs.typo3.org, example:
http://docs.typo3.org/typo3cms/extensions/sphinx/latest/
navigate in any chapter and click on "Show Source" top on the right to
see how a given chapter is written (useful to see how to embed pictures,
render tables, create links, ...)
> Also is there away to convert existing OOo manuals to this
> new format... I have some pretty long manuals... I really don't want to have
> to write them by hand in the new format.
EXT:sphinx comes with a wizard to convert your existing extension
manuals. Otherwise have a look at
http://docs.typo3.org/typo3cms/extensions/sphinx/latest/UsersManual/SphinxRest/Index.html
> Do still package the documentation with the extension?
Yes, you still need to package the documentation with the extension,
just as before. The difference is, instead of being stored as
doc/manual.sxw, it's a Sphinx project stored in Documentation/ whose
main file is Index.rst. Basically that's all. A few more details:
http://docs.typo3.org/typo3cms/extensions/sphinx/latest/UsersManual/DocsTypo3Org/Index.html#title-copyright-and-version
Kind regards
--
Xavier Perseguers
Release Manager TYPO3 4.6
TYPO3 .... inspiring people to share!
Get involved: http://typo3.org
More information about the TYPO3-english
mailing list