[TYPO3-doc] RFC: Link examples in the official manual template

François Suter fsu-lists at cobweb.ch
Sat Sep 1 22:28:28 CEST 2012


Hi all,

The Official Manual template is not meant to be just a template, but 
also an example of all possible markups. I have just added a section 
about links. See the following patch:

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

There's one important thing missing in this patch: cross-links to other 
manuals using Intersphinx. The problem - if I'm not mistaken - is that 
none of the existing manuals have labels yet, so we can't make 
cross-links, even though the manuals are now referenced for mapping in 
the global settings YAML file. Is that right?

If yes, I propose to quickly add a few labels to some manual (for 
example, Core APIs, for which there's quite a bit of pending 
documentation changes anyway) and use that for the first cross-link 
examples).

Apart from that, I would welcome reviews for this patch. Are my link 
examples good (I'm not really proficient with ReST yet)? Could there be 
other useful examples?

Cheers

-- 

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


More information about the TYPO3-project-documentation mailing list