[TYPO3-doc] Building reference index /w sphinx and ReST

Xavier Perseguers xavier at typo3.org
Tue May 20 18:36:12 CEST 2014


Hi,

>> Well, as said before I'm new to ReST and think this is a typical
>> beginner's error when reworking an already existing text.
> 
> IMHO both reference labels should be keep at their place. Of course 
> references inside the document should be changed, but their are also links 
> from the outside which should keep working.
> 
> 
> [untested, but to get the idea across]
> 
> .. _installing-typo3-cms-base-system:
> .. _getting-the-introduction-package:
> 
> Installing TYPO3 CMS base system
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In fact! Just as we keep old labels in ll-XML/XLIFF in order for older
versions of TYPO3 to still get their labels translated, we must ensure
cross-linking (intersphinx) is stable. As such, a user who cross-linked
once to some section should not have to update his own project to get an
updated link, that's the whole point of cross-linking with intersphinx
versus cross-linking with hard-coded URIs.

So Philipp got it right, you should never remove a label but keep it (or
move it at some other place of course) and introduce new labels if it
makes sense (just as you did to better reflect the renamed chapter).

Cheers

-- 
Xavier Perseguers
TYPO3 CMS Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org



More information about the TYPO3-project-documentation mailing list