Strumenti Utente

Strumenti Sito


wiki:collabora
Traduzioni di questa pagina:

Collabora al manuale di ClavisNG

Il presente manuale è aperto alla collaborazione di tutti coloro vogliano contribuire al suo miglioramento. Proprio per questo abbiamo scelto di utilizzare una piattaforma wiki!

Per modificare i contenuti del manuale è sufficiente registrarsi.

Per aiutare chiunque si avvicinasse per la prima volta al mondo dei wiki abbiamo predisposto una pagina che introduce alla Sintassi wiki.

Nel caso in cui aveste già prodotto dei documenti utili a questo manuale potrete invece convertirli automaticamente, evitando così di riscriverli secondo le regole sintattiche della wiki.
Vi sono diversi strumenti per la conversione dei testi; vi segnaliamo:

Questo manuale è basato su www.DokuWiki.org, alla quale abbiamo aggiunto diversi componenti - i plugin -. Uno dei più utili è wrap, per la creazione e il posizionamento di riquadri speciali nella pagina. Consigliamo di usarlo per le note.

Registratevi e provate a scrivere: è più semplice di quanto immaginate!

Cosa è una wiki?

Una wiki è uno spazio web organizzato a cui possono collaborare più persone.
La più nota wiki è probabilmente l'enciclopedia online www.wikipedia.org, ma vi sono altri utilizzi per cui una wiki è comoda:

  • per gestire informazioni che possono variare;
  • per collegare documenti tra di loro;
  • per agevolare lo scambio di comunicazioni tra persone.

Questo manuale è un esempio concreto di wiki in quanto riguarda documenti che vengono aggiornati sia nel tempo - per riflettere i cambiamenti alle versioni di ClavisNG - sia dagli utenti stessi.

Come contribuire

  • L'aiuto più semplice e immediato consiste nel correggere errori ortografici.
    Basta registrarsi per accedere alla funzione Modifica tramite il pulsante omonimo che compare nel testo e poter così modificare il contenuto del documento visualizzato.
  • In queste pagine troverete l'icona FIXME: significa che la pagina è incompleta o comunque da verificare.
    In questo caso sarà sufficiente conoscere i rudimenti della sintassi per integrare il documento con aggiunte utili come i collegamenti o le sezioni. Potete anche inserire immagini delle schermate di ClavisNG - gli screenshot - o più semplicemente, aumentare la leggibilità del testo usando formattazioni quali grassetto, italico, sottolineato o altre ancora.
  • Stando a quanto sopra, potreste evidenziare incongruenze eventualmente riscontrate senza tuttavia apportare modifiche al testo.
    Per aggiungere l'icona FIXME basta scrivere FIXME nel punto del testo in cui si desidera effettuare la segnalazione.
  • Avete scritto uno o più documenti affini alle Guide o alle Domande frequenti?
    Inviateceli! Li aggiungeremo a questo manuale e tutti potranno beneficiarne.
    1. Salvate i file nei formati .odg oppure .doc
    2. Allegateli a una email con oggetto [CLAVIS Manual]
    3. Inviate l'email all'indirizzo assistenza@comperio.it

Scrivere senza far danni

Se siete incuriositi dalla possibilità di modificare questo manuale e volete impratichirvi prima di editare i contenuti delle pagine potete usare la pagina di prova playground.
A vostra completa disposizione, vi permette di verificate se la formattazione finale del vostro testo è quella che vi aspettate di ottenere.

Provate a inserire immagini, sezioni o collegamenti; salvate la pagina con le modifiche effettuate e solo alla fine riportate gli aggiustamenti nella pagina originaria.

Regole di formattazione

Indice

Una delle comodità di usare una wiki è di non dover preoccuparsi dell'indice in quanto viene generato automaticamente a partire dalle intestazioni.
Suddividete il testo in sezioni dando un titolo a ciascuna di esse: otterrete un indice simile al menu posizionato nella parte superiore destra di questa pagina.

Descrizioni di elementi

Usate elenchi o tabelle per agevolare la lettura di descrizioni che fanno riferimento a elementi grafici o in ogni caso, siano strutturate.

Collegamenti a FAQ o a Guide

Quando fate riferimento a FAQ - le domande ricorrenti - o a Guide - i tutorial - usate questa icona col punto di domanda inserito in un cerchio giallo, :?: , che si inserisce scrivendo :?: nel punto desiderato.

Per esempio, in questo manuale si trovano pagine relative a:

In generale, coi collegamenti specifici a FAQ o a Guide usate la seguente sintassi, sostituendo link_alle_FAQ e link_alla_guida coi rispettivi collegamenti:

:?: **FAQ:** [[link_alle_FAQ]]
:?: **Guida:** [[link_alla_guida]]

Note

Usatele per evidenziare specifiche parti di testo. Sono disponibili i seguenti tipi di nota:

Nota informativa

Approfondisce o dà informazioni aggiuntive in relazione al testo, lo integra.

Allerta

Pone l'attenzione su uno specifico passaggio: lo rimarca.

Suggerimento

Propone una scorciatoia o un differente punto di vista.

Aiuto

Risponde a una possibile domanda che il testo lascerebbe aperta.

Download

Evidenzia il o i file che è possibile scaricare.

Attività

Richiede all'utente di compiere un'attività.

Richiamo

Segnala una forte criticità.

Scrivere una nota

Usate la seguente sintassi:

<WRAP tipo_di_nota round>
=== Titolo_della_nota ===
Testo_della_nota
</WRAP>

dove i tipo_di_nota, Titolo_della_nota e Testo_della_nota vanno sostituiti in base alle seguenti indicazioni:

  • tipo_di_nota rappresenta una delle formattazioni specifiche per le note. Può assumere uno dei valori:
    • info per una nota informativa
    • important per una allerta
    • tip per un suggerimento
    • help per un aiuto
    • download per un download
    • todo per una attività
    • alert per un richiamo
  • Titolo_della_nota è l'intestazione che chiarisce il contenuto della nota.
    Potete ometterla se non la ritenete necessaria.
  • Testo_della_nota è la nota vera e propria.
    Scrivetela attinente al tipo_di_nota scelta.

Un esempio di nota informativa

Questo è un esempio di nota informativa

La nota informativa è utile per approfondire un passaggio.

Il testo che genera la nota scritta sopra è il seguente:

<WRAP info round>
== Questo è un esempio di nota informativa ==
La nota informativa è utile per **approfondire** un passaggio.
</WRAP>

In breve, per collaborare

  1. Fate pratica di inserimento o modifica di testo nella pagina di prova
  2. Se trovate un errore ortografico, correggetelo; per esempio, sostituendo perché a perchè

oppure inviate ad assistenza@comperio.it le vostre guide o note d'uso. Le integreremo per renderle disponibili a tutti.

Contribuite al miglioramento di questo manuale!

wiki/collabora.txt · Ultima modifica: 09/04/2014 18:48 da etien