r51 - 21 Nov 2021 - 09:02:48 - WebMasterYou are here: TWiki >  TWiki Web > TextFormattingRules
ANNUNCIO: L'aggiornamento dei pacchetti ISI produce importanti cambiamenti, leggete questa nota

1 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

Comandi di formattazione: Esempio, se scrivi: Ottieni:
Paragrafi:
Linee vuote creeranno nuovi paragrafi.
paragrafo 1
paragrafo 2
paragrafo 1

paragrafo 2

Intestazioni:
Tre lineette (-) all'inizio della riga, seguite da uno o più segni più (+), a seconda del livello del titolo e fino a un max. di 6, e dal testo dell'intestazione. Nota: Un indice può essere automaticamente creato usando la variabile %TOC% (vedi TWikiVariables). Ogni testo d'intestazione che segue !! viene escluso dalla TOC (Table Of Content); scrivi quindi =---+!! TITOLO = se vuo che TITOLO non compaia nell'indice.
---++ Sushi
---+++ Maguro

Sushi

Maguro

Neretto (Bold Tex)t:
Le parole incluse tra asterischi * verranno viasualizzate in neretto.
*Bold*
Bold
Testo italico:
Le parole incluse tra sottolineature _ appariranno in italico .
_Italic_
Italic
Neretto Italico:
Le parole incluse tra doppie sottolineature __ appariranno in neretto italico
__Bold italic__
Bold italic
Fixed Font:
Per ottenere questo effetto (fixed font) racchiudi la frase tra segni di uguale =.
=Fixed font=
Fixed font

Bold Fixed Font:
Per ottenere questo effetto (bold fixed font) usa doppi segni di uguale .
==Bold fixed==
Bold fixed
Nota: Assicurati che non ciano spazi tra il testo e i modificatori (* _ __ = ==).
_Questo funziona_,
_questo no _
Questo funziona,
_questo no _
Modo Verbatim :
Si ottiene circondando estratti di codice o altro testo formattato con i tag <verbatim> and </verbatim> .
Nota: Usa invece i tag <pre> and </pre> se vuoi che il codice HTML venga interpretato.
Nota: I tag vanno inseriti uno per linea.
<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
Linea di separazione:
Almeno tre trattini all'inizio della riga.
-------

List Item:
Tre spazi, un asterisco e un altro spazio
   * bullet item
  • bullet item
* List Item annidati:*
Sei, nove ... spazi, un asterisco e un altro spazio
   * level 1
      * level 2
  • level 1
    • level 2
Lista ordinata:
Tre spazi, un numero,un punto e un altro spazio.Sono disponibili le seguenti possibilità:
Tipo Stile generato Sequenza di esempio
1. Numerazione arabica 1, 2, 3, 4...
A. Lettere maiuscole A, B, C, D...
a. Lettere minuscole a, b, c, d...
I. Numerazione romana maiuscola I, II, III, IV...
i. Numerazione romana minuscola i, ii, iii, iv...

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

  1. Sushi
  2. Dim Sum

  1. Sushi
  2. Dim Sum
Lista di definizioni:
Tre spazi, un segno di dollaro, il termine, i segno due punti, uno spazio e la definizione del termine.
   $ Sushi: Japan
   $ Dim Sum: S.F.
Sushi
Japan
Dim Sum
S.F.
Tabelle:
Un numero qualunque di righe di testo. Ogni riga costituisce una riga della tabella composta da più campi. Ogni cella inizia e termina con una barra verticale '|'. Gli spazi all'inizio della riga vengono ignorati.
Note:
| *bold* | le celle sono visualizzate come intestazioni di colonna.
|   center-spaced   | il contenuto è centrato nella cella.
|     right-spaced | il contenuto è allineato a destra.
| 2 colspan || le celle sono visualizzate a cavallo di più colonne (multi-span).
|^| le celle con un accento circonflesso (caret) vengono visualizzate a cavallo di pi righe (multi-span rows, funzionalità aggiunta da TablePlugin).
• Se una riga contiene molto testo e volete che l'editing sia più leggibile, dividete la riga su più righe terminando ognuna con un carattere backslash '\'.
• L'accapo è determinato automaticamente dal browser.
| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |
L C R
A2 2 2
A3 3 3
multi span
A4-6 four four
five five
six six
WikiWord Links:
ParoleConInizialeMaiuscolaAttaccateInsieme ( WikiWords) producono automaticamente un collegamento ipertestuale.
Nota: Nel caso si voglia collegare un argomento in un web diverso dall'attuale web TWiki si scriva Nomealtroweb.NomeArgomento. (
WebNotify
Main.TWikiUsers
WebNotify

TWikiUsers

