| | 1 | = Regole di sviluppo = |
| | 2 | |
| | 3 | Le regole qui descritte intendono facilitare la collaborazione degli sviluppatori e sono da intendersi come proposta. Se quindi hai commenti o correzioni da proporre non modificare direttamente questa pagina, ma contatta [http://www.xt3.it/~soujak SoujaK], che sottoporrà la questione alla squadra di sviluppo. |
| | 4 | |
| | 5 | == Sorgenti == |
| | 6 | |
| | 7 | La coerenza e l'uniformità del canzoniere sono principi che vanno applicati al canzoniere sia nella sua forma compilata, il documento finale prodotto, sia nella sua forma sorgente, i file di codice LaTeX scritti dagli sviluppatori. |
| | 8 | |
| | 9 | Ogni canzone deve includere testo e accordi del pezzo. |
| | 10 | Il testo deve essere completo di punteggiatura e maiuscole dopo il punto e nei nomi propri o importanti (es. "Giungla"). |
| | 11 | Gli accordi sono nel formato italiano (es. "Sol" o "La"); il "minore" si indica con un trattino (es. "Re-"), il "maggiore" con una croce (es. "+"); i mezzitoni sono resi graficamente da `songbook`: per il "diesis" si usa la gratella (es. "Do#"), per il bemolle una semplice b (es. "Mib"). |
| | 12 | |
| | 13 | == Deposito == |
| | 14 | |
| | 15 | È importante avere delle convenzioni anche sulla gestione del deposito, per facilitarne l'uso condiviso. |
| | 16 | Il menù "''Browse Source''" permette una [source:/ visualizzazione del contenuto del deposito]. |
| | 17 | |
| | 18 | Ogni canzone va formattata separatamente in un file TeX con codifica UTF-8. |
| | 19 | Questo deve essere nominato con il nome della canzone senza articoli, in [http://it.wikipedia.org/wiki/CamelCase CamelCase] e con estensione `.song.tex` (es. "Il canto della promessa" nel file `CantoDellaPromessa.song.tex`) e deve poi essere caricato nella cartella di categoria contenuta della cartella "`canzoni`" del deposito SVN. |
| | 20 | |
| | 21 | Il deposito è organizzato secondo le cartelle `trunk`, `branches` e `tags`, come di consuetudine nell'uso di SVN. |
| | 22 | Per informazioni su questa pratica, un argomento avanzato dell'uso di SVN, si consiglia la lettura della [http://svnbook.red-bean.com/nightly/it/svn.branchmerge.html guida alle ramificazioni e fusioni con subversion]. |
| | 23 | |
| | 24 | Il ramo `trunk` è dedicato alla versione stabile del progetto, contenente solo canzoni complete e corrette. |
| | 25 | Nel caso si desideri sfruttare il sistema di versione anche per canzoni parziali o che necessitino di correzioni si consiglia la pratica della ramificazione, il cosiddetto ''branching''. |
| | 26 | Qualora si carichino canzoni delle quali non si dispongano gli accordi è necessario [/newticket aprire un ticket] segnalandone la mancanza, in modo che altri possano completare il lavoro. |
| | 27 | |
| | 28 | Di seguito un diagramma dell'organizzazione dei file presenti nel sistema di versione: |
| | 29 | * `trunk`: cartella del progetto stabile |
| | 30 | * `canzoni`: cartella delle canzoni in formato `songbook` |
| | 31 | * `giunglabosco`: canzoni e danze Giungla e Bosco |
| | 32 | * `scout`: canzoni Scout |
| | 33 | * `messa`: canzoni per la Santa Messa |
| | 34 | * `altro`: canzoni varie progetto |
| | 35 | * `tags`: versioni etichettate del progetto |
