[Commits] python.it commit r219 - admin/trunk/docs
commit a svn.python.it
commit a svn.python.it
Sab 23 Set 2006 18:19:01 CEST
Author: manlio
Date: Sat Sep 23 18:18:57 2006
New Revision: 219
Modified:
admin/trunk/docs/regole.ht
Log:
bozza di Antonio Vitale
Modified: admin/trunk/docs/regole.ht
==============================================================================
--- admin/trunk/docs/regole.ht (original)
+++ admin/trunk/docs/regole.ht Sat Sep 23 18:18:57 2006
@@ -5,12 +5,8 @@
Introduzione
============
-Questo documento illustra alcune convenzioni per la gestione della
-documentazione (per lo più traduzioni della documentazione inglese)
-sul sito italiano di Python.
-
-Gran parte del documento è basato su quanto scritto dal precedente
-webmaster, ma nel nuovo python.it ci sono importanti novità:
+Questo documento illustra a chiunque voglia collaborare le convenzioni da
+seguire per gestire la documentazione sul sito italiano di Python.
- Repository Subversion.
@@ -18,101 +14,98 @@
Il repository è publicamente accessibile all'indirizzo:
http://svn.python.it
- XXX TODO descrivere struttura del repository
+ La descrizione dettagliata della struttura del repository si
+ trova all'indirizzo: ::
+
+ XXX TODO: http://svn.python.it/admin/trunk/docs/struttura_repository.ht
+ da creare: si potrebbe forse automatizzarlo unendo i vari file
+ LEGGIMI di commenti presenti in ogni livello del repository.
+
+ E' disponibile un documento che spiega sinteticamente che cos'è
+ e come si usa Subversion all'indirizzo: ::
+
+ XXX TODO: http://svn.python.it/admin/trunk/docs/subversion.ht
+ da scrivere o vedere se c'è già qualcosa sul web.
-- Distribuzione dei compiti di amministrazione.
+- Amministrazione di python.it.
- Per non gravare il peso della gestione di python.it su un0unica
+ Per non gravare il peso della gestione di python.it su un'unica
persona, sono stati individuate 3 figure amministrative.
- Il webmaster mailto:webmaster a python.it, il reponsabile delle
- traduzioni/documentazione mailto:docs a python.it e, infine, il
- reponsabile degli annunci di lavoro riguardandi Python
- mailto:jobs a python.it.
-
- Oltre a questo, l'accesso in scrittura al repository è
- disponibile a tutti coloro ne facciano richiesta (purchè
- dimostrino di conoscere le convenzioni di seguito riportate).
+ - il webmaster mailto:webmaster a python.it;
+ - il responsabile delle traduzioni/documentazione mailto:docs a python.it
+ (dove i collaboratori alle traduzioni possono rivolgersi per chiarimenti
+ e per l'invio delle traduzioni);
+ - il responsabile degli annunci di lavoro riguardandi Python
+ mailto:jobs a python.it.
+
+ Oltre a questo, l'accesso in scrittura al repository è disponibile a
+ chiunque ne faccia richiesta (purchè abbia dimestichezza con Subversion
+ e adotti queste convenzioni).
Convenzioni per le traduzioni
=============================
-Queste sono "convenzioni" da adottare per le traduzioni più
-importanti, dedicate soprattutto ai principianti.
+Di seguito sono riportate le "convenzioni" da adottare per le traduzioni più
+importanti, dedicate soprattutto a chi inizia a collaborare.
-A differenza della precedente gestione, il testo da tradurre non
-sarà un semplice file di testo, diviso in piccole parti, ma il
-documento originale, con un mark per separare visivamente le varie
-parti.
+Il testo da tradurre sarà il documento originale, con un mark "%[- MARK -]" che
+evidenzia le parti che sono da tradurre/aggiornare (quelle in cui chi collabora
+interviene).
+
+Un documento dettagliato che spiega "passo passo" come intervenire su tale
+documento è disponibile all'indirizzo: ::
+
+ XXX TODO: http://svn.python.it/admin/trunk/docs/procedimento_passo_passo.ht
+ Qui è da creare un file che spieghi bene, riunendo gli interventi di
+ Manlio, come leggere il documento e come tradurre.)
-XXX TODO: spiegare meglio.
+I file da tradurre
+------------------
-
-Convenzioni generali
---------------------
+Per quanto riguarda i file da tradurre, chi vuole collaborare dovrà per prima
+iscriversi alla cosa mailing list dedicata (docs a lists.python.it) ed annunciare
+la buona notizia.
-Per la traduzione si usa il "Voi", ovvero la seconda persona plurale
-o, a seconda dei casi, l'impersonale.
-
+Sulla lista gli verranno indicati i documenti e le porzioni di
+documenti che non sono già stati presi in consegna.
-Trattamento del testo
----------------------
+Nota::
-Il testo tradotto deve essere suddiviso in paragrafi e occorre
-riportare il paragrafo in lingua originale con a seguito la
-traduzione, come da esempio:
-
-Dictionary keys are more restricted, but they can be strings,
-integers, and a few other types (more on this later). You can also
-mix and match key datatypes within a dictionary.
-
-Le chiavi dei dizionari sono molto più ristrette, ma possono
-essere stringhe, interi ed alcuni altri tipi (se ne parlerà
-diffusamente più avanti). Anche i tipi delle chiavi possono
-essere mischiati in un dizionario.
-
-eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng
-eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng
-eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng
-eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng
-eng-eng-eng eng-eng-eng eng-eng-eng eng-eng-eng
-
-ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita
-ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita
-ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita
-ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita
-ita-ita-ita ita-ita-ita ita-ita-ita ita-ita-ita
-
-ecc. ecc. ecc.
-
-Paragrafi *non* troppo *grandi*, per capirsi originale e traduzione
-preferibilmente dovrebbero stare in un'unica pagina. Comunque di
-questo non preoccupiamoci, di solito è la norma ... (Murphy? ;-) )
+ per facilitare questo tipo di coordinazione esiste il file
+ http://svn.python.it/admin/trunk/translation_status.xml
+ in cui viene mantenuta aggiornata la situazione.
-Specifico meglio ...
-
-Se il testo si presenta così:::
-
- tytytytutyurtutut
- uytutyutut
- utyuty
+Una volta scelto cosa tradurre, l'interessato può scaricare il
+documento dal repository (con un semplice browser) e tradurre la parte
+assegnatagli (usando un qualsiasi editor di testo).
-riscrivetelo tranquillamente **allineato a sinistra**, così::
+Finita infine la traduzione, il documento può essere inserito nel
+repository (se si ha l'accesso in scrittura) o passato alla lista
+(docs a lists.python.it) annunciandolo.
- tytytytutyurtutut
- uytutyutut
- utyuty
-Semplificate la vita a me e penso la semplificherà anche a voi...
-
-Anche il fatto di scrivere paragrafi non troppo grossi è
-semplicemente perché a video in console mi fa piacere confrontare
-pure la versione originale con quella tradotta, magari vi siete
-dimenticati un paragrafo ecc. ecc.
+Convenzioni generali
+--------------------
+
+Per la traduzione si usa l'impersonale oppure, a seconda dei casi, il "Voi",
+ovvero la seconda persona plurale.
+Glossario
+----------------
+Durante la traduzione tenere sempre a portata di mano il glossario che racchiude
+le traduzioni adottate per una serie di termini, disponibile all'indirizzo
+http://svn.python.it/admin/trunk/docs/glossario.xml
+
+Questo documento viene aggiornato (segnalandolo in docs a lists.python.it) ogni
+qual volta si presentino dubbi di traduzione/interpretazione di vari termini
+presenti nella documentazione.
+Siate sicuri di avere sempre la versione aggiornata!
+
+
Codice nel testo
----------------
@@ -139,34 +132,6 @@
print buildConnectionString(myParams) # blah, blah (COMMENTO)
-I file da tradurre
-------------------
-
-XXX TODO magari questi dettagli vanno in un altra sezione.
-
-Per quanto riguarda i file da tradurre, chi è interessato a
-collaborare dovrà per prima cosa annunciare la cosa sulla mailing list
-dedicata (docs a lists.python.it).
-
-Sulla lista gli verranno indicati i documenti e le porzioni di
-documenti che non sono già stati presi in consegna.
-
-Nota::
-
- per facilitare questo tipo di coordinazione, viene mantenuto
- aggiornato il file
- http://svn.python.it/admin/trunk/translation_status.xml.
-
-Una volta scelto cosa tradurre, l'interessato può scaricare il
-documento dal repository (con un semplice browser) e tradurre la parte
-assegnatagli.
-
-
-Finita infine la traduzione, il documento può essere inserito nel
-repository (se si ha l'accesso in scrittura) o passato a un
-collaboratore.
-
-
Dubbi nella traduzione
----------------------
@@ -247,15 +212,17 @@
Ultime considerazioni
---------------------
-Come già detto anche sopra... queste sono indicazioni di massima,
-per semplificare il lavoro a me senza complicarlo a voi, se vi
-trovaste ad avere qualsiasi difficoltà... non tenetene
-conto... non preoccupatevi, così come per le altre considerazioni,
-insomma pensate piuttosto a tradurre bene. :-)
-
-
-XXX TODO però è meglio se, magari, un poco si preoccupino...
-
+Tutte queste considerazioni riportate in questo documento sono utili a mantenere
+una coerenza nella gestione della documentazione per perseguire i seguenti
+obiettivi:
+- mantenere un'uniformità di stile nella traduzione della documentazione (per
+questo è importante tradurre bene oppure chiedere aiuto sulla lista
+docs a lists.python.it in caso di anche semplici dubbi...esiste per questo!);
+- semplificare ed alleggerire il più possibile la gestione della documentazione;
+- rendere più rapida la migrazione della documentazione da una versione di Python
+alla successiva;
+- grazie ai precedenti obiettivi riuscire a ritagliare tempo per implementare
+nuove sezioni che possano essere di aiuto a tutti gli utenti di Python.
Convenzioni per l'accesso al repository
@@ -264,11 +231,10 @@
Come indicato precedentemente l'accesso al repository sarà garantito a
coloro ne facciano richiesta.
-Tuttavia, per evitare il chaos, è utile un pò di autodisciplina.
-
-Innanzitutto chi avrà diritto di commit, non lo dovrà usare solo per
-inserire i proprio documenti nel repository, ma anche per gestire i
-collaboratori che tale diritto non lo hanno.
+Importante mantenere un pò di autodisciplina.
+Inoltre chi avrà il diritto di commit, non lo dovrà usare solo per
+inserire i proprio documenti nel repository, ma anche per aiutare i
+collaboratori che non hanno scelto di usufruire di tale possibilità.
Controllo dei documenti
@@ -286,8 +252,8 @@
documento http://svn.python.it/admin/trunk/translations_status.xml.
In questo documento è possibile sapere chi sta traducendo cosa.
-In caso di aggiornamenti, comunicare la cosa al reponsabile
-mailto:docs a python.it, il quale provvedere ad agiornare tale
+In caso di aggiornamenti, comunicare la cosa al responsabile
+mailto:docs a python.it, il quale provvedere ad aggiornare tale
documento.
@@ -302,8 +268,8 @@
versione, quindi in caso di errori è abbastanza scomodo andare a fare
delle correzioni.
-Come spiegato anche nel manuale di Subversione, nel messaggio di log
-non vano inseriti tutti i dettagli, per questo ci sono i diff.
+Come spiegato anche nel manuale di Subversion nel messaggio di log
+non vanno inseriti tutti i dettagli, per questo ci sono i diff.
Vanno inserite solo le informazioni essenziali come:
chi ha tradotto la parte del documento
Maggiori informazioni sulla lista
Commits