From 69f9e6eca0f6b5e230bb9c2b4c892f6733f5e4d8 Mon Sep 17 00:00:00 2001 From: ru ru Date: Sun, 10 May 2020 11:01:01 +0100 Subject: [PATCH] docs: create doc/omawiki-style-guide --- it/doc/omawiki-style-guide.md | 54 +++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 it/doc/omawiki-style-guide.md diff --git a/it/doc/omawiki-style-guide.md b/it/doc/omawiki-style-guide.md new file mode 100644 index 0000000..b77a0fd --- /dev/null +++ b/it/doc/omawiki-style-guide.md @@ -0,0 +1,54 @@ +--- +title: Guida specifica allo stile della wiki di OpenMandriva +description: +published: true +date: 2020-05-10T10:00:59.389Z +tags: documentation, policies, wiki, howto +--- + +# Guida specifica allo stile della wiki di OpenMandriva +> Prima leggi [Guida generale allo stile del wiki](/doc/wiki-style-guide) +{.is-danger} + +## Regole specifiche della wiki di OpenMandriva + +> Questa pagina non è definitiva (lavori in corso), ma sarà aggiornata nel tempo non appena troverò motivo di aggiungere altre istruzioni. +{.is-info} + + +### Immagini +Gli screenshot e le comuni immagini che vengono inserite nelle pagine della wiki devono essere caricate **soltanto** nella cartella `/images`. +E' il motivo per cui la cartella è stata creata. + +I nomi dei file immagine non devono contenere: +- Spazi (utilizza un trattino al loro posto) +- Trattini bassi (usa un trattino normale al loro posto) +- Punti (sono riservati alle estensioni dei file) +- Caratteri URL non sicuri (come segni di punteggiatura, virgolette, simboli matematici, ecc...) + +Quando è possibile, rinomina i tuoi file immagine con qualcosa che abbia un significato relativo alla pagina o a ciò che l'immagine mostra. + +### Percorsi (paths) +I percorsi devono essere in lettere minuscole. Usa i trattini per separare le parole. +Non sono ammessi segni di punteggiatura ad eccezione di trattini e/o trattini bassi. +-- Nota: anche se *tecnicamente* permesso, lo standard della wiki di OpenMandriva usa i trattini normali e non quelli bassi. +Non è necessario nominare il percorso con l'intero titolo della pagina: si può, anzi si dovrebbe quando è possibile, essere accorciato. + +I percorsi non possono contenere i seguenti caratteri: +- Spazi (utilizza un trattino al loro posto) +- Punti (sono riservati alle estensioni dei file) +- Caratteri URL non sicuri (come segni di punteggiatura, virgolette, simboli matematici, ecc...) + +Siccome spesso dobbiamo scrivere il numero di versione della release (4.0, 4.1, 4.2, ecc...), al momento della creazione delle nuove pagine semplicemente converti in `40`, `41`, `42`, ecc. omettendo il punto nel percorso. + +Se la pagina è chiamata "*How to foo bar whatever*" il percorso deve essere `/doc/guides/howto-something` +Non `how-to`, né `howtos`, né `how-tos`, ecc. + +### Flusso di lavoro delle traduzioni +Per la migliore organizzazione mantieni il percorso originale inglese senza modificarlo, cambia solo il prefisso della lingua. Di conseguenza `en/home` diventerà `fr/home`, `it/home`, ecc. +Come altro esempio `/en/doc/guides/howto-list-packages-iso` diventerà `/it/doc/guides/howto-list-packages-iso` e **il titolo** della tua pagina tradotta (che è tutt'altra cosa rispetto al percorso) sarà "*Come ottenere una lista di tutti i pacchetti presenti nella ISO*" +Tieni a mente che il percorso è una convenzione, il titolo della pagina può essere qualsiasi cosa nella tua lingua. +L'azione di cui sopra è comunque semplificata e viene eseguita automaticamente cliccando sull'icona *Language* in alto a destra della pagina. + +\- +