Convenzioni e nomi dei file

La documentazione viene organizzata in funzione dell'argomento all'interno di un albero di directory. Le sottodirectory della directory principale sono le seguenti:

devel

documentazione per sviluppatori;

examples

esempi di documenti in TeXmacs;

incoming

documentazione in stato embrionale;

main

documentazione principale;

meta

come scrivere documentazione e come compilarla.

Come indicazione generale si cerca di mantenere il numero di file per directory ragionevolmente ridotto.

I nomi dei file nella directory principale (main) hanno la forma tipo-nome.lingua.tm. Nelle altre directory la forma è nome.lingua.tm. Con tipo si intende un'indicazione di massima riguardante la caratteristica generale della documentazione come:

adv

documentazione per utilizzatori esperti;

man

documentazione per il manuale di TeXmacs;

tut

documentazione per il tutorial di TeXmacs.

La documentazione riferita ad uno stesso argomento viene tenuta unita, indipendentemente dal tipo. In questo modo risulta più semplice trovare parti di documentazione esistente relative ad uno stesso argomento. Può accadere inoltre che parti della documentazione inizialmente scritte per il tutorial vengano inserite nel manuale o viceversa. La lingua in cui viene redatta la documentazione viene indicata da un codice di due lettere come, ad esempio, en, fr e così via. Il nome di ciascun documento rimane invariato all'interno delle traduzioni nelle diverse lingue. Così, ad esempio, il documento man-keyboard.en.tm, una volta tradotto in francese, non diviene man-clavier.fr.tm. ma semplicemente man-keyboard.fr.tm.