Spostamenti automatici nella documentazione

Come regola generale, è preferibile evitare, all'interno della documentazione di TeXmacs, il ricorso a testi lunghi e molto articolati, cercando di scrivere invece documenti brevi e su argomenti ben precisi. In una seconda fase conviene predisporre dei “meta file” di aiuto per agevolare gli spostamenti automatici da una parte all'altra della documentazione. Questa strategia consente, tra l'altro, di riutilizzare una stessa pagina del manuale in ambienti diversi (manuale stampato, tutorial sul web, ecc...).

Lo stile tmdoc prevede la definizione di tre possibili macro per indicare come spostarsi all'interno della documentazione. La macro traverse viene usata per racchiudere regioni di testo che contengono informazioni trasversali. La macro branch indica una pagina di aiuto considerata come una sottosezione e la macro continue indica una pagina che segue. Sia la macro branch che la macro continue hanno per riferimento due argomenti. Il primo argomento descrive il link mentre il secondo fornisce l'indirizzo fisico della pagina a cui il link si riferisce.

Tipicamente al termine di un meta file di aiuto si troveranno numerose macro di tipo branch o continue all'interno di una macro di tipo traverse. All'inizio del documento il titolo viene specificato utilizzando la macro tmdoc-title. Nel momento in cui si desidera generare un manuale stampato la struttura titolo-capitolo-sezione-paragrafo verrà automaticamente generata, a partire da tutte le informazioni contenute in questo ambiente di macro. In alternativa è possibile generare dei bottoni addizionali per consentire la navigazione all'interno del documento, utilizzando un qualsiasi browser.