Guide@Debianizzati.Org

Aiuto:Sintassi

Versione del 14 ott 2021 alle 16:25 di Marcomg (discussione | contributi) (mini-errore in syntaxhighlight table)
(diff) ← Versione meno recente | Versione attuale (diff) | Versione più recente → (diff)
Linee guida su come contribuire al Wiki

Sommario

Indice

L'indice per ciascuna pagina viene creato automaticamente se sono presenti almeno quattro sezioni. Di default compare subito prima della prima sezione inserita.
Per forzare la visualizzazione dell'indice nel caso:

  1. vi siano meno di quattro sezioni
  2. si voglia farlo comparire in un punto specificato della pagina

si può utilizzare la parola magica [1] __TOC__
Se invece si vuole inibire la visualizzazione dell'indice, si può ricorrere alla parola magica __NOTOC__

È possibile nascondere o mostrare l'indice attraverso i link "mostra" e "nascondi" presenti al suo interno. Questa scelta viene ricordata per gli indici presenti nelle altre pagine visualizzate.

Dividere in sezioni

Tipo formattazione Descrizione Sintassi Risultato
Titolo 1 Racchiudere tra =
(non utilizzare all'interno delle pagine in quanto è la formattazione del titolo della guida). 
= Titolo 1 =

 

Titolo 2 Racchiudere tra == 
== Titolo 2 =

 

Titolo 3 Racchiudere tra === 
=== Titolo 3 ===

 

Titolo 4 Racchiudere tra ==== 
==== Titolo 4 ====

 

Titolo 5 Racchiudere tra ===== 
===== Titolo 5 =====

 

Titolo 6 Racchiudere tra ====== 
====== Titolo 6 ======

 

Evitare, se possibile, i titoli 4,5,6; al loro posto utilizzare gli elenchi. Vedere anche le convenzioni sullo stile.

Formattazione di testo

Tipo di formattazione Descrizione Sintassi Risultato
Grassetto Racchiudere il testo tra tre apici 
'''Questo testo è scritto in grassetto'''
 Questo testo è scritto in grassetto
Corsivo Racchiudere il testo tra due apici 
''Questo testo è scritto in corsivo''
 Questo testo è scritto in corsivo
Grassetto-Corsivo Racchiudere il testo tra cinque apici 
'''''Questo testo è scritto in grassetto-corsivo'''''
 Questo testo è scritto in grassetto-corsivo
Sottolineato Racchiudere il testo tra i tag <u> </u> 
<u>Questo testo è sottolineato</u>
 Questo testo è sottolineato
Barrato Racchiudere il testo tra i tag <s> </s> 
<s>Questo testo è barrato</s>
 Questo testo è barrato
Monospace Racchiudere il testo tra i tag <code> </code> 
<code>Questo testo è di tipo monospace</code>
 Questo testo è di tipo monospace
Apice Racchiudere il testo tra i tag <sup> </sup> 
Questo testo ha un <sup>apice</sup>
 Questo testo ha un apice
Pedice Racchiudere il testo tra i tag <sub> </sub> 
Questo testo ha un <sub>pedice</sub>
 Questo testo ha un pedice

Gestione paragrafi

Interruzione di riga

Premendo il tasto [Invio] alla fine di una riga, si otterrà l'effetto di andare a capo solo all'interno dell'editor del Wiki mentre le righe non verranno realmente divise al momento del salvataggio.
Per ottenere l'effetto di interrompere la riga senza interrompere il paragrafo, utilizzare il tag <br/> (break) alla fine della riga.

Esempio Risultato 
Queste due righe.
Non saranno separate
 Queste due righe.Non saranno separate 
Questo due righe.<br/>
Saranno separate.

Oppure (necessario all'interno di elenchi, blocchi indentati o
parametri di template):

Questo due righe.<br/>Saranno separate.
 Queste due righe.
Saranno separate.
Interruzione di paragrafo

Un paragrafo viene interrotto con l'inserimento di una riga vuota. Se possibile, non separare i paragrafi con più righe vuote.

Esempio Risultato 
Questo paragrafo sta per essere interrotto dal paragrafo successivo.<br/>
L'interruzione avverrà con l'inserimento di una riga vuota.

Da qui inizia il secondo paragrafo.
 Questo paragrafo sta per essere interrotto dal paragrafo successivo.

L'interruzione avverrà con l'inserimento di una riga vuota.

Da qui inizia il secondo paragrafo.

Indentazione

Per indentare un paragrafo, farlo precedere da uno o più caratteri di due punti ":"

Esempio Risultato 
:questo paragrafo è rientrato
::questo paragrafo è rientrato (2)<br/>Seconda riga
:::questo paragrafo è rientrato (3)
questo paragrafo è rientrato
questo paragrafo è rientrato (2)
Seconda riga
questo paragrafo è rientrato (3)
Blockquote

Altro modo per indentare un paragrafo è includerlo all'interno dei tag <blockquote> </blockquote>

Esempio Risultato 
<blockquote>
Questo è un esempio<br/>
che mostra in che modo<br/>
indentare il testo<br/>
con il tag "blockquote"
</blockquote>

Questo è un esempio
che mostra in che modo
indentare il testo
con il tag "blockquote"

Formattazione di codice

Particolarmente utile per mettere in evidenza linee di codice, contenuto di file, comandi e il loro output.
Per crearlo è possibile ricorrere a due metodi:

  • racchiudere il testo tra i tag <pre> </pre>
  • fare in modo che la riga inizi con uno spazio

Questi due metodi producono lo stesso risultato (si noti lo spazio iniziale nel secondo esempio):

Esempio Risultato 
<pre>prova di testo</pre>
 
prova di testo
 prova di testo

Il primo metodo, ossia l'utilizzo dei tag <pre> </pre>, è preferibile in quanto consente una sua facile individuazione all'interno del codice della pagina. Lo svantaggio è quello di non permettere formattazioni del testo contenuto al loro interno.
Quindi, nel caso in cui si debba utilizzare testo con una particolare formattazione (corsivo, grassetto, testo colorato), è necessario far ricorso al secondo metodo.
Questi esempi chiariscono meglio i due metodi (notare ancora lo spazio iniziale nel secondo e terzo esempio):

Esempio Risultato 
<pre>'''nonostante il triplo apice, il testo non sarà visualizzato in grassetto'''</pre>
 
'''nonostante il triplo apice, il testo non sarà visualizzato in grassetto'''
 Con lo spazio iniziale, il triplo apice consente un testo in '''grassetto'''

Con lo spazio iniziale, il triplo apice consente un testo in grassetto 

 ... oppure un testo colorato in <span style="color:red">rosso</span>

... oppure un testo colorato in rosso

Nel caso si vogliano inserire diverse linee di codice con il tag 'pre' in un elenco, si deve utilizzare necessariamente un carattere di interruzione di linea (line feed) scrivendo come sempre ogni singolo elemento su un'unica riga:

Esempio Risultato 
* Primo elemento della lista
* Secondo elemento della lista con tag 'pre'<pre>Linea di codice</pre>
* Terzo elemento della lista con tag 'pre' e codice multiriga<pre>prima linea di codice&#10;seconda linea di codice</pre>
  • Primo elemento della lista
  • Secondo elemento della lista con tag 'pre'
    Linea di codice
  • Terzo elemento della lista con tag 'pre' e codice multiriga
    prima linea di codice
seconda linea di codice

A tal proposito, leggere anche il paragrafo relativo ai codici HTML.

Evidenziazione della sintassi con GeSHi

Particolarmente utile per evidenziare la sintassi di codice dei linguaggi di programmazione.

Per utilizzarlo è sufficiente racchiudere il codice da evidenziare all'interno di 

<syntaxhighlight lang="codelang" line='line'></syntaxhighlight>

dove al posto di codelang è stato inserito il nome del linguaggio di programmazione.

Attributi

Il comando mette a disposizione differenti attributi

Attributo Funzione Esempio Risultato
lang="name" Questo attributo definisce quale analizzatore lessicale deve essere utilizzato. Questo attributo cambia come l'estensione evidenzierà il codice sorgente.

Per un elenco completo dei linguaggi supportati vedere la pagina ufficiale di pygments. 

<syntaxhighlight lang="python">
def quick_sort(arr):
   less = []
   pivot_list = []
   more = []
   if len(arr) <= 1:
       return arr
</syntaxhighlight>
 
def quick_sort(arr):
    less = []
    pivot_list = []
    more = []
    if len(arr) <= 1:
        return arr
line Questo attributo attiva la numerazione di linea. 
<syntaxhighlight lang="python" line>
def quick_sort(arr):
   less = []
   pivot_list = []
   more = []
   if len(arr) <= 1:
       return arr
</syntaxhighlight>
 
def quick_sort(arr):
    less = []
    pivot_list = []
    more = []
    if len(arr) <= 1:
        return arr
inline Questo attributo indica che il codice sorgente deve essere inserito in linea con il paragrafo (e non in un blocco a parte). 
<syntaxhighlight lang="python" inline>
lambda x: x * 2
</syntaxhighlight>
 lambda x: x * 2
start Questo attributo, da utilizzare in combinazione con l'attributo line, definisce quale deve essere il primo numero dal quale contare le linee di codice, per esempio line start="55" farà sì che le linee inizino a contare dalla riga 55. 
<syntaxhighlight lang="python" line start="55">
def quick_sort(arr):
   less = []
   pivot_list = []
   more = []
   if len(arr) <= 1:
       return arr
</syntaxhighlight>
 
def quick_sort(arr):
    less = []
    pivot_list = []
    more = []
    if len(arr) <= 1:
        return arr
highlight Questo attributo specifica una o più linee che devono essere marcate, evidenziandole con un differente colo di sfondo. Si possono anche specificare più linee separate da virgole (se linee separate) highlight="1,4,8" o da un trattino highlight="5-7" se è necessario evidenziare un certo range di linee. 
<syntaxhighlight lang="python" line start=3 highlight="1,5-7">
def quick_sort(arr):
   less = []
   pivot_list = []
   more = []
   if len(arr) <= 1:
       return arr
</syntaxhighlight>
 
def quick_sort(arr):
    less = []
    pivot_list = []
    more = []
    if len(arr) <= 1:
        return arr
style Questo attributo permette di specificare un particolare stile al blocco, per esempio style="border:3px dashed blue" per avere il blocco riquadrato da un bordo distante 3 pixel tratteggiato di blu. 
<syntaxhighlight lang="python" style="border:3px dashed blue">
def quick_sort(arr):
   less = []
   pivot_list = []
   more = []
   if len(arr) <= 1:
       return arr
</syntaxhighlight>
 
def quick_sort(arr):
    less = []
    pivot_list = []
    more = []
    if len(arr) <= 1:
        return arr

Elenchi

Elenco puntato

Permette di ottenere elenchi o sotto-elenchi di voci.
Ciascuna voce è preceduta da uno o più "*"

Esempio Risultato 
*uno
*due
**tre
*quattro<br/>cinque
**sei
***sette
  • uno
  • due
    • tre
  • quattro
    cinque
    • sei
      • sette

Elenco numerato

Permette di ottenere elenchi o sotto-elenchi di voci.
Ciascuna voce è preceduta da uno o più "#"

Esempio Risultato 
#uno
#due
##tre
#quattro<br/>cinque
##sei
###sette
  1. uno
  2. due
    1. tre
  3. quattro
    cinque
    1. sei
      1. sette

Descrizione

Permette l'inserimento di una descrizione per una determinata voce.

Esempio Risultato 
;Titolo: Qui può essere inserita una descrizione.<br/>Seconda riga.
Titolo
Qui può essere inserita una descrizione.
Seconda riga.

Elenco annidato

È possibile annidare elenchi puntati e numerati combinando le diverse sintassi.

Esempio Risultato 
# Elenco numerato
#* Sotto-elenco puntato
#*# Sotto-sotto-elenco numerato
  1. Elenco numerato
    • Sotto-elenco puntato
      1. Sotto-sotto-elenco numerato

Link

Link interno al Wiki

Per inserire un link ad una pagina interna al Wiki, basta inserirne il nome esatto (attenzione alle maiuscole/minuscole) all'interno delle doppie parentesi quadre [[ ]] . I link verso pagine non esistenti saranno colorati di rosso e saranno tutti visibili nelle guide richieste per permettere anche ad altri la loro ricerca e creazione.
È possibile anche avere un link visualizzato con un titolo generico (non URL).

Non inserite i link interni con la sintassi riservata ai link esterni al Wiki, altrimenti, nel caso di pagina spostata o cancellata, si verrebbe a creare un link rotto di cui è difficile accorgersi.

Esempio Risultato
Sintassi corretta 
[[Pagina principale]]
 Pagina principale 
[[Pagina principale | Mainpage del Wiki]]
 Mainpage del Wiki 
[[Pagina non esistente]]
 Pagina non esistente
Sintassi errata 
http://guide.debianizzati.org/index.php/Pagina_principale
 http://guide.debianizzati.org/Pagina_principale 
[http://guide.debianizzati.org/index.php/Pagina_principale Pagina principale]
 Pagina principale 
[http://guide.debianizzati.org/index.php/Pagina_principale Mainpage del Wiki]
 Mainpage del Wiki

Link esterno al Wiki

Per i link esterni basta scrivere l'URL completo di protocollo. Sono considerati URL validi quelli che utilizzano uno dei seguenti protocolli: http://, https://, ftp://, irc://, gopher://, telnet://, nntp://, worldwind://, mailto:, news:, svn://
L'URL può essere racchiuso tra parentesi quadre nel caso si voglia un titolo generico.

Esempio Risultato 
http://meta.wikimedia.org/wiki/Help:Link
 http://meta.wikimedia.org/wiki/Help:Link
[http://meta.wikimedia.org/wiki/Help:Link WikiMedia Links]
 WikiMedia Links

I link esterni, sebbene non esplicitamente sconsigliati, sono uno strumento da utilizzare con cautela e attenzione poiché le pagine a cui si riferiscono non sono modificabili.
Valutate attentamente che il link sia solo una fonte informativa supplementare per la pagina che si sta scrivendo e, soprattutto, non inserite link che puntino a parti essenziali per la comprensione della guida stessa. Questo consentirà in futuro sia di aggiornare più agevolmente la pagina sia di fornire all'utente una lettura logicamente completa e sequenziale.

Se si ha la necessità di inserire un link, considerare l'eventualità di far ricorso, se possibile, ai link permanenti (permalink) e di inserire in fondo alla guida una sezione apposita (chiamata "Link esterni", "Collegamenti esterni" o con il nome che più vi piace) che contenga i link esterni. Questo permetterà una loro più facile manutenzione soprattutto se la pagina linkata dovesse diventare irraggiungibile (broken link).

Link a sezioni delle guide

È possibile inserire un link ad una specifica sezione di una pagina anteponendo al suo titolo un carattere "#".
Se il nome della guida non viene specificato, il link sarà riferito ad una sezione della pagina corrente.

Esempio Risultato 
[[#Formattazione di codice|Formattazione di codice]]
 Formattazione di codice
[[Installare Debian#Metodi di installazione|Metodi di installazione di Debian]]
 Metodi di installazione di Debian

Prestare particolare attenzione a inserire link che puntano a sezioni di altre pagine; se queste sezioni vengono cancellate o rinominate, il link aprirà non più la sezione ma l'intera pagina.

Link a email

Permettono di inserire link a indirizzi email.
La sintassi è simile a quella dei link esterni, tranne per il fatto che viene utilizzata la parola "mailto:" seguita dall'indirizzo email.

Esempio Risultato 
[mailto:esempio@esempio.org]
 [1] 
[mailto:esempio@esempio.org Nome del Contatto]
 Nome del Contatto

Link a categorie

È possibile inserire un link ad una categoria presente sul Wiki in un modo molto simile a quello utilizzato per i link interni. L'unica differenza è che, al posto del nome della guida, va inserito ":Categoria:" seguito dal nome della categoria che si vuol linkare.

Esempio Risultato 
[[:Categoria:Internet]]
 Categoria:Internet
[[:Categoria:Internet | Lista delle guide contenute nella categoria "Internet"]]
 Lista delle guide contenute nella categoria "Internet"

Riferimenti

Il tag <ref></ref> permette di inserire riferimenti come note a piè di pagina ed è molto utile per inserire le fonti.

L'altro tag molto importante è <references /> per inserire le citazioni in un punto specifico della pagina e non alla fine.

Altri tag

Nowiki

Racchiudere tra i tag <nowiki> e </nowiki> per inibire l'interpretazione del testo da parte del motore del Wiki e visualizzarli come testo puro.

Esempio Risultato 
I tag <nowiki><code></nowiki> <nowiki></code></nowiki> non verranno interpretati.
 I tag <code> </code> non verranno interpretati. 
'''<nowiki>http://127.0.0.1</nowiki>'''
 http://127.0.0.1

Commenti

È possibile inserire un commento che verrà visualizzato solo nella finestra di editing della pagina.

Esempio Risultato 
<!-- Questo è un commento -->
 (Il testo sarà visibile solo all'interno della pagina di editing.)

Linea

L'inserimento di una linea, uguale a quella sottesa al nome delle sezioni, si ottiene attraverso quattro trattini "----"

Esempio Risultato 
Sta per essere inserite una riga
----
 Sta per essere inserite una riga

Tabelle

Le tabelle sono un elemento di formattazione molto potente e flessibile con cui è possibile sia accorpare i contenuti in elenchi graficamente coerenti, sia riunificare elementi diversi in un'unica struttura facilmente manipolabile.
Questo Wiki fa ampio ricorso alle tabelle all'interno delle pagine e dei template.

Inserimento
l'inserimento di una tabella avviene con l'utilizzo del tag "{|" per marcare l'inzio della tabella e del tag "|}" per la sua fine
Titoli
i titoli per ciascuna colonna possono essere inserti facendoli precedere da "!" . Il testo del titolo sarà visualizzato in grassetto.
Celle
le celle della tabella sono separate da "||". In caso di formattazione specifica solo per la cella, questa va separata dal contenuto attraverso un |
Righe
ciascuna riga inizia con | ed è separata dall'altra attraverso "|-"

Qui di seguito vi è un semplice esempio con cui viene creata una tabella con tre titoli, due righe e sei celle; due celle hanno una formattazione separata: 

{| class="wikitable"
!Colonna 1
!Colonna 2
!Colonna 3
|-
|cella 1 || cella 2 || style="background:lightblue" | cella 3
|-
|cella 4 || style="color:red" | cella 5 || cella 6
|}

il cui risultato sarà:

Colonna 1 Colonna 2 Colonna 3
cella 1 cella 2 cella 3
cella 4 cella 5 cella 6

L'inserimento di tabelle è specificato meglio e con dovizia di particolari nelle pagine apposite di MediaWiki[4] e Wikimedia[5].

Immagini

Questo Wiki consente di inserire delle immagini in modo che possano diventare il giusto complemento a quanto esposto all'interno di una guida; il loro caricamento è permesso solo agli utenti registrati.
Per visualizzare un'immagine all'interno di una pagina sono necessari due passi.

Caricamento

Prima di poter inserire un'immagine all'interno di una pagina sarà necessario caricarla sul Wiki. Questo può essere fatto dalla pagina apposita raggiungibile dal link "Carica un file"" nel menù "Strumenti"; in questa pagina saranno visibili alcune voci:

Nome del file di origine
qui è possibile scegliere il file che conterrà l'immagine da caricare. È specificato anche quale estensione è permessa per le immagini: questo Wiki accetta immagini nel formato png, gif, jpg e jpeg .
Nome del file di destinazione
è il nome dell'immagine sul Wiki e non necessariamente deve coincidere con il nome del file caricato.
Dettagli del file
scrivere qui tutte le informazioni che si ritengono utili per l'immagine che si sta caricando. In questo box è necessario inserire anche le eventuali informazioni sulla licenza che accompagna l'immagine (se non presente nella voce successiva) e il link alla pagina da cui si è presa l'immagine e/o nome dell'autore originale se differente dall'utente che carica l'immagine.
Licenza
scegliere il tipo di licenza con cui è stata rilasciata l'immagine. Di default la scelta sarà "CC-BY-NC-SA 2.0"; nel caso la licenza non sia disponibile tra quelle selezionabili, specificarla nel box "Dettagli del file".

Inserimento

Dopo che l'immagine è stata caricata sul Wiki, sarà possibile inserirla all'interno delle pagine.
Cliccando sull'immagine, di default, si accederà alla pagina relativa nel namespace "File". Ovviamente il link può essere sia inibito che cambiato in modo che il click sull'immagine porti a qualunque pagina interna o esterna al Wiki.

Nei successivi esempi verrà utilizzata la ben conosciuta Swirl. L'immagine è già caricata sul Wiki.

Azione Esempio Risultato
Inserimento con dimensioni originali 
[[Image:Swirl-50.png]]
oppure:
[[File:Swirl-50.png]]
  
Cambiare le dimensioni specificando i pixel 
[[Image:Swirl-50.png|30px]]
  
Centrare l'immagine 
[[Image:Swirl-50.png|center]]
 
Inibire il link alla pagina dell'immagine 
[[Image:Swirl-50.png|link=]]
  
Link ad una pagina interna al Wiki 
[[Image:Swirl-50.png|link=Pagina principale]]
  
Link ad una pagina esterna al Wiki 
[[Image:Swirl-50.png|link=http://forum.debianizzati.org]]
  
Immagine scalata, centrata e con link a pagina interna 
[[Image:Swirl-50.png|link=Pagina principale|30px|center]]
 
Thumbnail 
[[Image:Swirl-50.png|thumb]]
 
Thumbnail centrato 
[[Image:Swirl-50.png|thumb|center]]
 
Thumbnail con didascalia 
[[Image:Swirl-50.png|thumb|Swirl di Debian]]
 
Swirl di Debian
Thumbnail ridimensionato e con didascalia 
[[Image:Swirl-50.png|40px|thumb|Swirl di Debian]]
 
Swirl di Debian
Frame 
[[Image:Swirl-50.png|frame]]
 
Frame con didascalia 
[[Image:Swirl-50.png|frame|Swirl di Debian]]
 
Swirl di Debian
Frame centrato e con didascalia 
[[Image:Swirl-50.png|frame|center|Swirl di Debian]]
 
Swirl di Debian

Per ulteriori (e più complete) informazioni, è consigliabile la lettura della guida ufficiale di Wikipedia[2] che spiega minuziosamente come gestire le immagini in una pagina del Wiki.

  ATTENZIONE
Per evitare problemi di errato indirizzamento, il carattere "=" (uguale) all'interno degli URL va sostituito con la corrispondente codifica "%3D"


Caratteri speciali HTML

A causa dell'interpretazione da parte del Wiki, ci si potrebbe trovare nell'impossibilità di inserire un determinato carattere.
In questo caso si può far ricorso, come nell'HTML, all'inserimento di un codice del tipo &codice; nel testo. Dove codice è una parola o un numero che rappresenta il particolare simbolo da inserire.

Carattere Codice
& &amp;
(spazio) &nbsp;
< &lt;
Carattere Codice
> &gt;
= &#61;
[ &#91;
Carattere Codice
] &#93;
| &#124;
{ &#123;
Carattere Codice
} &#125;
(line feed) &#10;
* &#42;
Carattere Codice
# &#35;
 
 

Per una lista completa dei simboli e dei rispettivi codici consultare questa pagina[3].

Documentazione esterna

Link di questa pagina

[1] Le parole magiche
[2] Guida all'inserimento di immagini
[3] Caratteri speciali HTML
[4] Guida all'inserimento delle tabelle
[5] WikiMedia - Tabelle

Altri link utili

WikiMedia Help on Editing
WikiMedia Documentazione

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