Repository 32bit  Forum
Repository 64bit  Wiki

Slacky.eu:Come scrivere un articolo: differenze tra le versioni

Da Slacky.eu.
(semplificazioni)
(-)
Riga 4: Riga 4:
Si conferma quindi con <Enter> e, se la pagina non esiste, potremo iniziare subito a scrivere il nuovo articolo.
Si conferma quindi con <Enter> e, se la pagina non esiste, potremo iniziare subito a scrivere il nuovo articolo.
'''In Wikislacky potete anche utilizzare le seguenti procedure guidate ''(consigliato)'':'''
+
'''In Wikislacky sono anche disponibili i seguenti modelli di pagina ''(consigliato)'':'''
{| class="wikitable"
{| class="wikitable"
|
|

Versione delle 18:58, 2 mag 2011

Indice

Creare una nuova pagina

Per creare una nuova pagina in Mediawiki è sufficiente digitare un titolo nella barra degli indirizzi, nel nostro caso sarà:

http://www.slacky.eu/wikislack/index.php?title=Titolo che intendo dare alla pagina

Si conferma quindi con <Enter> e, se la pagina non esiste, potremo iniziare subito a scrivere il nuovo articolo.

In Wikislacky sono anche disponibili i seguenti modelli di pagina (consigliato):

Creare una pagina generica:

Creare una pagina per descrivere uno script:

Si raccomanda di dare dei titoli abbastanza lunghi e significativi ai vostri articoli, visto che il titolo è la prima cosa che indirezzerà i visitatori del wiki alla lettura degli articoli stessi.

La sintassi in breve


Per chi comincia
Nelle sezioni sottostanti sono riassunte con esempi pratici le informazioni di base che vi permettono di prendere familarità con la sintassi del wiki e le estensioni disponibili. Nella stesura di un nuovo articolo vi basta fare il copia/incolla degli esempi, completi di sorgente. Eventuali approfondimenti sulla sintassi sono disponibili nel vecchio howto: Wikislacky:Come scrivere un articolo (old version)

Paragrafi e intestazioni

Il "contenitore" usato in questo wiki è Mediawiki, lo stesso di Wikipedia. Uno degli elementi portanti di questo sistema, nato proprio per documentare, è l'uso dei paragrafi o header (intestazioni). Dalle intestazioni, Mediawiki ricava automaticamente l'indice. Per creare un buon articolo è fondamentale partire da un buon indice, quindi l'indice è la prima cosa da abbozzare. Un esempio concreto di sorgente dovrebbe chiarire il tutto:

Sorgente Risultato
= Il computer =
 
== La scheda madre ==
=== CPU ===
=== RAM ===
=== Hard disk ===
 
== Alimentatore ==
 
== Case ==
1. Il computer
1.1 La scheda madre
1.1.1 CPU
1.1.2 RAM
1.1.3 Hard disk
1.2 Alimentatore
1.3 Case

Elenchi puntati e numerati

Creare elenchi puntati e numerati è molto semplice. Il risultato grafico (forma dei bullet, ecc.) dipende dalla skin usata. Esempio diretto:

Sorgente Risultato
*Root
**Level 1
***Level 2
 
 
#Root
##Level 1
###Level 2
 
 
:Root
::Level 1
:::Level 2
  • Root
    • Level 1
      • Level 2
  1. Root
    1. Level 1
      1. Level 2
Root
Level 1
Level 2

Inserire dei link

L'inserimento di link nel testo dell'articolo avviene semplicemente inserendo nomi e percorsi tra parentesi quadre. Esempio diretto:

Sorgente Risultato
Link interni
[[Documentazione|Ritorna a pagina principale]]
Ritorna a pagina principale
Link a sezioni interne al documento
[[#Paragrafi_e_intestazioni | Vai a "Paragrafi e intestazione"]]
Vai a "Paragrafi e intestazione"
Link esterni
[http://www.slacky.eu Slacky Community]
Slacky Community

Controllare comunque le estensioni permesse e le raccomandazioni in Carica un file

Costruire tabelle

Per costruire delle tabelle si possono usare i tag HTML, ma è meglio usare la sintassi Mediawiki. Un semplice esempio:

Sorgente Risultato
{| class="wikitable" ** Inizio tabella e stili **
! Header1 ** Intestazioni **
! Header2
! Header3
|- ** questo crea una nuova riga **
| Cell 1 ** Contenuti **
| Cell 2
| Cell 3
|}
Header1 Header2 Header3
Cell 1 Cell 2 Cell 3

Nota: ** tra asterischi i commenti, da rimuovere **

Inserire immagini

Le immagini possono essere caricate con l'apposito link Carica un file, ma generalmente si procede in un modo più diretto, stile wiki: si inserisce il wiki-tag nella posizione voluta del testo, si salva la pagina, quindi si carica il file cliccando sul riquadro ancora vuoto. In questo modo il file che avete sul PC viene rinominato al caricamento. E' buona cosa specificare un nome lungo e significativo, possibilmente legato all'articolo.

Sorgente Risultato
[[Image:Esempio sintassi immagini.jpg|right|thumb|300px|Didascalia]]
(cliccando sul link a destra si attiva la procedura di caricamento)

La sintassi proposta è quella più adatta al nostro wiki, in particolare le immagini allineate a destra rendono migliore l'impaginazione. Per approfondimenti si rimanda alla pagina di aiuto:images di Mediawiki.

Nota: l'esempio si riferisce di proposito ad una immagine ancora da caricare

Attenzione, non inserire immagini di cui non si hanno i diritti di pubblicazione

E' bene assicurarsi che le immagini che carichiamo siano esenti da vincoli di pubblicazione su questo wiki. Un buon metodo per evitare problemi è di scattare in proprio una foto dell'oggetto che vogliamo raffigurare anche se ciò non ci mette totalmente al riparo da sorprese (es: foto di un quadro = foto di opera d'arte derivata). Un posto in cui cercare immagini già controllate sotto il profilo dei diritti di pubblicazione è Wikimedia Commons.

Caricare dei file

Per i file da allegare all'articolo vale quanto già scritto per le immagini: conviene prima inserire il tag che specifica il file da caricare, quindi, salvato l'articolo, caricarlo:

Sorgente Risultato
[[File:Nome lungo e significativo.estensione]]
File:Nome lungo e significativo.estensione

(cliccando sul link sopra si carica il file)

Controllare comunque le estensioni permesse e le raccomandazioni in Carica un file

Usare un Template

I Template (modelli di pagina) sono un ottimo strumento per creare delle strutture, anche complesse, con stili personalizzati e riutilizzabili in più articoli. Vediamo un esempio di utilizzo:

Sorgente Risultato
{{Hint
|Esempio
|Questo è un esempio di utilizzo di un Template
}}
Esempio
Questo è un esempio di utilizzo di un Template

I modelli presenti in questo wiki sono raccolti qui: Modelli disponibili

Assegnare una categoria

E' molto importante assegnare una categoria all'articolo in modo che possa essere ritrovato con facilità. La sintassi è la seguente:

[[Category:Install e Upgrade]]

Le categorie da usare sono, di norma, quelle riportate in Pagina principale.

Nota: fare attenzione al maiuscolo/minuscolo, Mediawiki potrebbe essere "case sensitive". Il wiki-tag Category andrebbe collocato a fine pagina.

Firmare l'articolo

Nel caso si volesse firmare l'articolo con il proprio nickname cliccabile, data e ora, basta aggiungere 4 tilde consecutive:

~~~~

Le estensioni disponibili


Esempi con le estensioni
Di seguito alcuni esempi pratici di utilizzo delle estensioni attualmente disponibili in wikislacky

Pre - Testo preformattato

L'estensione permette di inserire del testo al quale non verrà applicata la formattazione HTML. Si usa quando si deve inserire un testo sorgente di esempio da visualizzare in un riquadro. Comunque per riquadrare una sola riga (o poche vicine) in Mediawiki è sufficiente intestare la riga con uno spazio vuoto. Da notare che l'estensione SyntaxHighlight può produrre lo stesso risultato di <pre>.

Uso dell'estensione:

 <pre>
 ... linee di testo ...
 <pre>

SyntaxHighlight GeSHi

Questa estensione è veramente utile per la documentazione di script e programmi sorgente in generale. I linguaggi supportati sono un'infinità, quelli più comuni in questo wiki sono sicuramente:

c, cpp, asm, perl, python, ruby, java, php,
bash, diff, make, cmake, autoconf, xorg_conf, text

Uso dell'estensione:

 <source lang="linguaggio">
 ... codice sorgente ...
 </source>

Esempio di colorazione bash script /etc/rc.d/rc.dhcpd:

#!/bin/sh
#
# /etc/rc.d/rc.dhcpd
#
# Start/stop/restart the DHCP server.
#
# To make DHCP daemon start automatically at boot, make this
# file executable:  chmod 755 /etc/rc.d/rc.dhcpd
#
 
case "$1" in
   'start')
      /usr/sbin/dhcpd ;;
   'stop')
      killall -s 9 dhcpd ;;
   'restart')
      killall -s 9 dhcpd
      /usr/sbin/dhcpd  ;;
   *)
      echo "usage $0 start|stop|restart" ;;
esac

Citazioni e riferimenti

L'estensione Cite si usa in particolare per le citazioni a fondo pagina (come in un libro), ma è anche molto utile per "piazzare" delle ancore cliccabili nel testo. Ecco un esempio:

Il sorgente:

<big>According to scientists, the Sun is pretty big.<ref name="miller"/>
The Moon, however, is not so big.<ref name="smith"/></big>
 
'''References:'''
 
<references>
<ref name="miller">E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.</ref> 
<ref name="smith">R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.</ref>
</references>

Il risultato:

According to scientists, the Sun is pretty big.[1] The Moon, however, is not so big.[2]

References:

  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.
  2. R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.



Strumenti personali

Varianti