2010-09-21 4 views
8

Voglio creare una sezione "terminologia" con definizioni di termini che sto usando in modo tale che ogni volta che utilizzo i termini in questa sezione di terminologia, viene creato un collegamento che punta alla definizione.In Sfinge, come posso creare una sezione "terminologica" collegabile senza sovraccarico?

Attualmente, il meglio che posso pensare a è:

.. |flavor| replace:: `:ref:flavor` 

.. _flavor: 

flavor 
------ 
blah blah blah 

Poi più tardi, nell'altro testo che devo fare:

''' This is a usage of the word |flavor|.''' 

trovo la sintassi di cui sopra per essere molto ingombrante. So che potrei usare un ulteriore livello di scripting o di m4 per generare automaticamente questa sintassi, ma spero ci sia un modo migliore ..

risposta

20

Non molto diverso, ma è possibile utilizzare:

.. glossario ::

Questa direttiva deve contenere un elenco di definizioni RST con termini e definizioni. Le definizioni saranno quindi referenziabili con il ruolo "termine".

: termine:

riferimento ad un termine nel glossario. Il glossario viene creato utilizzando la direttiva glossario contenente un elenco di definizioni con termini e definizioni. Non deve essere nello stesso file del termine markup, per esempio i documenti Python hanno un glossario globale nel file glossary.rst.

Se si utilizza un termine non spiegato in un glossario, verrà visualizzato un avviso durante la compilazione.

[incollato da official sphinx documentation]

+0

Credo should'a consultato il thesaurus per trovare una parola diversa per "terminologia" quando si cerca la documentazione sfinge. Grazie eolo999. –