Nel testo della guida non inserite faccine, commenti bizzarri, ciauz, byez, tvb, tvtb o quant'altro, attenetevi ad un testo formale ed in italiano corrente.
La guida deve essere scritta come testo semplice, senza nessun tag html. Lasciando una riga vuota il testo và a capo automaticamente,
Per evidenziare parti importanti del testo sono disponibili dei tag speciali, li elenchiamo di seguito, all'interno dei tag speciali è possibile usare tranquillamente BBcode:
TITOLO
Il titolo si una sezione o paragrafo che vogliamo evidenziare deve essere scritto così:
<div class="Titolo">Introduzione</div>
Il risultato sarà questo:
COMANDI IN TERMINALE
I comandi per eseguire delle operazioni da terminale devono essere evidenziati così:
[ code lang="bash" ] $ ls -l [ /code ]
(rimuovere gli spazi all'interno del tag code)
Il risultato sarà questo:
$ ls -l
CODICE
Il codice deve essere stampato all'interno del tag code, la sintassi e' questa:
[ code lang="php" ] foreach ($action_ids as $action_id) { if (is_numeric($action_id)) { $conditions[] = $action_id; } elseif (isset($available_actions[$action_id])) { $actions[$action_id] = $available_actions[$action_id]; } } [ /code ]
(rimuovere gli spazi all'interno del tag code)
Il risultato sarà questo:
foreach ($action_ids as $action_id) { if (is_numeric($action_id)) { $conditions[] = $action_id; } elseif (isset($available_actions[$action_id])) { $actions[$action_id] = $available_actions[$action_id]; } }
I linguaggi supportati sono questi: bash, c cpp, drupal5, drupal6, cmdline, java, javascript, php, python, ruby, xorg
Per attivarli, usare la sintassi mostrata nell'esempio e sostituire "php" con il linguaggoi desiderato, di default la sintassi e' abilitata su BASH.
RIQUADRO
Il riquadro è una parte che evidenzia un testo o un'immagine:
<div class="riquadro">Questo è un riquadro. Questo potrebbe essere del codice</div>
Il risultato sarà questo:
RIQUADRO DI AVVISO
Il riquadro di avviso è una parte che indica un avvertimento o un passaggio importante della guida:
<div class="attenzione">ATTENZIONE! Non rispondo di eventuali danni.</div>
Il risultato sarà questo:
RIQUADRO NOTA
Il riquadro nota è una parte che indica una nota dell'autore:
<div class="nota">Questa è una nota</div>
Il risultato sarà questo:
RIQUADRO SUGGERIMENTO
Il riquadro suggerimento è una parte che indica una nota dell'autore:
<div class="tip">Questo è un suggerimento</div>
Il risultato sarà questo:
Commenti
Inviato da Suse98 il Ven, 15/04/2011 - 18:37.
Re: Come scrivere una guida
Ottimo !
Così nessuno sbaglierà a scrivere le guide !
HP - Gaming OMEN 15-ek0015nl Notebook
Intel Core i7-10750, Nvidia GeForce RTX 2060 6GB, 32GB RAM, 500GB SSD M2 + 2TB Sabrend SSD M2
Inviato da Gollum il Mer, 22/06/2011 - 22:54.
Re: Come scrivere una guida
@Suse98

Già come no, io sono di quelli
Desktop DELL XPS8100 => openSUSE_12.2 => KDE 4.10 => Core i7 => 3.4.28-2.20 => Nvidia GT220

Notebook Sony Vaio VPPCA =>openSUSE_12.2 => KDE 4.10 => Core i5 => 3.4.28-2.20 => AMD HD 6470M