Link forzati:
Si può forzare un link interno racchiudendo le parole fra parentesi quadre.
Nota: Il testo tra [[ ]] può contenere spazi; il nome dell'argomento verrà formato automaticamente rendendo maiuscola l'iniziale di ogni parola e rimuovendo gli spazi; per esempio, [[text formatting FAQ]] collega l'argomento TextFormattingFAQ. Ci si può anche riferire ad altri web o usare ancore.
Nota: Per evitare che le doppie [[ facciano scattare un link, occorre anteporre alla prima un punto escamativo, cioè digitare ![[....
[[wiki syntax]]
[[Main.TWiki users]]
escaped:
![[wiki syntax]]
wiki syntax

Main.TWiki users

escaped: [[wiki syntax]]

Link specifici:
Per creare un link in modo che riferimento e testo cliccabile siano diversi, si usano parentesi quadre annidate così [[riferimento][testo cliccabile]]. Sono possibili sia link interni (es. WikiSyntax) sia riferimenti esterni (es. http://TWiki.org/).
Nota: Per i link interni si applicano le stesse regole dei Link forzati.
Nota: For i link esterni, si può semplicemente usare uno spazio anzichè le parentesi ][ per separare il riferimento dal testo cliccabile.
Nota: Si possono anche usare i nomi dei segnalibri (Anchor names), cioè [[WebHome#Segnalibro][vai a casa]] e [[http://gnu.org/#Action][GNU Action]].
[[WikiSyntax][syntax]]
[[http://gnu.org][GNU]]
[[http://xml.org XML]]
syntax

GNU

XML

Segnalibri (Ancore):
Si puo` definire un riferimento interno a un argomento TWiki (detto segnalibro) e un link a questo. Per definire un segnalibro si scrive #NomeSegnalibro all'inizio di una linea. Il nome del segnalibro deve essere una parola wiki. Per _crea un link _ a un segnalibro si usa la sintassi [[NomeArgomento#NomeSegnalibro]] . Se il segnalibro è interno alla pagina, il nome della stessa può essere omesso.
[[WikiWord#NotThere]]
[[#MyAnchor][Jump]]
#MyAnchor To here
WikiWord#NotThere

Jump

To here

Evitare un Link:
Per evitare chge una ParolaWiki diventi link basta anteporre ad essa un punto escalmativo.
!SunOS
SunOS
Disabilitare i link automatici:
I link automatici associati alle ParoleWiki possono essere disabilitati circondando il testo con i tag <noautolink> and </noautolink> .
Nota: Ogni tag deve essere da solo su una riga.
Note: Funziona anche per le tabelle ma solo se si inserisce una linea vuota tra la fine della tavola e il tag di chiusura </noautolink> tag.
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
RedHat & SuSE
Mailto: Links:
Per creare un link a un indirizzo di posta elettronica ('mailto:') associato a un testo più descrittivo, specificare l'oggetto o il corpo del messaggio, oppure omettere l'indirizzo email, si può scrivere [[mailto:user@domain descriptive text]].
[[mailto:[email protected] Mail]]
[[mailto:?subject=Hi Hi]]
Mail

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

  • TIP SUGGERIMENTO: Nelle pagine scritte a più mani, è preferibile NON USARE HTML, usare piuttosto le scorciatoie TWiki - questo per matenere il testo facile da editare.
  • ALERT! 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..
    • TIP 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
  • ALERT! 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
    • TIP 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.

  • [[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 Tip, ALERT! Avvertenza. Per maggiori informazini vedi TWikiDocGraphics.

  • 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:

  • SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
  • AccessStatsPlugin (21 Feb 2022 (V1.001), $Rev: 8713$): Provides statistics by parsing access log file, such as Apache access log
  • BeautifierPlugin (1.000): Highlights and formats code fragments.
  • CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
  • CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
  • ControlsPlugin (Dakar, $Rev: 9598$): This plugin renders a control (typically used in an HTML form) based on values defined in a topic.
  • EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
  • EmbedFlashPlugin (Dakar, 6827): Embeds an Adobe Flash file
  • ExplicitNumberingPlugin (Dakar, 6827): Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Support also numbered headings.
  • FootNotePlugin (1.021): Footnotes are notes placed at the end of a topic.
  • GluePlugin (1.51, $Rev: 11220$): Enable TWikiML to span multiple lines
  • HideInEditModePlugin ($REV$): Hide a block of text in the edit page
  • InterwikiPlugin (Dakar, $Rev: 11935$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JSPopupPlugin (Dakar, $Rev: 11930$): Creates a dynamic popup window
  • PhotoarchivePlugin (1.021): PhotoarchivePlugin creates nice image galleries
  • PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
  • RecursiveRenderPlugin (Dakar, 13602): This plugin adds <render> tags and ~macros.
  • RedirectPlugin (Dakar, 10560): This plugin allows one to produce TWiki topics that automatically redirect to other TWiki topics or URLs.
  • RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
  • SectionalEditPlugin (Dakar, 17 Aug 2021): Allows the user to break a topic into sections for individual editing.
  • SignaturePlugin (Dakar, $Rev: 0$): Supports electronic signatures
  • SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
  • SmiliesPlugin (Dakar, 8154): Render smilies as icons, like for  :-) or for = :eek:=
  • TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
  • TagMePlugin (Any TWiki, 1.032): Tag wiki content collectively to find content by keywords
  • TextSectionPlugin (Dakar, 2.0): Adds sectional rendering
  • TocPlugin (Dakar, 6827): Sophisticated table of contents generation
  • ToolTipPlugin (Dakar, 9833): create Tool Tips for links
  • TreeBrowserPlugin (v0.7): Renders a list as a collapsable/expandable tree.
  • TreePlugin (v0.6): Dynamic generation of TWiki topic trees
  • TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
  • WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
  • XinhaEditorPlugin (Dakar, $Rev: 1000$):
 

This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TextFormattingRules