[TYPO3-doc] Intersphinx keys

François Suter fsu-lists at cobweb.ch
Sun Jul 1 17:53:28 CEST 2012


Hi all,

During the last team meeting, we discussed the inclusion of Intersphinx 
keys in the conf.py of all official manuals, so that we have a 
cross-linking standard in all the manuals. Furthermore this can serve as 
best practice for extension authors who would like do such cross-linking 
from their manuals.

For this we need to define which keys to use. As a reminder these keys 
are mapped to the manuals' URLs and should be short but explicit to ease 
their use.

In a previous discussion we had decided to prefix TYPO3 manuals-related 
keys with "t3". Reminder: Intersphinx keys can be alphanumeric only.

Here are proposals for all base manuals, sometimes with alternatives in 
brackets.

t3extbase (t3extbasefluid?)
t3admin
t3security
t3l10n
t3install
t3editors
t3cgl
t3api
t3fal
t3inside
t3skinning
t3tca
t3tsconfig
t3services
t3tsref
t3ts (t3tssyntax?)
t3quickstart
t3templating
t3ts45

I haven't include the correspondence with the manual full names, in 
order to check if the keys seem explicit enough ;-)

What do you think?

-- 

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


More information about the TYPO3-project-documentation mailing list