Usare lo stile tmdoc

Oltre alle macro relative alle informazioni sul copyright e agli spostamenti all'interno della documentazione di cui abbiamo parlato in precedenza, lo stile tmdoc offre un certo numero di macro e di funzioni che, se necessario, possono essere di volta in volta attivate:

key

questa macro viene utilizzata per indicare comandi da tastiera come C-x C-s. Le macro specializzate kbd-gen, kbd-text, kbd-math, kbd-symb, kbd-big, kbd-large, kbd-ia, kbd-exec e kbd-table vengono utilizzate per comandi da tastiera corrispondenti ad uno specifico tipo di azione o di modalità. Ad esempio, kbd-math corrisponde al comando da tastiera per l'inserimento di espressioni matematiche come A-f che indica l'inizio di una frazione.

menu

questa funzione, che si riferisce ad un arbitrario numero di argomenti, permette di scrivere dei menu come File o Documento→Lingua. La funzione esegue automaticamente la traduzione delle voci del menu che vengono inserite.

markup

questa macro viene utilizzata per indicare macro o funzioni come section.

tmstyle

questa macro indica il nome di un file di stile di TeXmacs come article.

tmpackage

questa macro indica il nome di un pacchetto TeXmacs come ad esempio il pacchetto std-markup.

tmdtd

questa macro indica il nome di un TeXmacs d.t.d. come number-env.

Osserviamo che nessun nome di macro deve essere tradotto in lingua straniera! Oltre a questo si ricorda di non tradurre mai le voci dei menu, le quali vengono tradotte automaticamente in modo da garantire la sincronizzazione tra la traduzione dei manuali e la localizzazione dei menu di TeXmacs. Nel caso di marcatori, stili e pacchetti d.t.d., è importante non alterarne il nome originale in quanto, il più delle volte, esso corrisponde al nome di un file.

Le seguenti macro e funzioni, pensate per realizzare link e per gestire gli indici, verranno implementate in futuro:

simple-link

questa macro ha come argomento un hyperlink URL x, dove x rappresenta nome e destinazione dell'hyperlink;

hyper-link

questa macro definisce un normale hyperlink;

concept-link

questa macro ha come argomento un concetto. Successivamente potrebbe essere creato automaticamente un appropriato hyperlink a partire da essa e da altra documentazione;

only-index

indice di una stringa;

def-index

definizione di un nuovo concetto: il testo viene scritto in italico e indicizzato;

re-index

comparsa di un concetto definito in precedenza: il testo viene scritto in roman e inserito nell'indice.

In conclusione elenchiamo i seguenti tag di uso frequente:

icon

link ad una icona in una directory centrale come $TEXMACS_PATH/doc/images/pixmaps

screenshot

link a una schermata. Le schermate sono attualmente contenuta nella directory centrale $TEXMACS_PATH/doc/images/screenshots

scheme

il linguaggio Scheme;

cpp

il linguaggio C++;

framed-fragment

per visualizzare una parte di codice in un riquadro;

scheme-fragment

per un codice Scheme multi-paragrafo;

cpp-fragment

per un codice C++ multi-paragrafo;

tm-fragment

per una parte di codice TeXmacs in formato Scheme;

scheme-code

per una parte di codice Scheme;

cpp-code

per una parte di codice C++;

descriptive-table

per tavole descrittive che possono essere utilizzate per realizzare liste di comandi da tastiera, di marcatori, ecc....

Lo stile tmdoc eredita numerose macro dallo stile generic percui, se necessario, è possibile utilizzare macro come em, verbatim, itemize, e così di seguito.