Guide@Debianizzati.Org

Aiuto:Scheletro di nuova guida

Versione del 30 nov 2019 alle 16:01 di HAL 9000 (discussione | contributi) (stub incluso)

Ecco di seguito un esempio di nuova guida, che si può copiare e incollare quando si volesse crearne una.

Verrà creata in automatico la tabella delle sezioni a inizio pagina con i nomi delle == sezioni == e delle === sottosezioni ===, se in numero sufficiente.

Si ricordi di:

  • scrivere {{Non-free}} prima di tutto il resto, in caso la guida non riguardi Software Libero;
  • modificare {{Versioni compatibili|...}} con la versione di Debian usata come riferimento per la guida (con prima lettera Maiuscola), se diversa;
    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 ovviamente l'anno corrente);
  • scegliere delle categorie ([[Categoria:...]]) da inserire a fondo pagina, per permetterne la ricerca; l'elenco completo è consultabile nella Lista Categorie, e ogni guida deve averne almeno una;
  • rimuovere l'iniziale {{Stub}} quando la guida si considera conclusa e tutti i commenti di questo esempio (<!-- ... -->).
{{Stub}}{{Versioni compatibili|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 {{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 ...
</pre>
Dove:
<!-- NOTA: verrà creato un elenco puntato con le opzioni (tra ";" e ":") in grassetto: questo è quindi lo strumento ideale per descrivere la sintassi dei comandi -->
; --opzione1 : descrizione;
; --opzione2 : ... ;
...

=== Esempi ===
Breve descrizione esempio 1:
<pre>
$ comando ...
</pre>

Breve descrizione esempio 2 (se richiede privilegi, con "#"):
<pre>
# comando ...
</pre>

== Approfondimenti ==
<!-- NOTA: elenco puntato; usare # per quello numerato -->
* [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> -->

{{Autori
|Autore=~~~~
}}

[[Categoria:nome categoria 1]][[Categoria:nome categoria 2]]


Restituirà a schermo quanto segue, una volta salvata la pagina:


Document-page-setup.png 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.


Debian-swirl.png 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 ...

Dove:

--opzione1
descrizione;
--opzione2
... ;

...

Esempi

Breve descrizione esempio 1: 

$ comando ...

Breve descrizione esempio 2 (se richiede privilegi, con "#"): 

# comando ...

Approfondimenti



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

Estratto da "https://guide.debianizzati.org/index.php?title=Aiuto:Scheletro_di_nuova_guida&oldid=43570"