Introduzione
All'interno del wiki sono state introdotte alcune regole per uniformare lo stile delle pagine che compongono la documentazione. Nella seguente pagina è presente un breve elenco delle regole più frequenti.
Se si ha la necessità di trovare informazioni più dettagliate sul frasario o sui formati del testo, può essere consultata la pagina RegoleStilistiche, un grande archivio di informazioni raccolte e aggiornate negli anni dagli editori del wiki.
In generale
Alcune indicazioni sul come scrivere una pagina:
Scrivere in italiano: utilizzare al meglio delle proprie possibilità le regole della lingua italiana.
Scrivere in modo impersonale: evitare espressioni come "installa il programma", "copia il testo", "scarica il file". Bensì utilizzare espressioni come "installare il programma", "copiare il testo", "scaricare il file".
Scrivere in modo conciso: trattandosi di documentazione tecnica, per fare in modo che i passaggi da eseguire risultino quanto più chiari, è preferibile evitare periodi eccessivamente lunghi. Spesso può essere utile l'utilizzo di elenchi puntati/numerati per schematizzare i passaggi.
Sfruttare le guide esistenti: piuttosto che duplicare sulla propria guida una procedura presente in un'altra pagina, è preferibile inserire un link alla guida esistente.
Frasi di uso comune
Segue un elenco di esempi riguardanti le frasi più frequentemente utilizzate.
Installare un programma
Esempio:
Installare il pacchetto amule-adunanza.
[[AmministrazioneSistema/InstallareProgrammi|Installare]] il pacchetto [[apt://amule-adunanza | amule-adunanza]].
Utilizzando questa forma si mettono a disposizione le comode funzionalità di AptURL e si offre un link alle diverse modalità di installazione dei programmi senza doverle rispiegare.
Avviare un programma
Esempio:
Avviare il programma dal menù Applicazioni → Internet → Broser web Chromium.
Avviare il programma dal menù '''''Applicazioni → Internet → Broser web Chromium'''''.
oppure:
Il programma sarà disponibile nel menù Applicazioni → Internet → Broser web Chromium.
Ovviamente le frasi possono essere riadattate a seconda del contesto.
Comandi da terminale
Esempio:
Digitare i seguenti comandi in una finestra di terminale:
Digitare i seguenti comandi in una finestra di [[AmministrazioneSistema/RigaDiComando|terminale]]:
Editor di testo
Esempio:
Aprire con i privilegi di amministrazione e con un editor di testo il file /etc/security/limits.conf
Aprire con i [[AmministrazioneSistema/Sudo|privilegi di amministrazione]] e con un [[Ufficio/EditorDiTesto|editor di testo]] il file `/etc/security/limits.conf`
Formato dei nomi
Segue un elenco dei formati utilizzati per indicare nomi di programmi, file, pacchetti, ecc..
Nomi dei programmi
Grassetto, esempio:
In questa guida viene spiegato come modificare Firefox.
In questa guida viene spiegato come modificare '''Firefox'''.
Nomi dei pacchetti
Corsivo, esempio:
il pacchetto bcmwl-kernel-source può essere reperito nella cartella...
il pacchetto ''bcmwl-kernel-source'' può essere reperito nella cartella...
Nomi di file/cartelle
Larghezza fissa, esempio:
spostarsi nella cartella /usr/share/doc
spostarsi nella cartella `/usr/share/doc`
Voce di menù
Grassetto, esempio:
Selezionare il menù Modifica.
Selezionare il menù '''Modifica'''.
Percorso dei menù
Corsivo + grassetto, esempio:
Selezionare il menù Visualizza → Disponi oggetti → Per nome .
Selezionare il menù '''''Visualizza → Disponi oggetti → Per nome '''''.
Nomi delle estensioni
Larghezza fissa, esempio:
Salvare il pacchetto .deb
Salvare il pacchetto `.deb`
