XWiki Syntaxes
- Considerazioni Generali
- Paragrafi
- Titoli
- Formattazione Testo
- Riga Orizzontale
- Elenchi
- Elenchi di Definizione
- Nuova riga/Interruzioni di riga
- Collegamenti - Links
- Tabelle
- Immagini
- Contenuto testuale, verbatim cioè parola per parola
- Citazioni
- Gruppi
- Escapes - Commenti testo non valutato
- Macro
- HTML
- Scripts Velocity/Groovy
- Parametri
- Altre sintassi
A partire dalla versione 1.7 di XWiki Enterprise abbiamo introdotto una nuova sintassi di xwiki. La vecchia sintassi era stata chiamata Sintassi XWiki 1.0 e la nuova sintassi fu chiamata conseguentemente Sintassi XWiki 2.0. I motivi principali per l'introduzione di una nuova sintassi sono stati i seguenti:
- Superare i limiti e le ambiguità della sintassi XWiki 1.0 (che fu ispirata sia da Radeox - il motore di rendering sottostante- e da TWiki).
- Simboli non ottimali. Per esempio il simbolo per il grassetto era un asterisco singolo. Ciò causava problemi quando gli utenti inserivano del testo che conteneva degli asterischi, dal momento che il testo seguente veniva considerato erroneamente in grassetto, mentre non lo era affatto. Per cui abbiamo razionalizzato la sintassi usando almeno caratteri doppi ovunque possibile.
- Ambiguità. Per esempio c'era ambiguità tra una voce in grassetto all'inizio di una riga ed un elenco puntato. Era necessario risolvere le ambiguità per poter riscrivere l'editor WYSIWYG in modo che fosse deterministico.
- Per essere più vicini alla Sintassi Creole 1.0 che sta diventando lo standard delle sintasssi per i wiki. Inoltre la comunità di Creole ha speso del tempo per analizzare tutte le sintassi dei wiki esistenti prima di decidere i simboli da usare. Per cui le scelte fatte sono molto buone.
Dopo l'introduzione della sintassi XWiki 2.0 abbiamo scoperto alcuni difetti di questa sintassi. Per risolverli è stata introdotta, per il momento in via sperimentale, la sintassi XWiki 2.1 a partire dalla versione 3.0 di XWiki Enterprise. Ecco alcuni dei motivi per l'introduzione di questa nuova sintassi:
- Omogeneizzare la sintassi per i link e per le immagini, così da ottenere maggiore chiarezza, consistenza ed estendibilità.
- Aggiungere la possibilità di mostrare icone, di fare collegamenti a file usando la notazione UNC e fare link a URL relativi.
Oltre a queste due sintassi specifiche di XWiki abbiamo modificato anche il motore di rendering sottostante con XWiki Enterprise versione 1.7 (precedentemente era Radeox) in favore di un nostro motore che è un superset wrapper attorno a Wikimodel e Doxia (e si spera altri in futuro). Questo ci ha consentito di poter usare anche altre sintassi nel wiki: MediaWiki, Confluence, JSPWiki, Creole, TWiki e altre.
Considerazioni Generali
La sintassi XWiki 2.0 corregge alcuni errori o ambiguità che gli utenti potevano inserire come mostrato negli esempi della tabella seguente.
Descrizione | Esempio di sintassi non valida o ambigua | Risolto con Sintassi XWiki 2.0 |
---|---|---|
Stili di testo non chiusi | **grassetto | **grassetto** |
Due elementi isolati non separati da 2 nuove righe | | cella tabella * voce elenco | | cella tabella * voce elenco |
Due elementi isolati non separati da 2 nuove righe | paragrafo ---- paragrafo | paragrafo ---- paragrafo |
Nuova riga ignorata all'inizio del documento | <nuova riga all'inizio del documento> paragrafo | paragrafo |
Sintassi dei titoli non chiusa | === titolo | === titolo === |
Paragrafi
I paragrafi sono elementi di testo separati da 2 o più righe vuote.
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato con Sintassi XWiki 1.0 | Risultato con Sintassi XWiki 2.0 |
---|---|---|---|---|
Semplice paragrafo | Questo è un paragrafo | Questo è un paragrafo | Questo è un paragrafo | Questo è un paragrafo |
Paragrafo su più righe | Paragrafo su\\ più righe | Paragrafo su più righe | Paragrafo su più righe | Paragrafo su più righe |
Due paragrafi | Paragrafo uno Paragrafo due | Paragrafo uno Paragrafo due | Paragrafo uno Paragrafo due | Paragrafo uno Paragrafo due |
Paragrafo con parametri | <p style="text-align:center;color:blue">Paragrafo centrato e blu</p> | (% style="text-align:center;color:blue" %) Paragrafo centrato e blu | Paragrafo centrato e blu | Paragrafo centrato e blu |
Titoli
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Titoli Standard | 1 livello 1 | = livello 1 = == livello 2 == === livello 3 === ==== livello 4 ==== ===== livello 5 ===== ====== livello 6 ====== | livello 1
livello 2livello 3livello 4livello 5livello 6 |
Titoli con Parametri | <h1><span style="color:blue">titolo</span></h1> | (% style="color:blue" %) = titolo = | titolo |
Titoli con sintassi XWiki | 1.1.1 Titolo con *grassetto* | === Titolo con **grassetto** === | Titolo con grassetto |
Formattazione Testo
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Grassetto | *Grassetto* | **Grassetto** | Grassetto |
Sottolineato | __Sottolineato___ | __Sottolineato__ | Sottolineato |
Corsivo | ~~Corsivo~~ | //Corsivo// | Corsivo |
Sbarrato | --Sbarrato-- | --Sbarrato-- | |
Monospazio | <tt>Monospazio</tt> | ##Monospazio## | Monospazio |
Apice | testo <sup>in apice</sup> | testo ^^in apice^^ | testo in apice |
Pedice | testo <sub>in pedice</sub> | testo ,,in pedice,, | testo in pedice |
Riga Orizzontale
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Riga Orizzontale semplice | ---- | ---- | |
Riga Orizzontale con Parametri | <hr style="color:blue"/> | (% style="color:blue" %) ---- |
Elenchi
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Elenco puntato | * voce 1 ** voce 2 *** voce 3 * voce 4 | * voce 1 ** voce 2 *** voce 3 * voce 4 |
|
Elenco numerato | 1. voce 1 11. voce 2 111. voce 3 1. voce 4 | 1. voce 1 11. voce 2 111. voce 3 1. voce 4 |
|
Elenco misto | 1. voce 1 1*. voce 2 1*. voce 3 1. voce 4 | 1. voce 1 1*. voce 2 1*. voce 3 1. voce 4 |
|
Elenco puntato con quadratino | - voce 1 - voce 2 | (% style="list-style-type: square" %) * voce 1 * voce 2 |
|
Elenco puntato con punto pieno | <ul style="list-style-type: disc"> | (% style="list-style-type: disc" %) * voce 1 * voce 2 |
|
Elenco alfabetico minuscolo | a. voce 1 a. voce 2 | (% style="list-style-type: lower-alpha" %) * voce1 * voce2 |
|
Elenco alfabetico Maiuscolo | A. voce 1 A. voce 2 | (% style="list-style-type: upper-alpha" %) * voce1 * voce2 |
|
Elenco con numeri Romani minuscoli | i. voce 1 i. voce 2 | (% style="list-style-type: lower-roman" %) * voce1 * voce2 |
|
Elenco con numeri Romani Maiuscoli | I. voce 1 I. voce 2 | (% style="list-style-type: upper-roman" %) * voce1 * voce2 |
|
Elenco con lettere Greche minuscole | g. voce 1 g. voce 2 | (% style="list-style-type: lower-greek" %) * voce1 * voce2 |
|
Elenco con lettere Greche Maiuscole | G. voce 1 G. item 2 | (% style="list-style-type: upper-greek" %) * voce1 * voce2 |
|
Elenco Giapponese Hiragana | h. voce 1 h. voce 2 | (% style="list-style-type: hiragana" %) * voce1 * voce2 |
|
Elenco Giapponese Hiragana Iroha | H. voce 1 H. voce 2 | (% style="list-style-type: hiragana-iroha" %) * voce1 * voce2 |
|
Elenco Giapponese Katakana | k. voce 1 k. voce 2 | (% style="list-style-type: katakana" %) * voce1 * voce2 |
|
Elenco Giapponese Katakana Iroha | K. voce 1 K. voce 2 | (% style="list-style-type: katakana-iroha" %) * voce1 * voce2 |
|
Elenco lettere Armene | <ul style="list-style-type: armenian"> <li>voce1</li> <li>voce2</li> </ul> | (% style="list-style-type: armenian" %) * voce1 * voce2 |
|
Elenco lettere Ebraiche | j. voce1 j. voce2 | (% style="list-style-type: hebrew" %) * voce1 * voce2 |
|
Elenco lettere Georgiane | <ul style="list-style-type: georgian"> <li>voce1</li> <li>voce2</li> </ul> | (% style="list-style-type: georgian" %) * voce1 * voce2 |
|
Elenco ideogrammi Cinesi CJK | <ul style="list-style-type: cjk-ideographic"> <li>voce1</li> <li>voce2</li> </ul> | (% style="list-style-type: cjk-ideographic" %) * voce1 * voce2 |
|
Elenchi di Definizione
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Definizione Standard | <dl> <dt>termine</dt> <dd>definizione</dd> </dl> | ; termine : definizione |
|
Definizioni Nidificate | <dl> <dt>termine1</dt> <dd>definizione1 <dl> <dt>termine2</dt> <dd>definizione2</dd> </dl> </dd> </dl> | ; termine1 : definizione1 :; termine2 :: definizione2 |
|
Definizione con Parametri | <dl style="color:blue"> <dt>termine</dt> <dd>definizione</dd> </dl> | (% style="color:blue" %) ; termine : definizione |
|
Nuova riga/Interruzioni di riga
Una nuova riga è un ritorno a capo. Un'interruzione di riga è una nuova riga forzata che può comparire in un punto qualsiasi del testo.
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato con Sintassi XWiki 1.0 | Risultato con Sintassi XWiki 2.0 |
---|---|---|---|---|
Interruzione riga | Riga\\Nuova riga | Riga\\Nuova riga | Riga Nuova riga | Riga Nuova riga |
Nuova riga | Riga Nuova riga | Riga Nuova riga | Riga Nuova riga | Riga Nuova riga |
Collegamenti - Links
Specifiche dei link con la Sintassi XWiki 1.0
Il formato completo di un link è [etichetta {> o |}] (risorsa) [@interWikiAlias] [{> o |} obbiettivo]
- etichetta: Una stringa opzionale che viene mostrata all'utente come nome del link quando è renderizzata. Esempio: Pagina personale
- risorsa: Il riferimento completo al link usando la seguente sintassi: (riferimento) [?Stringaquery] [#ancora]
- riferimento: Il riferimento del link. Esso può essere indifferentemente
- un URI nella forma protocollo:percorso (esempi: http://xwiki.org, mailto:john@smith.com), o
- una pagina wiki riferimento nella forma [[NomeWiki:] spazio.] (pagina). Esempi: WebHome, Main.WebHome, mywiki:Main.WebHome
- NomeWiki: Stringa opzionale che contiene il nome di un subwiki (animal) di una 'farm' di wiki. Il link punterà ad una pagina all'interno di quel subwiki. Esempio: miowiki
- spazio: Nome opzionale dello Spazio del wiki. Se non si specifica uno spazio viene usato lo spazio corrente. Esempio: Main
- pagina: Stringa obbligatoria che contiene il nome della pagina del wiki da collegare. Esempio: WebHome
- Stringaquery: Stringa opzionale di query per specificare dei parametri che saranno usati nel rendering dell'URL. Esempio: mydata1=5&mydata2=Hello
- ancora: Nome opzionale di un'ancora che punta ad un'altra ancora definita nel link in oggetto. Notare che in XWiki le ancore sono create automaticamente per i titoli. Esempio: HTableOfContents
- riferimento: Il riferimento del link. Esso può essere indifferentemente
- interWikiAlias: Un alias opzionale Inter Wiki come definito nella InterWiki Map (vedere la Admin Guide).Questo vale solo per i nomi delle pagine wiki. Esempio: wikipedia
- obbiettivo: Stringa opzionale che corrisponde all'atttributo HTML target per un elemento link HTML A . Questo elemento viene usato quando si fa il render del link. Di default apre il link nella pagina corrente. Esempi: _self, _blank
Specifiche dei link con la Sintassi XWiki 2.0
Il formato completo di un link è [etichetta>>] (risorsa) [@interWikiAlias] [||parametri]
- etichetta: Stringa opzionale che sarà mostrata all'utente dopo il render del link. L'etichetta può contenere della sintassi XWiki. Se non viene specificata un'etichetta sarà generata un'etichetta predefinita. Il modello di generazione può essere cambiato, vedere la Admin Guide. Esempio: My Page
- risorsa: Il riferimento completo al link con la sintassi seguente: (riferimento) [?Stringaquery] [#ancora]
- riferimento: Il riferimento al collegamento in una delle forme seguenti:
- URL: qualsiasi URL nella forma protocollo://percorso. Esempi: http://xwiki.org, https://svn.xwiki.org/
- Nome pagina Wiki riferimento nella forma [[NomeWiki:] spazio.] (pagina). Esempi: WebHome, Main.WebHome, mywiki:Main.WebHome
- NomeWiki: Stringa opzionale che contiene il nome di un subwiki (animal) di una 'farm' di wiki. Il link punterà ad una pagina all'interno di quel subwiki. Esempio: miowiki
- spazio: Nome opzionale di uno Spazio del wiki. Se non si specifica uno spazio verrà usato lo spazio corrente. Esempio: Main
- pagina: Stringa obbligatoria che contiene il nome della pagina del wiki cui si vuole collegarsi. Esempio: WebHome
- Allegato riferimento nella forma attach: [wikiPageName@] (attachmentName). Esempi: attach:img.png, attach:mywiki:Main.WebHome@img.png
- attach:: Stringa richiesta che identifica la risorsa come allegato.
- wikiPageName: Stringa opzionale con il riferimento al documento che contiene l'allegato, vedere sopra "Wiki page name".
- attachmentName: Nome dell'allegato come è stato memorizzato nel wiki.
- indirizzo Email nella forma mailto: (emailAddress) (#anchor non è valido). Esempio: mailto:john@smith.com
- mailto:: Stringa richiesta che identifica la risorsa come email.
- emailAddress: Indirizzo del destinatario dell'email. Esempio: "john@smith.com"
- Stringaquery: Stringa opzionale di query per specificare parametri che saranno usati nel rendering dell'URL. Esempio: mydata1=5&mydata2=Hello
- anchra: Nome di un'ancora opzionale che punta ad un'ancora definita nel link cui si fa riferimento. Notare che in XWiki le ancore sono create automaticamente per i titoli. Esempio: HTableOfContents
- riferimento: Il riferimento al collegamento in una delle forme seguenti:
- interWikiAlias: Alias opzionale Inter Wiki come definito nella InterWiki Map (vedere la Admin Guide). Questo vale solo per i nomi delle pagine wiki. Esempio: wikipedia
- parametri: elenco opzionale di parametri che si possono passare al link. Esempio: rel="__blank" (apri in una nuova finestra)
Specifiche dei link con la Sintassi XWiki 2.1
Il formato completo di un link è [etichetta>>] (risorsa) [||parametri]
- etichetta: Stringa opzionale che sarà mostrata all'utente dopo il render del link. L'etichetta può contenere della sintassi XWiki. Se non viene specificata un'etichetta sarà generata un'etichetta predefinita. Il modello di generazione può essere cambiato, vedere la Admin Guide. Esempio: My Page
- risorsa: Stringa richiesta con il riferimento al link in una delle forma seguenti
- URL: qualsiasi URL nella forma [url:] (protocollo://percorso). Esempi: http://xwiki.org, url:https://svn.xwiki.org/
- url: Stringa opzionale che identifica la risorsa come un URL.
- Wiki page name Nome pagina WIki, riferimento nella forma [doc:] [[wikiName:] spazio.] (pagina). Esempi: WebHome, Main.WebHome, mywiki:Main.WebHome
- doc: Stringa opzionale che identifica la risorsa come documento XWiki.
- wikiName: Stringa opzionale contenente il nome di un subwiki (animal) di una 'farm' di wiki. Il link punterà ad una pagina all'interno di quel subwiki. Esempio: miowiki
- spazio: Nome opzionale di uno Spazio del wiki. Se non si specifica uno spazio verrà usato lo spazio corrente. Esempio: Main
- pagina: Stringa richiesta con il nome della pagina wiki cui punta il link. Esempio: WebHome
- InterWiki page name Nome pagina Interwiki, riferimento nella forma interwiki: (interWikiAlias:) (page). Esempio: interwiki:wikipedia:XWiki
- interwiki: Stringa richiesta che identifica la risorsa come un link InterWiki.
- interWikiAlias: Alias opzionale dell'Inter Wiki come definito dall'InterWiki Map (vedere la Admin Guide). Esempio: wikipedia
- pagina: Stringa richiesta con il nome della pagina wiki cui punta il link. Esempio:: XWiki
- Allegato Allegato, riferimento nella forma attach: [wikiPageName@] (attachmentName). Esempi: attach:img.png, attach:mywiki:Main.WebHome@img.png
- attach:: Stringa richiesta che identifica la risorsa come un allegato.
- wikiPageName: Stringa opzionale che indica il riferimento al documento che contiene l'allegato, vedere "Wiki page name" precedente.
- attachmentName: Nome dell'alllegato come memorizzato nel wiki.
- Email address Indirizzo email, nella forma mailto: (emailAddress) (#anchor non è valido). Esempio: mailto:john@smith.com
- mailto:: Stringa richiesta che indentifica la risorsa come email.
- emailAddress: Indirizzo email del destinatario. Esempio: john@smith.com
- Relative path Percorso relativo, riferimento sul server nella forma path: (relPath). Esempio: path:$doc.getURL('reset') produce l'indirizzo di destinazione http://server.domain.com/xwiki/bin/reset/Space/Page dove /xwiki/bin/reset/Space/Page è prodotto da $doc.getURL('reset').
- path: Stringa richiesta che identifica la risorsa come percorso relativo.
- relPath: Stringa richiesta contenente il percorso relativo della risorsa sul server cui punta il link.
- UNC (Windows Explorer) riferimento nella forma unc: (path). Il link è reso come un link ad un file:// . Esempi: unc:C:\Windows\, unc:\\myserver\path\img.png, unc:home/user/somefile
- unc: Stringa richiesta che identifica la risorsa come un percorso UNC (Windows Explorer).
- path: Stringa richiesta contenente il percorso locale della risorsa acessibile dall'utente. Esempi: C:\Windows\, \\myserver\path\img.png, home/user/somefile
- URL: qualsiasi URL nella forma [url:] (protocollo://percorso). Esempi: http://xwiki.org, url:https://svn.xwiki.org/
- parametri: Lista opzionale separata da spazi di parametri passati al link. Esempio: queryString="mydata1=5&mydata2=Hello" anchor="HTableOfContents" rel="__blank"
- Stringaquery: Stringa opzionale di query per specifici parametri che saranno appesi all'indirizzo del link e usati nel rendering dell'URL. Eaempio: url:http://domain.com/path||queryString="mydata1=5&mydata2=Hello" produce l'indirizzo di destinazione http://domain.com/path?mydata1=5&mydata2=Hello
- ancora: Nome opzionale di un ancora che punta ad un ancora definita nel link cui si riferisce. Notare che in XWiki le ancore per i titoli sono create automaticamente. Esempio: url:http://domain.com/path||anchor="HTableOfContents" produce l'indirizzo di destinazione http://domain.com/path#HTableOfContents
- rel: Parametro opzionale che consente di aprire il link in una nuova finestra. Esempio: rel="__blank"
Tabelle
È possibile creare facilmente del testo in forma tabellare. Con la Sintassi XWiki 2.0 sono supportati anche parametri per la tabella, le righe o le celle.
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato | ||||||
---|---|---|---|---|---|---|---|---|---|
Tabella Standard | ((( {table} Titolo 1 | Titolo 2 Parola 1 | Parola 2 {table} ))) |
|=Titolo 1|=Titolo 2
|Parola 1|Parola 2 !=Titolo 1!=Titolo 2 !!Parola 1!!Parola 2 |
| ||||||
Tabella con Parametri | <table style="background-color:red;align:center"> | (% style="background-color:red;align=center" %) |=Titolo 1|=(% style="background-color:yellow" %)Titolo 2 |Parola 1|Parola 2 |
| ||||||
Tabella filtrabile ordinabile | $xwiki.ssfx.use("js/xwiki/table/table.css") $xwiki.jsfx.use("js/xwiki/table/tablefilterNsort.js", true) <table id="tableid" class="grid sortable filterable doOddEven"> <tr class="sortHeader"> <th>Titolo1</th> <th>Titolo2</th> </tr> <tr> <td>Cella11</td> <td>Cella12</td> </tr> <tr> <td>Cella21</td> <td>Cella22</td> </tr> </table> | {{velocity}} $xwiki.ssfx.use("js/xwiki/table/table.css") $xwiki.jsfx.use("js/xwiki/table/tablefilterNsort.js", true) {{/velocity}} (% class="grid sortable filterable doOddEven" id="tableid" %) (% class="sortHeader" %)|=Titolo 1|=Titolo 2 |Cella 11|Cella 12 |Cella 21|Cella 22 |
|
Immagini
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Immagine da un allegato nella pagina corrente |
| image:img.png | |
Immagine da un allegato di un altro documento | {image:img.png|document=Space.Page} | image:Space.Page@img.png | |
Immagine con parametri | {image:img.png|width=25|height=25} | [[image:img.png||width="25" height="25"]] | |
Immagini raggiungibili con un URL | http://some/url/img.png | image:http://some/url/img.png |
Specifiche per le Immagini in Sintassi XWiki 2.0
Il formato completo di un'immagine è image: (riferimento) oppure [[image: (riferimento) {||parametri}]]
- image: Stringa richiesta che identifica la risora come immagine.
- riferimento: Il riferimento all'immagine che sarà mostrata in una delle forme seguenti:
- URL: Un qualunque URL ad un'immagine nel formato http://percorso/Nomeimmagine. Esempio: http://domain.org/path/img.png
- Allegato riferimento nel formato {{{Nomewiki:} spazio.} pagina@} (Nomeimmagine)
- NomeWiki: Stringa opzionale che contiene il nome di un subwiki (animal) di una 'farm' di wiki. Il link punterà ad una pagina all'interno di quel subwiki. Esempio: miowiki
- spazio: Nome opzionale di uno spazio del wiki. Se non si specifica uno spazio viene usato lo spazio corrente. Esempio: Main
- pagina: Stringa opzionale che contiene il nome di una pagina del wiki a cui l'immagine fa riferimento come allegato. Esempio: WebHome
- Nomeimmagine: Stringa richiesta con il nome dell'immagine allegata alla pagina così come è memorizzato nel wiki.
- parametri: Elenco opzionale di parametri separati da uno spazio passati all'immagine. Esempio: width="800" height="600" alt="img.png" title="My nice image"
- Attributi HTML: Tutti gli attributi definiti dallo standard HTML saranno aggiunti al codice HTML renderizzato <img> tag.
- style: Informazioni sullo stile CSS che si deve applicare all'immagine. Esempio: style="float:right;height:50" (immagina a destra, altezza 50 pixel), style="style="display:block;margin-left:auto;margin-right:auto;width:80%" (immagine centrata, larghezza 80% del blocco), style="vertical-align:bottom" (il testo inzia in basso all'immagine)
- height: Parametro che definisce l'altezza visualizzata dell'immagine. Il valore dovrebbe essere in pixel (esempio: height="80") o in pixel relativi all'altezza del blocco contenente l'immagine (esempio: height="40%").
- width: Parametro che definisce la larghezza visualizzata dell'immagine. Il valore dovrebbe essere in pixel (esempio: width="80") o in pixel relativi alla larghezza del blocco contenente l'immagine (esempio: width="40%").
- title: Parametro che definisce il titolo visualizzato dell'immagine che sarà visibile quando ci si passa sopra con il mouse, per esempio. Esempio: title="La mia bella immagine"
- alt: Parametro che definisce quale testo deve essere mostrato se il browser non è in grado di visualizzare l'immagine. Dal momento che questo è un attributo HTML richiesto XWiki userà il nome del file se il parametro alt non è definito. Esempio: alt="img.png"
- Altro: Una spiegazione più approfondita sul tag HTML <img> tag che comprende altri attributi si può trovare su html.
- Attributi HTML: Tutti gli attributi definiti dallo standard HTML saranno aggiunti al codice HTML renderizzato <img> tag.
Specifiche per le Immagini in Sintassi XWiki 2.1
Il formato completo di un'immagine è image: (riferimento) oppure [[image: (riferimento) {||parametri}]]
- image: Stringa richiesta che identifica la risora come immagine.
- riferimento: Il riferimento all'immagine che sarà mostrata in una delle forme seguenti:
- URL: Un qualunque URL ad un'immagine nel formato protocollo://percorso/Nomeimmagine. Esempio: http://domain.org/path/img.png
- Allegato riferimento nel formato {{{Nomewiki:} spazio.} pagina@} (Nomeimmagine)
- NomeWiki: Stringa opzionale che contiene il nome di un subwiki (animal) di una 'farm' di wiki. Il link punterà ad una pagina all'interno di quel subwiki. Esempio: miowiki
- spazio: Nome opzionale di uno spazio del wiki. Se non si specifica uno spazio viene usato lo spazio corrente. Esempio: Main
- pagina: Stringa opzionale che contiene il nome di una pagina del wiki a cui l'immagine fa riferimento come allegato. Esempio: WebHome
- Nomeimmagine: Stringa richiesta con il nome dell'immagine allegata alla pagina così come è memorizzato nel wiki.
- Icona riferimento nel formato (icon:) (iconName). Esempio: icon:accept
- icon: Stringa richiesta che identifica il riferimento come un'icona da png.
- iconName: Stringa richiesta che identifica l'icona cui si fa riferimento. Esempio: accept
- parametri: Elenco opzionale di parametri separati da uno spazio passati all'immagine. Esempio: width="800" height="600" alt="img.png" title="My nice image"
- Attributi HTML: Tutti gli attributi definiti dallo standard HTML saranno aggiunti al codice HTML renderizzato <img> tag.
- style: Informazioni sullo stile CSS che si deve applicare all'immagine. Esempio: style="float:right;height:50" (immagina a destra, altezza 50 pixel), style="style="display:block;margin-left:auto;margin-right:auto;width:80%" (immagine centrata, larghezza 80% del blocco), style="vertical-align:bottom" (il testo inzia in basso all'immagine)
- height: Parametro che definisce l'altezza visualizzata dell'immagine. Il valore dovrebbe essere in pixel (esempio: height="80") o in pixel relativi all'altezza del blocco contenente l'immagine (esempio: height="40%").
- width: Parametro che definisce la larghezza visualizzata dell'immagine. Il valore dovrebbe essere in pixel (esempio: width="80") o in pixel relativi alla larghezza del blocco contenente l'immagine (esempio: width="40%").
- title: Parametro che definisce il titolo visualizzato dell'immagine che sarà visibile quando ci si passa sopra con il mouse, per esempio. Esempio: title="La mia bella immagine"
- alt: Parametro che definisce quale testo deve essere mostrato se il browser non è in grado di visualizzare l'immagine. Dal momento che questo è un attributo HTML richiesto XWiki userà il nome del file se il parametro alt non è definito. Esempio: alt="img.png"
- Altro: Una spiegazione più approfondita sul tag HTML <img> tag che comprende altri attributi si può trovare su html.
- queryStringa: Consente di inviare richieste al server quando si crea il link per il download dell'immagine referenziata. Esempio: queryString="width=100&height=800&keepAspectRatio=true" (keepAspectRatio=true non avrà successo se i parametri width e height non vengono specificati oltre a queryString!)
- Attributi HTML: Tutti gli attributi definiti dallo standard HTML saranno aggiunti al codice HTML renderizzato <img> tag.
Contenuto testuale, verbatim cioè parola per parola
Consente di inserire del contenuto che non sarà formattato (in altre parole non viene considerata la sintassi XWiki).
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultati con Sintassi XWiki 1.0 | Risultati con Sintassi XWiki 2.0 |
---|---|---|---|---|
Verbatim in una riga | Testo verbatim {pre}*[not rendered]*{/pre} contenuto | Testo verbatim {{{**[[not rendered]]**}}} contenuto | Testo verbatim *[not rendered]*contenuto | Testo verbatim **[[not rendered]]**contenuto |
Verbatim in un blocco |
{pre}
contenuto
*verbatim*
su più righe
{/pre}
| {{{ contenuto **verbatim** su più righe }}} | contenuto *verbatim* su più righe | contenuto **verbatim** su più righe |
Citazioni
Permette di citare, quotare, del testo.
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|---|
Citazione semplice | <blockquote><p>Giovanni ha detto questo</p></blockquote> | > Giovanni ha detto questo Io ho detto va bene |
Io ho detto va bene |
Citazioni nidificate | <blockquote><p>Giovanni ha detto questo</p> | > Giovanni ha detto questo >> Maria ha risposto questo Io ho detto va bene |
Io ho detto va bene |
Gruppi
Si possono usare i Gruppi per inserire direttamete un altro documento nel documento corrente. Questo permette per esempio di inserire elementi complessi in una voce di un elenco o all'interno di una cella di una tabella. I Gruppi sono delimitati dai seguenti elementi sintattici:(((...))). Un Gruppo può contenere un altro Gruppo senza limiti di nidificazione.
Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato | ||||||
---|---|---|---|---|---|---|---|---|
|=Titolo 1|=Titolo 2|=Titolo 3 |Cella Uno|((( = Documento incluso = Alcuni paragrafi inclusi. * voce elenco uno * voce elenco due ** sotto elemento 1 ** sotto elemento 2 ))) | Cella Tre Paragrafo successivo nel documento di livello superiore |
Paragrafo successivo nel documento di livello superiore |
Escapes - Commenti testo non valutato
Consente di commentare e quindi non valutare la sintassi XWiki
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato con Sintassi XWiki 1.0 | Risultato con Sintassi XWiki 2.0 |
---|---|---|---|---|
Commentare un carattere | Questo non è un \[link\] | Questo non è un ~[~[link~]~] | Questo non è un [link] | Questo non è un [[link]] |
Macro
Ci sono due tipi di macro nella Sintassi XWiki 1.0:
- Macro Velocity (chiamate usando la sintassi #macroname(param1 ... paramN) )
- Macro Radeox (chiamate usando la sintassi {macroname:param1=value1|...|paramN=valueN} )
Anche nella Sintassi XWiki 2.0 ci sono due tipi di macro:
- Macro Velocity (chiamate usando la sintassi #macroname(param1 ... paramN) all'interno della Macro Velocity)
- Macro XWiki (chiamate usando la sintassi {{macroname param1="value1" ... paramN="valueN"}} )
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 |
---|---|---|
Macro Velocity | #info("testo a caso") | {{info}} Testo a caso {{/info}} |
Radeox Macro/XWiki Macro | {code:java} contenuto java {code} | {{code language="java"}} contenuto java {{/code}} |
HTML
Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | Risultato |
---|---|---|
<b>grassetto</b> | {{html}}<b>grassetto</b>{{/html}} | grassetto |
Scripts Velocity/Groovy
Caratteristica | Sintassi XWiki 1.0 | Sintassi XWiki 2.0 |
---|---|---|
Script Velocity | #set ($var = "qualsiasi") | {{velocity}} #set ($var = "qualsiasi") {{/velocity}} |
Script Groovy | <% def var = "qualsiasi" %> | {{groovy}} def var = "qualsiasi" {{/groovy}} |
Parametri
Con la Sintassi XWiki 2.0 è possibile passare dei parametri tra i diversi elementi sintattici ed anche a blocchi di testo. Si usa questo per esempio per applicare uno stile. Si può impostare qualunque parametro chiave/valore. Il motore di render XHTML passerà questi parametri come attributi XHTML della sottostante rappresentazione XHTML dei differenti elementi sintattici. Nella Sintassi XWiki 1.0 non c'era una sintassi per passare dei parametri e l'unico modo per farlo era di scrivere codice XHTML direttamente nel contenuto, come mostrato nella tabella seguente.
Sintassi XWiki 1.0 | Sintassi XWiki 2.0 | XHTML Generato |
---|---|---|
<h1 class="miaClasse" style="mioStile" id="myId">titolo</h1> | (% class="miaClasse" style="mioStile" id="myId" %) = titolo = | <h1 class="miaClasse" style="mioStile" id="myId">titolo</h1> |
Altre sintassi
A partire da XWiki Enterprise 1.6 sono implementate anche queste altre sintassi: