Aiuto:Scheletro di nuova guida
| Linee guida su come contribuire al Wiki |
|
Sommario |
Questa pagina di aiuto è pensata come aiuto per chi volesse scrivere una nuova guida, mostrando un modello di possibile guida da cui partire.
Si articola in due parti:
- la prima mostra il contenuto in una casella di testo, da copiare e incollare, utilizzabile come guida nella stesura della propria guida, con note di commento per aiutare in ogni passaggio (non produrranno alcun risultato, ma si consiglia di rimuoverli, una volta ultimata la parte interessata dagli stessi);
- la seconda di anteprima mostra il risultato che si otterrà a schermo, una volta che si è salvata la pagina oppure si è scelto di visualizzarne l'anteprima.
Ecco di seguito la prima parte.
La struttura delle sezioni è puramente indicativa, per software che richiede installazione, ma nulla toglie che si possa scrivere una guida anche sulla risoluzione di problemi comuni, sull'installazione del sistema stesso, su configurazioni del software già disponibile nel sistema, su script personali o perfino delle guide teoriche su argomenti riguardanti l'informatica e il Software Libero.
Si raccomanda di utilizzare il pulsante Visualizza anteprima prima di inviare la propria guida, e di effettuare salvataggi regolari (anche offline in caso di guide molto lunghe, copiando su un editor di testo il contenuto, per evitare perdite di dati).
Scheletro:
<!-- (INIZIO NOTA DI COMMENTO) Scrivere la riga:
{{Non-free}}
prima di tutto il resto, in caso la guida non riguardi software libero. (FINE NOTA DI COMMENTO) -->
{{Stub}} <!-- NOTA: rimuovere questa riga una volta completata la guida -->
{{Versioni compatibili|bookworm}} <!-- NOTA: scrivere la versione usata come riferimento per la guida -->
<!-- NOTA2: si ricordi che per testing/trixie e unstable/Sid va utilizzata una diversa sintassi
(testing_2024 e unstable_2024, rispettivamente, al posto dei codename; utilizzando l'anno corrente)-->
<!-- NOTA: Verrà creata in automatico la tabella delle sezioni a inizio pagina con i nomi delle ==sezioni== e delle ===sottosezioni===, se in numero sufficiente. -->
== Introduzione ==
Sezione introduttiva con link ad altre guide o voci di glossario su questo wiki, riportando il titolo tra doppie parentesi quadre
(per esempio [[apt]], [[root]], ecc... )
Una guida non dovrebbe mai essere isolata, rimandando nell'introduzione o nella sezione conclusiva ad altre pagine.
In caso di problemi di sicurezza o seri rischi, è possibile utilizzare il template {{Warningbox | avviso }}
per dare evidenza al messaggio d'avviso.
Per le spaziature verticali lasciare una riga vuota per un nuovo paragrafo, o altrimenti utilizzare il tag br. <br/> Questa parte andrà su una nuova riga.
Invece un semplice "a capo" verrebbe ignorato.
== Installazione ==
Con [[privilegi di amministrazione]]:
<pre>
# apt install ...
</pre>
<!-- NOTA: utilizzare <pre>...</pre> per riportare comandi o contenuti di file;
e utilizzare il carattere di prompt "#" se sono richiesti privilegi,
mentre "$" o nessun carattere altrimenti -->
Indicare almeno i pacchetti da installare, in caso la guida riguardi software esterno, o il modo per installarlo.
== Configurazione ==
File di configurazione <code>/etc/...</code>: <!-- NOTA: usare <code>...</code> per riportare nomi di file o di comandi -->
<pre>
Contenuto di default
</pre>
Breve descrizione delle righe principali. Si può dare risalto a una '''voce''' racchiudendola tra tripli apici per renderla in grassetto.
Si può utilizzare il template {{Cautionbox | avviso}} <!-- NOTA: o perfino {{Warningbox | avviso}}, nei casi più gravi -->
se si vuole far prestare attenzione a una parte, perché importante per la sicurezza.
Oppure anche {{Suggerimento | suggerimenti }}
per dare suggerimenti o ancora {{Box | titolo | testo}}
per delle note di approfondimento.
=== caso 1 (sottosezione configurazione) ===
Descrizione caso 1
<pre>
Contenuto righe da modificare
</pre>
=== caso 2 ===
...
== Utilizzo ==
Sintassi:
<pre>
$ comando --opzione1 --opzione2 --opzione3 --opzione4 ...
</pre>
Dove:
<!-- NOTA: verrà creato un elenco con le opzioni (tra ";" e ":") in grassetto e il resto in un sottoparagrafo rientrante:
questo è quindi lo strumento ideale per descrivere la sintassi dei comandi.
Per descrizioni molto lunghe è possibile andare a capo e utilizzare ":" a inizio riga per creare la stessa spaziatura orizzontale;
ciò consente anche di descrivere gli argomenti di un'opzione in modo annidato, facendo precedere il tag ";" da ":" . -->
Dove:
; --opzione1 : descrizione opzione 1;
; --opzione2 : descrizione opzione 2.
: Nuovo paragrafo descrizione dell'opzione 2 con la stessa spaziatura orizzontale.
; --opzione3 : descrizione opzione 3 con dettagli su:
:; argomento1 : descrizione dell'argomento 1 (dell'opzione 3);
:; argomento2 : descrizione dell'argomento 2 (dell'opzione 3);
; --opzione4 : descrizione opzione 4;
...
=== Esempi ===
Breve descrizione esempio 1:
<nowiki><pre>
$ comando ...
</pre>
Breve descrizione esempio 2 (se richiede privilegi, con "#"):
<pre>
# comando ...
</pre>
== Approfondimenti ==
<!-- NOTA: elenco puntato; usare # per quello numerato; per esempio se si fanno riferimenti nella guida agli approfondimenti -->
* [https://URL Nome da dare al link] <!-- NOTA: singolo [ ] per link esterni e titolo dopo uno *spazio* -->
* [[titolo pagina wiki | Nome del link]] <!-- NOTA: doppio [[ ]] e titolo dopo "|" per pagine di questo wiki -->
* Pagina manuale: <code>man ...</code> <!-- NOTA: semplici comandi possono essere riportati sulla stessa riga con tag <code> -->
<!-- NOTA: "~~~~" ('Alt_Gr' + 'ì' su tastiera italiana) sarà sostituito in automatico con il proprio nome utente e l'ora di invio -->
{{Autori
|Autore=~~~~
}}
<!-- NOTA: scegliere delle categorie da inserire a fondo pagina (al posto di "nome categoria #"), per permetterne la ricerca; l'elenco completo è consultabile nella pagina "http://guide.debianizzati.org/index.php?title=Lista_Categorie" e ogni guida deve averne almeno una. -->
[[Categoria:nome categoria 1]][[Categoria:nome categoria 2]]
Anteprima:
|
Attenzione: questo articolo è ancora incompleto e in fase di scrittura da parte del suo autore.
Sentitevi liberi di contribuire, proponendo modifiche alla guida tramite l'apposita pagina di discussione, in modo da non interferire con il lavoro portato avanti sulla voce. Per altre informazioni si rimanda al template. |
 Versioni Compatibili Debian 12 "bookworm" |
Introduzione
Sezione introduttiva con link ad altre guide o voci di glossario su questo wiki, riportando il titolo tra doppie parentesi quadre (per esempio apt, root, ecc... )
Una guida non dovrebbe mai essere isolata, rimandando nell'introduzione o nella sezione conclusiva ad altre pagine.
In caso di problemi di sicurezza o seri rischi, è possibile utilizzare il template
|
ATTENZIONE avviso |
per dare evidenza al messaggio d'avviso.
Per le spaziature verticali lasciare una riga vuota per un nuovo paragrafo, o altrimenti utilizzare il tag br.
Questa parte andrà su una nuova riga.
Invece un semplice "a capo" verrebbe ignorato.
Installazione
Con privilegi di amministrazione:
# apt install ...
Indicare almeno i pacchetti da installare, in caso la guida riguardi software esterno, o il modo per installarlo.
Configurazione
File di configurazione /etc/...:
Contenuto di default
Breve descrizione delle righe principali. Si può dare risalto a una voce racchiudendola tra tripli apici per renderla in grassetto.
Si può utilizzare il template
|
Avvertimento avviso |
se si vuole far prestare attenzione a una parte, perché importante per la sicurezza.
Oppure anche
|
Suggerimento suggerimenti |
per dare suggerimenti o ancora
|
titolo testo |
per delle note di approfondimento.
caso 1 (sottosezione configurazione)
Descrizione caso 1
Contenuto righe da modificare
caso 2
...
Utilizzo
Sintassi:
$ comando --opzione1 --opzione2 --opzione3 --opzione4 ...
Dove:
- --opzione1
- descrizione opzione 1;
- --opzione2
- descrizione opzione 2.
- Nuovo paragrafo descrizione dell'opzione 2 con la stessa spaziatura orizzontale.
- --opzione3
- descrizione opzione 3 con dettagli su:
- argomento1
- descrizione dell'argomento 1 (dell'opzione 3);
- argomento2
- descrizione dell'argomento 2 (dell'opzione 3);
- --opzione4
- descrizione opzione 4;
...
Esempi
Breve descrizione esempio 1:
$ comando ...
Breve descrizione esempio 2 (se richiede privilegi, con "#"):
# comando ...
Approfondimenti
- Nome da dare al link
- Nome del link
- Pagina manuale:
man ...
| Guida scritta da: HAL 9000 16:44, 30 nov 2019 (CET) | 
Debianized 20% |
| Estesa da: | |
| Verificata da: | |
|
Verificare ed estendere la guida | Cos'è una guida Debianized | |