Aiuto:Syntax highlighting

Da Wikivoyage.

L'estensione SyntaxHighlight GeSHi permette di effettuare l'evidenziazione della sintassi per le porzioni di codice sorgente inserite negli articoli di Wikivoyage.

Nonostante il nome, l'estensione non usa la libreria GeSHi, ma dal giugno 2015 utilizza Pygments.

La sintassi da usare è

<syntaxhighlight lang="linguaggio">codice sorgente</syntaxhighlight>

Esempio[modifica]

Scrivendo

<syntaxhighlight lang="php">
<?php
 // esempio
 $num = 10;
 echo "Hello world";
?>
</syntaxhighlight>

si ottiene

<?php
 // esempio
 $num = 10;
 echo "Hello world";
?>

Linguaggi supportati[modifica]

Di seguito sono elencati i principali valori che è possibile attribuire al parametro lang.

Valore Linguaggio
abap ABAP
actionscript ActionScript
ada Ada
apache Apache Configuration
applescript AppleScript
asm w:Assembly
asp Active Server Pages (ASP)
autoit AutoIt
bash w:Bash
basic4gl Basic4GL
bf w:Brainfuck
blitzbasic Blitz BASIC
bnf Backus-Naur Form
c C
c_mac C (Mac)
caddcl AutoCAD DCL
cadlisp AutoLISP
cfdg CFDG
cfm ColdFusion Markup Language
cil Common Intermediate Language (CIL)
cobol COBOL
cpp-qt C++ (Qt toolkit)
cpp C++
csharp C#
css Cascading Style Sheets (CSS)
d D
delphi w:Delphi
diff Diff
div DIV
dos DOS batch file
dot DOT
eiffel Eiffel
fortran Fortran
freebasic FreeBASIC
gambas w:Gambas
genero Genero
gettext GNU internationalization (i18n) library
glsl OpenGL Shading Language (GLSL)
gml Game Maker Language (GML)
gnuplot w:gnuplot
groovy w:Groovy
haskell Haskell
Haxe Haxe
hq9plus HQ9+
html4strict w:HTML
html5 w:HTML5
idl Uno IDL
ini INI
inno Inno
intercal INTERCAL
io Io
java Java
java5 Java(TM) 2 Platform Standard Edition 5.0
javascript w:JavaScript
kixtart w:KiXtart
klonec Klone C
klonecpp Klone C++
latex w:LaTeX
lisp w:Lisp
lolcode w:LOLCODE
lotusscript w:LotusScript
lua w:Lua
Valore Linguaggio
m68k Motorola 68000 Assembler
make make
matlab MATLAB M
mirc mIRC scripting language
mxml MXML
mpasm Microchip Assembler
mysql MySQL
nsis Nullsoft Scriptable Install System (NSIS)
objc w:Objective-C
ocaml-brief w:OCaml
ocaml w:OCaml
oobas OpenOffice.org Basic
oracle8 Oracle 8 SQL
oracle11 Oracle 11 SQL
pascal Pascal
per per
perl w:Perl
php-brief w:PHP
php w:PHP
pixelbender Pixel Bender
plsql w:PL/SQL
povray Persistence of Vision Raytracer
powershell Windows PowerShell
progress OpenEdge Advanced Business Language
prolog Prolog
providex ProvideX
python w:Python
qbasic QBasic/QuickBASIC
rails Rails
reg Windows Registry
robots robots.txt
rsplus R
ruby Ruby
sas SAS
scala Scala
scheme w:SchemeScheme
scilab w:Scilab
sdlbasic w:SdlBasic
smalltalk w:Smalltalk
smarty w:Smarty
sql w:SQL
swift Swift
tcl w:Tcl
teraterm Tera Term
text Plain text
thinbasic thinBasic
tsql Transact-SQL
typoscript TypoScript
vala Vala
vb Visual Basic
vbnet Visual Basic .NET
verilog Verilog
vhdl VHDL
vim Vimscript
visualfoxpro Visual FoxPro
visualprolog Visual Prolog
whitespace w:Whitespace
winbatch w:Winbatch
xml w:XML
xorg_conf Xorg.conf
xpp X++
z80 ZiLOG Z80 Assembler

Parametri[modifica]

inline[modifica]

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 inline 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" inline >
<?php
 // esempio
 $num = 10;
 echo "Hello world";
?>
</syntaxhighlight>

si ottiene: <?php // esempio $num = 10; echo "Hello world"; ?>

line[modifica]

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]

È 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]

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="html4strict">
<img src="<?php echo rand(1, 100) ?>" />
</syntaxhighlight>

otteniamo

<img src="<?php echo rand(1, 100) ?>" />

highlight[modifica]

Nota

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!";
 
 ?>

Pagine correlate[modifica]

Periodicamente è necessario assicurarsi che le seguenti categorie di controllo siano vuote, ossia che non ci siano pagine all'interno della versione italiana di Wikivoyage che hanno problemi.

Mi sembra di aver capito, ma...

Se non riesci ad afferrare qualche concetto o non capisci il perché di tale procedura, ci metti cinque secondi a chiederlo e avere risposta. Se pensi invece di avere una proposta, piccola o grande che sia, siamo tutti pronti ad ascoltarti.

L'elenco di tutte le pagine riguardanti Wikivoyage si trova nella pagina Aiuto:Aiuto.