Come scrivere una guida

Gio, 23/06/2011 - 17:16

Come scrivere una guida

Inviato da Sarkiapone 0 commenti

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:

Introduzione

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:

Questo è un riquadro. Questo potrebbe essere del codice.

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:

ATTENZIONE! Non rispondo di eventuali danni.

RIQUADRO NOTA

Il riquadro nota è una parte che indica una nota dell'autore:
<div class="nota">Questa è una nota</div>

Il risultato sarà questo:

Questa è una nota

RIQUADRO SUGGERIMENTO

Il riquadro suggerimento è una parte che indica una nota dell'autore:
<div class="tip">Questo è un suggerimento</div>

Il risultato sarà questo:

Questo è un suggerimento