La formattazione del testo in TWiki

Lavorare con TWiki è facile, basta saper usare una tastiera. Anche se lo si può usare, non è necessario conoscere l'HTML. Digitando una ParolaWiki si crea automaticamente un iperlink alla pagina dell'argomento con quel nome. In più le scorciatoie di TWiki hanno la potenza dell'HTML e costituiscono un sistema di codifica che si impara in brevissimo tempo. Tutto quello che serve è qui sotto ed è sempre disponibile durante ogni sessione di edit (è presente un link in fondo alla pagina di edit).

Le scorciatoie di TWiki

paragrafo 1
paragrafo 2

---++ Sushi
---+++ Maguro

*Bold*

_Italic_

__Bold italic__

=Fixed font=

==Bold fixed==

_Questo funziona_,
_questo no _

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

-------

   * bullet item

   * level 1
      * level 2

   1. Sushi
   1. Dim Sum
   A. Sushi
   A. Dim Sum
   i. Sushi
   i. Dim Sum

   $ Sushi: Japan
   $ Dim Sum: S.F.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |

WebNotify
Main.TWikiUsers

[[wiki syntax]]
[[Main.TWiki users]]
escaped:
![[wiki syntax]]

[[WikiSyntax][syntax]]
[[http://gnu.org][GNU]]
[[http://xml.org XML]]

[[WikiWord#NotThere]]
[[#MyAnchor][Jump]]
#MyAnchor To here

!SunOS

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

[[mailto:[email protected] Mail]]
[[mailto:?subject=Hi Hi]]

Usare HTML

Qualunque tag HTML può essere usato senza problemi. Tuttavia è bene tenere presenti alcune considerazioni di carattere tecnico.

HTML e usabilità di TWiki

• SUGGERIMENTO: Nelle pagine scritte a più mani, è preferibile NON USARE HTML, usare piuttosto le scorciatoie TWiki - questo per matenere il testo facile da editare.
• NOTA: TWiki è disegnato per funzionare con un ampia varietà di piattaforme e browser e offre compatibilità HTML 4.0 e XHTML 1.0 - aggiungendo codice HTML proprio o tag specifici per questo o quel browser ridurrà la compatibilità.
• Raccomandazioni usando HTML:
  • Usare la sintassi XHTML 1.0 Transitional
  • Evitare i tag che occupano più linee
  • Rimuovere tutte le linee vuote. TWiki inserisce i tag di paragrafo <p /> per ogni linea vuota; la cosa causa problemi se fatta tra tag che non supportano i tag di paragrafo come per esempio i tag table.

Restituzione TWiki dell'HTML

• TWiki converte la propria notazione in XHTML 1.0 per la visualizzazione. Per copiare una pagina con tutti i tag, visualizza il codice della pagina (sorgente) e incollalo..
  • Se si ha bisogno di salvare frequentemente il codice HTML, si può utilizzare TWiki:Plugins/GenHTMLAddon - che serve a generare una directory contenete le versioni visualizzate delle pagine TWiki unitamente a tutti i file necessari
• NOTA: L'apertura e la chiusura delle parentesi ad angolo - <...> - o i tag HTML _devono essere sulla stessa linea _, altrimenti saranmno interrotti.
  • Questa caratteristica permette di introdurre una parentesi angolata - come simbolo di magiore o minore - ed ottenerne la visualizzazione come se si fossero intodotti i caratteri HTML HTML , <, ex: a < b
  • Se si vuole incollare testo HTML e si notano problemi, eliminare dal testo tutti gli accapi.

TWiki e JavaScript

JavaScript può essere utilizzato nelle applicazioni TWiki. Poichè il meccanismo di restituzione delle pagine di TWiki può interferire con il codice JavaScript questo va inserito all'interno di tag comment HTML <pre> :

<script type="text/javascript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>

Collegamenti ipertestuali

Poter creare collegamenti ipertestuali senza particolari regole di formattazione è la caratteristica centrale di TWikisresa possibile dalle WikiWords.Le altre regole sintattiche sono semplici estensioni per rendere più flessibile e ricco il meccanismo.

Link interni

• GoodStyle è una WikiWord che genera un link all'argomento GoodStyle che si trova nel web TWiki.

• NotExistingYet^? è un argomento in attesa di essere scritto. Per creare la pagina cliccare sul ?. (Puoi provare, ma poi premi Annulla altrimenti la prova non si potrà più fare)

Link esterni

• http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... generano link automaticamente.

• Gli indirizzi Email [email protected] sono lincati automaticamente.

• [[le regole per le parentesi quadre]] permettono facilmente di creare link con parole non-WikiWord.
  • Si può anche scrivere [[http://yahoo.com Yahoo home page]] come un modo più agevole per creare un link esterno associato a testi maggiormente descrittivi, esempio Yahoo home page.

Variabili TWiki

Le variabili sono nomi racchiusi tra segni di percentuale % che vengono espanse al volo.

• %TOC% : Genera automaticamente l'indice dei contenuti basandosi sui titoli - un esempio è l'esempio all'inizio di questa pagina.

• %WEB% : Il web corrente è TWiki.

• %TOPIC% : il nome dell'argomento corrente è TextFormattingRules.

• %ATTACHURL% : L' URL degli allegati alla pagina corrente. Esempio di uso: si può fare riferimento all'allegato a un argomento (es. l'immagine image.gif) con %ATTACHURL%/image.gif per mostrare l'immagine all'interno del testo.

• %INCLUDE{"SomeTopic"}% : Server side include, include un argomento in un altro. Il web corrente TWiki è il web di default. Esempio: %INCLUDE{"TWiki.SiteMap"}%

• %SEARCH{"sushi"}% Ricerca inline : mostra i risultati di una operazione di ricerca inserendoli direttamente nella pagina. la ricerca con formattazione^? permette di controllare l'aspetto delle informazioni trovate.

• TWikiPreferences definiscono variabili valide per tutto il sito (site-wide variables). Tra le altre:
  • Interruzione di riga: Scrivi %BR% per iniziare una nuova linea.
  • Testo coloratoC: Scrivi: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
  • Documentation Graphics: Write: %H% Help, %T% Suggerimento, %X% Attenzione to get: Help, Tip, Avvertenza. Per maggiori informazini vedi TWikiDocGraphics.

• Per le altre variabili (molte), vedi TWikiVariables.

• Per "neutralizzare (escape)" una variabile, basta premettere un punto esclamativo. Scrivi: !%SOMEVARIABLE% per avere: %SOMEVARIABLE%.

TWikiPlugin Estensioni della formattazione

I Plugins aggiungono capacità addizionali di formattazione del testo e possono estendere le funzionalità di TWiki in molti ambiti. Per esempio, l'opzionale SpreadSheetPlugin consente di creare un foglio elettronico utilizzando la stessa notazione usata per le tabelkle TWiki.

I Plugin disponibili sono descritti nel web Plugins su TWiki.org. I plugin attualmente installati su questo sito TWiki, come elencato da %PLUGINDESCRIPTIONS% sono:

• DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated *_text_* as bold italic text.
• SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in TWiki topics.
• CalendarPlugin: This plugin shows a monthly calendar with highlighted events
• ChildTopicTemplatePlugin: Allows templates to be specified for automatic child topic creation.
• CommentPlugin: Allows users to quickly post comments to a page without an edit/preview/save cycle.
• EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
• EmbedFlashPlugin: Embeds a Macromedia Flash file
• ExplicitNumberingPlugin: Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Multiple named sequences and sequence re-initialization is supported.
• HiddenTextPlugin: Hide a block of text in the edit page
• InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic
• PhotoarchivePlugin: PhotoarchivePlugin creates nice image galleries
• RecursiveRenderPlugin: This plugin adds <render> tags and ~macros.
• RenderListPlugin: Render bullet lists in a variety of formats
• SessionPlugin: Stores persistent information (like logon and skin information) in a session on the server identified transparently by ID passed from browser.
• SlideShowPlugin: Create web based presentations based on topics with headings.
• SmiliesPlugin: Render smilies as icons, like  :-) for or  :cool: for
• TablePlugin: Control attributes of tables and sorting of table columns
• TopicVarsPlugin: Set variables in arbitrary topics and refer to them from other topics within the same web; these can be parameterised thus facilitating the packaging of TWiki:Codev.TWikiApplications
• TreePlugin: Dynamic generation of TWiki topic trees