diff options
Diffstat (limited to 'xml/htdocs/doc/it/doc-developer-guide.xml')
| -rw-r--r-- | xml/htdocs/doc/it/doc-developer-guide.xml | 301 |
1 files changed, 0 insertions, 301 deletions
diff --git a/xml/htdocs/doc/it/doc-developer-guide.xml b/xml/htdocs/doc/it/doc-developer-guide.xml deleted file mode 100644 index e65cfcf24b..0000000000 --- a/xml/htdocs/doc/it/doc-developer-guide.xml +++ /dev/null @@ -1,301 +0,0 @@ -<?xml version = '1.0' encoding = 'UTF-8'?> -<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> -<guide link="/doc/it/doc-developer-guide.xml" > -<title>Gentoo Linux Documentation Developer Policy</title> -<author title="Author" > -<mail link="zhen@gentoo.org" >John P. Davis</mail> -</author> -<author title="Traduttore" > -<mail link="stefano.mazzone@tin.it" >Stefano Mazzone</mail> -</author> -<author title="Traduttore" > -Team Italiano -</author> -<abstract> - Questa guida è un HOWTO per il Gentoo Linux Documentation - Team. Questa guida tratterà tutti gli aspetti base della scrittura di - documentazione per il progetto Gentoo Linux, e sarà un punto di - contatto per nuovi sviluppatori. -</abstract> -<version>1.0.1</version> -<date>6 January 2002</date> -<chapter> -<title>Overview</title> -<section> -<title>Introduzione</title> -<body> -<p>Se stai leggendo questa guida, allora sei un nuovo sviluppatore di documentazione, oppure qualcuno che - vorrebbe contribuire al progetto. Prima di tutto, mi piacerebbe ringraziarti per - il tuo contributo al progetto Gentoo Linux. Uno dei nostri fini è di creare - documentazione che sia facilmente accessibile al pubblico. Il nostro formato - è di facile apprendimento, cosi non avrai da perdere tempo con il linguaggio XML. - Per maggiori informazioni sul nostro formato XML, vai <uri link="http://www.gentoo.org/doc/en/xml-guide.xml" >qui</uri>. - </p> -</body> -</section> -<section> -<title>Cosa tratterà questa guida</title> -<body> -<p>Questa guida tratterà i seguenti argomenti: </p> -<li>Responsabilità dello Sviluppatore </li> -<li>Convenzioni di Formattazione </li> -<li>Codifica del Documento </li> -<li>Tutorials su <c>xmllint</c> e <c>xsltproc</c> -</li> -<li>Overview del sito web Gentoo.org </li> -<li>CVS commits </li> -<li>Contact Lists </li> -</body> -</section> -</chapter> -<chapter> -<title>Responsabilità dello Sviluppatore</title> -<section> -<title>Responsabilità ed Etica</title> -<body> -<p>Anche se non sei uno sviluppatore, queste linee guida saranno valide. Se sei - uno sviluppatore, allora dovranno essere la tua Bibbia Gentoo. Ci sono molte considerazioni - in queste linee di condotta, sei esortato a seguirle, e, se necessario a contestarle. </p> -<p>La prima cosa che <i>ogni</i> sviluppatore dovrebbe fare è leggere la - <uri link="http://www.gentoo.org/doc/en/policy.xml" >Official Gentoo Linux Policy</uri>. - Questo documento è la collaborazione di tutti gli sviluppatori, e contiene alcune - informazioni estremamente importanti. </p> -<p>Come sviluppatore di documentazione, dovresti <uri link="http://www.gentoo.org/main/en/lists.xml" >sottoscrivere - </uri> la <c>gentoo-doc</c> mailing list. - Ci sono molte informazioni in questa lista, ed è una buona idea mantenersi - aggiornati su quello che stà accadendo. - </p> -<p>Quando fai commit di qualcosa sul CVS, è <e>ESTREMAMENTE</e> importante che quello che stai committando - sia perfettamente funzionante e ed esente da errori. è inutile sottolineare quanto - sia importante che i tuoi documenti siano corretti in tutti i sensi. Se sbagli nella correzione - dei tuoi documenti, e fai regolarmente il commit di XML non corretti, ci saranno ripercussioni, - come la revoca di accesso al CVS. </p> -<p>è tuo dovere, come sviluppatore di verificare e chiudere i tuoi bugs nella buglist. - Tutti hanno il loro peso nel progetto Gentoo. Se hai un dubbio, domanda ad un altro - sviluppatore, molto spesso, sarà più che felice di aiutarti. Non occuparsi dei propri - bugs è una offesa seria, e può condurre alla revoca dello status di sviluppatore. </p> -<p>Innanzitutto, rispetta i tuoi colleghi sviluppatori. - </p> -</body> -</section> -</chapter> -<chapter> -<title>Convenzioni di Formattazione</title> -<section> -<title>Formattazione</title> -<body> -<p>Come tutti i programmi ben scritti, è molto importante seguire qualche convenzione di - formattazione, mentre si scrive Documentazione su Gentoo Linux. Cominciamo dall'inizio del documento. - - <e>Ogni</e> documento che è stato scritto per il progetto Gentoo Linux deve avere questi headers - in cima. - </p> -<pre caption="Required Headers" > -<?xml version='1.0' encoding="UTF-8"?> -<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> - </pre> -<p>La prima linea, assicura che l'interprete riconosca quale versione di XML dovrà tradurre e che - schema di codifica di carattere dovrà utilizzare. Discuterò della - codifica dei caratteri più avanti in questa guida, ma da Novembre - 2002, <e>tutta</e> la documentazione Gentoo Linux adotta lo schema di codifica UTF-8 (Unicode).</p> -<p>La seconda linea specifica il percorso del foglio di conversione DTD. Una spiegazione sulla definizione - di Guida DTD và oltre lo scopo di questo documento, ma se te lo stai - chiedendo, puoi certamente fare qualche <uri link="http://www.google.com" >ricerca</uri> e tornare tra noi. - </p> -<p>La prossima linea è molto importante. Questa, stabilisce la posizione del documento, e -deve essere impostata. </p> -<note>Questo è il tag di apertura, verifica la <uri link="http://www.gentoo.org/doc/en/xml-guide.xml" > - XML Guide</uri> per maggiori informazioni. - </note> -<pre caption="Guide Link" > -<comment>Sostituisci x con il nome del tuo documento. </comment> -<guide link = "/doc/your_country_code/x.xml"> - </pre> -<p>Tutti i tags "<pre>" sono utilizzati come etichette che descrivono adeguatamente i loro contenuti. - </p> -<pre caption="Examples" > -<pre caption = "Questo è ciò che il mio pre contiene"> - </pre> -<p>Come qualsiasi programma ben scritto, dagli sviluppatori di documentazione ci si aspetta che il - codice XML sia indentato con tabulatori. In passato questo non è stato - fatto molto bene, ma è necessario che sia fatto bene in futuro. Questo - incrementa la leggibilità, ed è una pratica del Just Good Programming(tm). - </p> -<p>Sei tenuto a scrivere il tuo nome nel documento se hai apportato parecchie modifiche - allo stesso. I tag "<author>" sono utilizzati nel modo seguente: - </p> -<li>Se sei l'autore originale, il tuo titolo è "Author". </li> -<li>Se l'autore originale non è più presente, e tu hai assunto la sua posizione, il tuo - titolo è "Contributor". Se tu acquisisci il permesso più importante di assumere - lo status di autore, puoi fare cosi, mantieni l'autore originale elencato come - "Original Author". - </li> -<li>Se hai fatto cambiamenti nella sostanza del documento, il tuo titolo è "Editor". </li> -<li>Se hai fatto cambiamenti nella grammatica del documento, il tuo titolo è "Copyeditor". - </li> -<p>Organizza il tuo documento. Coordina i tuoi punti principali ed i sottopunti. La documentazione - che proviene da Gentoo deve avere un aspetto professionale. Non solo, ma aiuta anche - la leggibilità in generale. Fare un buon uso di Capitoli/Sezioni, rende la navigazione dal - drop down box molto semplice. </p> -<p>Usa correttamente le maiuscole per riconoscere il significato es. gentoo linux = Gentoo Linux, kde = KDE, gnome = GNOME, ecc. - - </p> -<p> -<e>MOLTO IMPORTANTE</e>, leggi la <uri link="http://www.gentoo.org/doc/en/xml-guide.xml" > - Gentoo XML Guide</uri>. Ci sono molte informazioni importanti in essa, e dovrebbe essere letta - da <i>chiunque</i> stia scrivendo Documentazione Gentoo Linux. - </p> -</body> -</section> -</chapter> -<chapter> -<title>Codifica del Documento</title> -<section> -<title>Unicode (UTF-8)</title> -<body> -<p>A partire dalla metà di Novembre del 2002, tutta la nuova documentazione Gentoo Linux - è stata codificata in UTF-8. Non andrò nel fantastico mondo dei caratteri di codifica, ma - UTF-8 è uno standard internazionale che è riconosciuto da qualsiasi buon browser. - Stiamo lavorando per aggiornare i vecchi documenti a UTF-8, e si spera che un giorno, - l'anno prossimo (2003), tutta la documentazione sarà compatibile UTF-8. </p> -</body> -</section> -</chapter> -<chapter> -<title>Tutorials su XMLLINT e XSLTPROC</title> -<section> -<title>Usare XMLLINT e XSLTPROC</title> -<body> -<p>Prima di effettuare il commit di qualcosa relativo alla - documentazione, i tuoi documenti <e>devono</e> essere controllati/verificati con <c>xmllint</c> e <c>xsltproc</c>. - <c>xmllint</c> è più meno un controllore di sintassi, e <c>xsltproc</c> è un motore - di conversione XML-->HTML. - </p> -<p>Usare <c>xmllint</c> è semplice: - </p> -<pre caption="Using xmllint" > -# <c>xmllint doc.xml</c> -<comment>Può essere piacevole utilizzarre lo swith --format, che rende l'output più gradevole. </comment> -</pre> -<p>Essenzialmente, se ci sono errori nel tuo documento, <c>xmllint</c>li troverà e te li mostrerà. - </p> -<p> -<c>xsltproc</c> è leggermente più difficile da usare. <c>xsltproc</c> è usato nel modo seguente: - </p> -<pre caption="Using xsltproc" > -# <c>xsltproc /path/to/the/xsl/guide/guide.xsl your_doc.xml > output.html </c> -</pre> -<p>Naturalmente, ci sono più opzioni che possono essere usate con entrambi questi tools, - e vi esorto ad esplorarli. Gli esempi che ho riportato sono proprio per verificare i tuoi documenti. - </p> -</body> -</section> -</chapter> -<chapter> -<title>Il sito web Gentoo.org </title> -<section> -<title>Overview</title> -<body> -<p>Il sito Gentoo.org è dinamico e con pagine web in evoluzione. Il nostro sito web è basato su di un sistema di - conversione XML/XSL. Se non hai notato, il nostro sito intero è codificato in XML. Il nostro codice XML è - trasformato al volo da un simpatico kit lato server chiamato Axkit. In altre parole, ogni volta che è richiesto un - documento XML, esso è trasformato al volo in HTML. Ora puoi capire perchè l'accuratezza dei documenti è cosi - importante. Se c'è un errore nella pagina XML, verrà semplicemente non mostrato. Ancora una volta, devi essere - assolutamente sicuro che il tuo XML sia perfetto. </p> -</body> -</section> -<section> -<title>Organizzazione</title> -<body> -<p>Il sito web Gentoo.org puo essere trovato nell' albero <c>gentoo-src</c> , sotto il ramo <c>gentoo-xml</c> - . Tutti i commits di documenti sono fatti in <path>gentoo-xml/doc/your_lang/</path>. Segui - la convenzione dei files che sono nella directory. Se stai effettuando il commit in una - nuova lingua che non abbiamo ancora, contatta un Senior Developer, ti assisterà. - </p> -</body> -</section> -</chapter> -<chapter> -<title>Bugzilla Commits (Non-CVS)</title> -<section> -<title>Effettuare il Commit di Documenti via Bugzilla</title> -<body> -<p>Se non hai accesso al CVS, puoi effettuare il commit dei tuoi documenti usando <uri link="http://bugs.gentoo.org" >Bugzilla</uri>. - Crea un bug, ed assegnalo al <i>docs-team@gentoo.org</i>. Allega al bug la tua guida in formato XML. - </p> -</body> -</section> -</chapter> -<chapter> -<title>CVS Commits</title> -<section> -<title>Effettuare il Commit di Documenti via CVS</title> -<body> -<p>Per i commits della nostra documentazione, noi usiamo il caro vecchio <c>cvs commit</c>. è richiesto un buon - commento pertinente nel commit. Non teniamo traccia dei changelogs dei documenti - (questo dovrebbe cambiare in futuro), cosi contiamo sui commenti presenti nei commits CVS. - Ricorda che sei responsabile di ciò che committi sul CVS. In altre parole, non effettuare il commit - di XML corrotti! Dovrai affrontare l'ira di Seemant e la mia (senza contare il resto del doc team). - </p> -<p>Se hai qualche domanda sul CVS, consulta il - <uri link="http://www.gentoo.org/doc/en/cvs-tutorial.xml" >CVS Tutorial</uri>. - </p> -</body> -</section> -</chapter> -<chapter> -<title>Documentation Contact List</title> -<section> -<title>Contact List</title> -<body> -<p>Se hai qualche domanda, consulta queste persone: - </p> -<table> -<tr> -<th>IRC Nick</th> -<th>Real Name</th> -<th>Duties</th> -</tr> -<tr> -<ti>ZhEN</ti> -<ti> -<mail link="zhen@gentoo.org" >John P. Davis</mail> -</ti> -<ti>Documentation Coordinator, Bug squasher, most everything - (tm)</ti> -</tr> -<tr> -<ti>stocke2</ti> -<ti> -<mail link="stocke2@gentoo.org" >Eric Stockbridge</mail> -</ti> -<ti>Website, Vi expert, website coordination</ti> -</tr> -<tr> -<ti>nakano</ti> -<ti> -<mail link="nakano@gentoo.org" >Masatomo Nakano</mail> -</ti> -<ti>Japanese Documentation</ti> -</tr> -<tr> -<ti>Seo</ti> -<ti> -<mail link="seo@gentoo.org" >Seo</mail> -</ti> -<ti>Korean Documentation</ti> -</tr> -<tr> -<ti>rajiv</ti> -<ti> -<mail link="rajiv@gentoo.org" >Rajiv</mail> -</ti> -<ti>Gentoo-PPC Documentation</ti> -</tr> -</table> -<p>Se ho dimenticato qualcuno, mi dispiace sinceramente! Ho incluso tutti i maggiori sviluppatori in - questo momento.Non esitare a contattarci se hai qualche domanda. </p> -</body> -</section> -</chapter> -</guide> |