Aiuto:Scheletro di nuova guida: differenze tra le versioni

estesa e integrata nel menù delle linee guide
m (rimossa categoria Stub)
(estesa e integrata nel menù delle linee guide)
Riga 1: Riga 1:
Ecco di seguito un esempio di nuova guida, che si può copiare e incollare quando si volesse crearne una.
{{Help}}


Verrà creata in automatico la tabella delle sezioni a inizio pagina con i nomi delle == sezioni == e delle === sottosezioni ===, se in numero sufficiente.
Questa pagina di aiuto è pensata come aiuto per chi volesse scrivere una nuova guida, mostrando un modello di possibile guida da cui partire.


Si ricordi di:
Si articola in due parti:
* scrivere '''<nowiki>{{Non-free}}</nowiki>''' prima di tutto il resto, in caso la guida '''non''' riguardi [[Software Libero]];
* 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);
* modificare '''<nowiki>{{Versioni compatibili|...}}</nowiki>''' con la versione di Debian usata come riferimento per la guida (con prima lettera '''''M'''aiuscola''), se diversa; <br/>si ricordi che per testing/{{Codename|Testing}} e unstable/Sid va utilizzata una diversa sintassi (<code>Testing_{{CURRENTYEAR}}</code> e <code>Unstable_{{CURRENTYEAR}}</code>, rispettivamente, al posto dei [[Codename]]; utilizzando ovviamente l'anno corrente);
* 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.<br/> Si raccomanda di utilizzare il pulsante '''Visualizza anteprima''' prima di inviare la propria guida, e di effettuare salvataggi regolari (anche offline, copiando su un editor di testo il contenuto, per evitare perdite di dati).
* scegliere delle categorie ('''<nowiki>[[Categoria:...]]</nowiki>''') 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 '''<nowiki>{{Stub}}</nowiki>''' quando la guida si considera conclusa e tutti i commenti di questo esempio ('''<nowiki><!-- ... --></nowiki>''').


  <nowiki>{{Stub}}{{Versioni compatibili|</nowiki>{{Codename|Stable}}<nowiki>}}</nowiki>
<br/><br/><hr/><br/>
 
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]].
 
<br/><hr/>
'''<big>Scheletro:</big>'''
<hr/>
 
  <nowiki><!-- (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|</nowiki>{{Codename|Stable}}<nowiki>}} <!-- NOTA: scrivere la versione usata come riferimento per la guida con prima lettera Maiuscola, se diversa -->
<!--</nowiki> NOTA2: si ricordi che per testing/{{Codename|Testing}} e unstable/Sid va utilizzata una diversa sintassi (Testing_{{CURRENTYEAR}} e Unstable_{{CURRENTYEAR}}, rispettivamente, al posto dei codename; utilizzando l'anno corrente); <nowiki>-->
 
<!-- NOTA: Verrà creata in automatico la tabella delle sezioni a inizio pagina con i nomi delle ==sezioni== e delle ===sottosezioni===, se in numero sufficiente. --></nowiki>
  == Introduzione ==
  == Introduzione ==
  Sezione introduttiva con link ad altre guide o voci di glossario su questo wiki, riportando il titolo tra doppie parentesi quadre
  Sezione introduttiva con link ad altre guide o voci di glossario su questo wiki, riportando il titolo tra doppie parentesi quadre
Riga 58: Riga 74:
  Sintassi:
  Sintassi:
  <nowiki><pre>
  <nowiki><pre>
$ comando --opzione1 --opzione2 ...
$ comando --opzione1 --opzione2 --opzione3 --opzione4 ...
</pre>
</pre>
Dove:
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 -->
<!-- NOTA: verrà creato un elenco con le opzioni (tra ";" e ":") in grassetto e il resto in un sottoparagrafo: questo è quindi lo strumento ideale per descrivere la sintassi dei comandi.
; --opzione1 : descrizione;
          (per descrizioni molto lunghe è possibile andare a capo e utilizzare ":" a inizio riga creare la spaziatura orizzontale;
; --opzione2 : ... ;</nowiki>
            ciò consente anche di descrivere gli argomenti di un'opzione, facendo precedere il tag ";" da ":") -->
...
Dove:
; --opzione1 : descrizione opzione 1;
=== Esempi ===
; --opzione2 : descrizione opzione 2.
Breve descrizione esempio 1:
: Nuovo paragrafo descrizione dell'opzione 2 con la stessa spaziatura.
<nowiki><pre>
; --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 ...
$ comando ...
</pre></nowiki>
</pre></nowiki>
Riga 78: Riga 102:
   
   
  == Approfondimenti ==
  == Approfondimenti ==
  <nowiki><!-- NOTA: elenco puntato; usare # per quello numerato -->
  <nowiki><!-- 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* -->
* [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 -->
* [[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> -->
* 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
{{Autori
|Autore=~~~~
|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]]</nowiki>
[[Categoria:nome categoria 1]][[Categoria:nome categoria 2]]</nowiki>




<hr/>
<hr/>
'''<big>Restituirà a schermo quanto segue, una volta salvata la pagina:</big>'''
'''<big>Anteprima:</big>'''
<hr/>
<hr/>


Riga 105: Riga 131:
|}<br/>
|}<br/>
{{Versioni compatibili|{{Codename|Stable}}}}
{{Versioni compatibili|{{Codename|Stable}}}}
__TOC__
== Introduzione ==
== Introduzione ==
Sezione introduttiva con link ad altre guide o voci di glossario su questo wiki, riportando il titolo tra doppie parentesi quadre
Sezione introduttiva con link ad altre guide o voci di glossario su questo wiki, riportando il titolo tra doppie parentesi quadre
Riga 151: Riga 177:
Sintassi:
Sintassi:
<pre>
<pre>
$ comando --opzione1 --opzione2 ...
$ comando --opzione1 --opzione2 --opzione3 --opzione4 ...
</pre>
</pre>
Dove:
Dove:
; --opzione1 : descrizione;
; --opzione1 : descrizione opzione 1;
; --opzione2 : ... ;
; --opzione2 : descrizione opzione 2.
: Nuovo paragrafo descrizione dell'opzione 2 con la stessa spaziatura.
; --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;
...
...
   
   
3 581

contributi