Wiki Manual
Panoramica
Questo wiki è costituito da
pagine, ognuna delle quali composta da:
-
Un percorso.
-
Un titolo.
-
Un contenuto.
Il percorso identifica univocamente la pagina, e definisce l'URL da cui accedervi.
Per esempio, la pagina con il percorso
/lang/open
può essere raggiunta all'indirizzo
http://gambaswiki.org/wiki/lang/open
.
I contenuti della pagina devono seguire la sintassi descritta nel paragrafo 'Sintassi del Wiki', presentato più avanti.
Il titolo è utilizzato per mostrare un link alla pagina, e non segue la sintassi del Wiki.
Esso viene mostrato 'così come è'.
Quando c'è un link ad una pagina non esistente, il testo del link costituisce il percorso della pagina, e viene mostrato in
corsivo..
Convenzioni sui percorsi
In teoria il percorso della pagina è libero, ma deve seguire queste convenzioni:
-
Tutte le pagine riguardanti il linguaggio vengono messe in
/lang
, per parole chiave e funzioni, e in /cat
, per delle panoramiche.
-
Tutte le pagine riguardanti i componenti vengono messe in
/comp
. Il percorso di una pagina di componente è /comp/gb.xxx/classe/simbolo
. Il simbolo inizia con un punto se si tratta di un evento di classe.
-
Tutte le pagine in
/def
costituiscono il lessico.
-
Documenti vari dovrebbero essere messi in
/doc
.
Come modificare una pagina già esistente
Clicca sul link 'Modifica' in alto nella pagina.
Apparirà un box dove inserire login e password.
Questo box apparirà soltanto una volta per ogni sessione.
Dopo il login, puoi modificare la pagina e il suo titolo seguendo la 'Sintassi del Wiki'.
Non cambiare il titolo delle pagine di classi, metodi, eventi o costanti, in quanto sono generati automaticamente.
Potrebbe essere utile salvare il contenuto originale della finestra di modifica in un normale editor, per esempio gedit (o notepad), con copia e incolla.
Una volta modificata, clicca sul pulsante 'Salva' per aggiornare la pagina.
Come creare una nuova pagina
Inserisci un nuovo URL nel tuo browser. Il Wiki ti dirà che la pagina non esiste, e mostrerà un link 'Crea' in alto nella pagina.
Clicca sul link 'Crea'.
Come cancellare una pagina
Modifica la pagina che vuoi cancellare, rimuovendo sia il titolo che il contenuto della pagina.
Come tradurre una pagina nella tua lingua
Modifica la pagina, ma controlla che tu stia vedendo la pagina nel linguaggio corretto, guardando alla piccola bandiera in alto a sinistra nella pagina.
Se non c'è alcuna bandiera che rappresenti il tuo linguaggio, dimmelo. La aggiungerò.
Traduci solamente i titoli delle pagine e i loro contenuti. Non tradurre i nomi delle pagine o i link!
Come tradurre le stringhe predefinite del wiki
Le stringhe predefinite del wiki, cioè tutto ciò che non è un titolo o contenuto di una pagina, è localizzato nello progetto di script
CGI di traduzione che gestisce questo wiki.
Il sorgente di questo progetto è localizzato nei sorgenti di Gambas, insieme all'IDE e al componente database. Il suo nome è '
doc.cgi
'. Traducilo normalmente come qualsiasi altro progetto.
Pagine di immagini
Puoi caricare immagini sul wiki. Un'immagine è una pagina il cui ultimo elemento del percorso, ovvero il nome del percorso, inizia con i due punti.
Ad esempio,
/control/:combobox
è un'immagine che rappresenta un controllo casella combinata.
Per inserire un'immagine all'interno di una pagina normale, basta creare un collegamento (link):
[/control/:combobox]
.
Link simbolici
Le pagine il cui titolo inizia con il carattere '
@
' sono in realtà solo un collegamento a un'altra pagina.
Il percorso della pagina collegata è specificato subito dopo il carattere '
@
'.
Ad esempio, la pagina
Dichiarazione di metodi
è in realtà un collegamento alla pagina
Dichiarazione di metodi
e il titolo della pagina
/cat/ methoddecl
è
@/lang/methoddecl
.
Sintassi del Wiki
Questa è una breve panoramica della sintassi che devi utilizzare per scrivere articoli su questo wiki.
Caratteri di formattazione
Sintassi
|
Descrizione
|
Risultato
|
**Grassetto**
|
Evidenzia il testo in grassetto.
|
Grassetto
|
/*Corsivo*/
|
Evidenzia il testo in corsivo.
|
Corsivo
|
=*TypeWriter*=
|
Utilizza un font non proporzionato.
|
TypeWriter
|
_*Sottolinea*_
|
Sottolinea il testo.
|
Sottolinea
|
Se un carattere precede uno spazio, non può essere l'inizio di una formattazione. Similarmente, se un carattere segue uno spazio, non può essere un carattere di fine formattazione.
/ *Gambas* =Already= _Means_ BASIC! /
stampa
/ Gambas Already
Means BASIC! /
e non
*Gambas Already
Means BASIC!
I tags
html vengono mantenuti, non vengono interpretati dal wiki.
Se scrivi...
|
Ottieni...
|
M<sup>rs</sup> <font color="red">Pierce</font>
|
Mrs Pierce
|
Se vuoi utilizzare un carattere speciale come se fosse normale, oppure non vuoi inserire tags HTML, falli precedere dal carattere di escape backslash
'\'
.
Se scrivi...
|
Ottieni...
|
\**Grassetto*\*
|
*Grassetto*
|
Non fare \<\<quello>>!
|
Non fare <<quello>>!
|
Titoli, Paragrafi e Linee
Per saltare una linea nel risultato finale, per esempio per iniziare un nuovo paragrafo, devi inserire una linea vuota.
Esempio
Se scrivi...
|
Ottieni...
|
Gambas Already
Means BASIC!
|
Gambas Already Means BASIC!
|
Gambas Already
Means BASIC!
|
Gambas Already
Means BASIC!
|
Se termini una linea con un underscore (_), allora la linea verrà mandata a capo.
Esempio
Se scrivi...
|
Ottieni...
|
Gambas Already_
Means BASIC!
|
Gambas Already
Means BASIC!
|
Puoi usare questi caratteri speciali solo all'inizio di una linea.
Sintassi
|
Descrizione
|
Risultato
|
+Titolo
|
Mostra un titolo grande.
|
Titolo
|
++Titolo
|
Mostra un titolo più piccolo.
|
Titolo
|
+++Titolo
|
E così via...
|
Titolo
|
++++Titolo
|
|
Titolo
|
--
|
Linea orizzontale
|
|
==
<u>Questo è del testo *verbatim*</u>
|
Testo verbatim. Nota che l'html viene interpretato.
|
<u>Questo è testo *verbatim*</u>
|
Tabelle
Puoi usare questi caratteri speciali solo all'inizio di una linea.
Sintassi
|
Descrizione
|
[[=
|
Inizia una tabella.
|
]]
|
Termina una tabella.
|
][=
|
Separa due righe.
|
-
|
Separa due colonne.
|
La prima riga è sempre per le intestazioni. Se la prima riga è vuota, non verrà mostrata alcuna intestazione.
Esempio
Se scrivi...
|
Ottieni...
|
Se scrivi...
|
Ottieni...
|
[[
Prima intestazione
-
Seconda intestazione
-
Terza intestazione
][
1
-
2
-
3
][
4
-
5
-
6
]]=
|
Prima intestazione
|
Seconda intestazione
|
Terza intestazione
|
1
|
2
|
3
|
4
|
5
|
6
|
|
[[
][
1
-
2
-
3
][
4
-
5
-
6
]]=
|
|
Links
Questo wiki ha funzioni di autolink. L'unico modo per disabilitarlo è di usare il carattere di escape backslash!
Sintassi
|
Descrizione
|
Risultato
|
[/lang/arithop]
|
Link ad una pagina
|
Operatori aritmetici
|
[http://gambas.sourceforge.net|Sito web Gambas]
|
Link a qualsiasi URL
|
Sito web Gambas
|
Cos'è ASCII ?
|
Autolink
|
Cos'è ASCII ?
|
Cos'è \ASCII ?
|
Come disabilitare Autolink
|
Cos'è ASCII ?
|
Se il titolo di una pagina inizia con il carattere
'@'
character, allora è da considerare un link simbolico alla pagina reale, il cui percorso è dato dal resto del titolo.
Modifica
questa pagina per capire.
Sezioni Speciali
Una sezione ha inizio con una linea che comincia con il carattere
'{'
, e termina con una linea che inizia con il carattere
'}'
.
Le sezioni possono essere annidate.
Se scrivi...
|
Ottieni...
|
{syntax
Questa è la sintassi di una funzione
}=
|
Questa è la sintassi di una funzione
|
{example
Esempio
}=
|
Examples
Esempio
|
{seealso
Vedi anche queste funzioni...
}=
|
[Vedi anche
Vedi anche queste funzioni...
|
{box
Solo un box
}=
|
Solo un box
|
{warning
Attenzione!
}=
|
Attenzione!
|
{info
Nota questa cosa.
}=
|
Nota questa cosa.
|
{vb
Visual Basic non funziona come Gambas.
}=
|
Visual Basic non funziona come Gambas.
|
{tip
Un suggerimento potrebbe aiutarti.
}=
|
Un suggerimento potrebbe aiutarti.
|
-
Metti una riga vuota prima e dopo questi box.
-
Non usare a capo dentro un box seealso.
Comandi speciali
Un comando speciale è una linea che comincia con il carattere
'@'
.
Comando speciale
|
Descrizione
|
@components
|
Inserisce la lista di tutti i componenti.
|
@classes
|
Inserisce la lista di tutte le classi del componente corrente.
|
@symbols
|
Inserisce la lista di tutti i simboli della classe corrente.
|
@index /root/index/path
|
Crea un indice di tutte le pagine del percorso root specificato. Solo il primo livello di pagine viene indicizzato.
|