Aiuto:Syntax highlighting
L'estensione SyntaxHighlight permette di effettuare l'evidenziazione della sintassi per le porzioni di codice sorgente inserite nelle voci di it.wiki.
Nonostante il nome, l'estensione non usa la libreria GeSHi, ma dal giugno 2015 utilizza Pygments.
Uso
[modifica | modifica wikitesto]La sintassi da usare è
<syntaxhighlight lang="linguaggio">codice sorgente</syntaxhighlight>
Il tag <source> è deprecato e inserisce la pagina nella categoria automatica di errore Pagine che utilizzano tag source deprecati.
Esempio
[modifica | modifica wikitesto]Scrivendo
<syntaxhighlight lang="php"> <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
si ottiene
<?php
// esempio
$num = 10;
echo "Hello world";
?>
Linguaggi supportati
[modifica | modifica wikitesto]Di seguito sono elencati i principali valori che è possibile attribuire al parametro lang.
Parametri
[modifica | modifica wikitesto]enclose
[modifica | modifica wikitesto]Normalmente <syntaxhighlight> racchiude il codice nei tag <pre> e l'effetto è un riquadro attorno al codice stesso. Se non si vuole questo effetto è possibile usare il parametro enclose per racchiudere il codice nei tag <div>. Nota: il parametro line forza l'uso della modalità <div>. Vediamo come si usa, scrivendo
<syntaxhighlight lang="php" enclose=div > <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
si ottiene:
<?php
// esempio
$num = 10;
echo "Hello world";
?>
line
[modifica | modifica wikitesto]Specificando il parametro line è possibile numerare automaticamente le righe, ad esempio scrivendo
<syntaxhighlight lang="php" line> <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
si ottiene
<?php
// esempio
$num = 10;
echo "Hello world";
?>
start
[modifica | modifica wikitesto]È anche possibile far iniziare la numerazione da un valore prestabilito (solo valori interi e maggiori di >0) aggiungendo il parametro start = X a line. Ad esempio:
<syntaxhighlight lang="php" line start="8"> <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
si ottiene
<?php
// esempio
$num = 10;
echo "Hello world";
?>
strict
[modifica | modifica wikitesto]In alcuni casi si possono inserire porzioni di codice di un linguaggio di programmazione all'interno di un altro linguaggio; come, ad esempio, il php all'interno di una pagina html. In questi casi l'evidenziazione può risultare errata, aggiungendo il parametro strict si dovrebbe risolvere la cosa. Vediamo le differenze. Scrivendo
<syntaxhighlight lang="php"> <img src="<?php echo rand(1, 100) ?>" /> </syntaxhighlight>
otteniamo
<img src="<?php echo rand(1, 100) ?>" />
usando il parametro strict
<syntaxhighlight lang="php" strict > <img src="<?php echo rand(1, 100) ?>" /> </syntaxhighlight>
si vede in modo corretto
<img src="<?php echo rand(1, 100) ?>" />
Se invece cerchiamo l'evidenziazione dell'html
<syntaxhighlight lang="html"> <img src="<?php echo rand(1, 100) ?>" /> </syntaxhighlight>
otteniamo
<img src="<?php echo rand(1, 100) ?>" />
highlight
[modifica | modifica wikitesto]L'uso del parametro line start="X" non influisce sul conteggio delle righe.
Con il parametro highlight è possibile evidenziare una o più righe. Per evidenziare una sola riga occorre specificarne il numero nel parametro highlight. Nel seguente esempio viene evidenziata la riga numero 4:
<syntaxhighlight lang="php" highlight="4"> <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
risultato:
<?php
// esempio
$num = 10;
echo "Hello world";
?>
Per evidenziare più righe separate basta specificare i numeri nel parametro highlight separati da una virgola. Nel seguente esempio vengono evidenziate le righe numero 2 e 4:
<syntaxhighlight lang="php" highlight="2,4"> <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
risultato:
<?php
// esempio
$num = 10;
echo "Hello world";
?>
È anche possibile evidenziare una serie di righe specificando nel parametro highlight la prima e l'ultima riga da evidenziare separate da un trattino (-). Nel seguente esempio vengono evidenziate le righe dalla 2 alla 4:
<syntaxhighlight lang="php" highlight="2-4"> <?php // esempio $num = 10; echo "Hello world"; ?> </syntaxhighlight>
risultato:
<?php
// esempio
$num = 10;
echo "Hello world";
?>
Combinando i due metodi spiegati sopra è possibile farne un uso più complesso. Nel seguente esempio vengono evidenziate le righe dalla 15 alla 20, la 24, dalla 26 alla 32 e la 44:
<syntaxhighlight lang="php" highlight="15-20,24,26-32,44">
<?php
/*
* Questo è un commento. Altri modi per commentare sono i simboli // e #
* Questo tipo di commenti non ha bisogno degli asterischi (*) all'inizio
* di ogni riga, ma lo si fa per convenzione. I simboli // e #
* commentano solo il testo che si trova dopo di essi e fino alla fine della riga;
* non c'è bisogno di finire il commento con qualche carattere speciale.
*/
/*
* Prima definiamo una funzione chiamata "plural".
* Restituisce una "s" se l'argomento passato non è 1.
*/
function plural($number)
{
// L'operatore ternario (!= ? :) è una struttura condizionale
// simile a if-else: (condizione ? true : false)
return ($number != 1 ? "s" : "");
}
// Definiamo una variabile chiamata $a_capo che contiene un a capo HTML,
// un carattere di ritorno e uno di nuova riga:
$a_capo = "<br />\r\n";
for ($i = 99; $i > 0; $i--) {
print "$i bottle" . plural($i) . " of beer on the wall,$a_capo";
// Non abbiamo bisogno di ripetere il comando print per ogni riga:
print "$i bottle" . plural($i) . " of beer.$a_capo
Take one down, pass it around,$a_capo" .
($i - 1 != 0 ? $i - 1 : "no more") .
" bottle" . plural($i - 1) . " of beer on the wall.$a_capo$a_capo";
/*
* PHP permette di creare stringhe su più righe, finché
* trova un punto e virgola (;) che termina l'istruzione.
* Un punto (.) concatena insieme più stringhe.
* Le variabili, che iniziano con il carattere "$", sono interpretate
* anche dentro i doppi apici ("), ma non dentro gli apici singoli (').
* Le funzioni, come plural(), non sono interpretate fra gli apici.
*/
}
print "Go to the store, $a_capo buy some more, $a_capo 99 bottles of beer on the wall!";
?>
</syntaxhighlight>
risultato:
<?php
/*
* Questo è un commento. Altri modi per commentare sono i simboli // e #
* Questo tipo di commenti non ha bisogno degli asterischi (*) all'inizio
* di ogni riga, ma lo si fa per convenzione. I simboli // e #
* commentano solo il testo che si trova dopo di essi e fino alla fine della riga;
* non c'è bisogno di finire il commento con qualche carattere speciale.
*/
/*
* Prima definiamo una funzione chiamata "plural".
* Restituisce una "s" se l'argomento passato non è 1.
*/
function plural($number)
{
// L'operatore ternario (!= ? :) è una struttura condizionale
// simile a if-else: (condizione ? true : false)
return ($number != 1 ? "s" : "");
}
// Definiamo una variabile chiamata $a_capo che contiene un a capo HTML,
// un carattere di ritorno e uno di nuova riga:
$a_capo = "<br />\r\n";
for ($i = 99; $i > 0; $i--) {
print "$i bottle" . plural($i) . " of beer on the wall,$a_capo";
// Non abbiamo bisogno di ripetere il comando print per ogni riga:
print "$i bottle" . plural($i) . " of beer.$a_capo
Take one down, pass it around,$a_capo" .
($i - 1 != 0 ? $i - 1 : "no more") .
" bottle" . plural($i - 1) . " of beer on the wall.$a_capo$a_capo";
/*
* PHP permette di creare stringhe su più righe, finché
* trova un punto e virgola (;) che termina l'istruzione.
* Un punto (.) concatena insieme più stringhe.
* Le variabili, che iniziano con il carattere "$", sono interpretate
* anche dentro i doppi apici ("), ma non dentro gli apici singoli (').
* Le funzioni, come plural(), non sono interpretate fra gli apici.
*/
}
print "Go to the store, $a_capo buy some more, $a_capo 99 bottles of beer on the wall!";
?>