[TYPO3-dev] Feedback on rendered extension manuals

François Suter fsu-lists at cobweb.ch
Thu Sep 18 22:00:04 CEST 2014


Hi all,

If your extension uses reStructuredText for its manual, you can get some 
feedback on the rendering process by accessing a "warnings.txt" file on 
docs.typo3.org. The URL is as follows:

http://docs.typo3.org/typo3cms/extensions/<extension-key>/<version>/warnings.txt

If you have activated PDF rendering, the detailed rendering log can be 
accessed at:

http://docs.typo3.org/typo3cms/extensions/<extension-key>/<version>/pdf.log.

For example, this is the reporting for the "media" manual:

http://docs.typo3.org/typo3cms/extensions/media/3.0.0/warnings.txt

or the PDF log for the "ig_ldap_sso_auth" manual:

http://docs.typo3.org/typo3cms/extensions/ig_ldap_sso_auth/1.3.0/pdf.log

This is limited, in particular because there won't even be a 
"warnings.txt" file if the rendering process crashes. In the future we 
aim to have much more useful feedback, but this is already better than 
nothing if your manual is not rendering as expected.

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-dev mailing list