MoodleDocs:Guia d'edició de la documentació

Dreceres ràpides: navegació, cerca

Aquesta pàgina forma part de la documentació de Moodle en català, tot i que no ha estat traduïda encara. Podeu contribuir obertament a les tasques de traducció. Podeu consultar la Guia d'edició de la documentació i també participar ens els debats del fòrum de traductors de la documentació a moodle.org

Moodle 2.4


Acabem de començar la traducció de la versió 2.x de la documentació, bolcant l'estructura i les pàgines en anglès. Aquesta és la pàgina d'ajuda als traductors i coŀlaboradors: procediments, categories, plantilles, normes d'estil, etc.

És la coŀlaboració entre tots i totes la que permetrà tenir la documentació de Moodle en la nostra llengua, fent possible que totes les persones que utilitzen Moodle en català tinguin a l'abast l'ajuda necessària per resoldre els seus dubtes i progressar autònomament. Alhora, com a comunitat oberta de programari lliure, també ens permet créixer i poder donar resposta conjunta al diferents reptes que es van plantejant: la traducció del programari, suport a la comunitat, desenvolupament...

I és fàcil! Tothom pot aportar i sumar esforços amb el col·lectiu. Es pot traduir una pàgina, o només un paràgraf... o només esmenar alguna errada. També podem anar més lluny, i crear pàgines pròpies per compartir documentació sobre algun procés, alguna pràctica...

En aquesta pàgina mirarem d'explicar les primeres passes... i enllaçarem d'altres per poder documentar altres processos i recursos.

Com comencem? Validació i permisos

No cal demanar permís... tothom pot col·laborar. Només cal tenir un usuari a moodle.org. Trobareu a la part superior dreta l'enllaç d'Inici de sessió. Si no tenim encara usuari, el podrem crear omplint un formulari i validant-lo mitjançant el correu electrònic. Hi ha un usuari únic per a moodle.org (per l'espai de suport, per reportar incidències, per la documentació en cada llengua...) però ens hem de validar cada vegada en els diferents espais per a poder treballar.

docs login.png
docs login2.png

Comencem a traduir una pàgina que encara està completament en anglès

Si treballeu amb Moodle 2.4

La documentació que tenim en anglès correspon a la versió 2.4... així que podem treballar directament:

  • Un cop validats, només cal clicar a la pestanya 'modifica'
  • Si no coneixeu la sintaxi wiki podeu obrir la pàgina Ajuda des de l'enllaç del final de la pàgina (s'obrirà en una nova finestra). Però com que estem traduint, podem modificar només el text respectant el codi (plantilles, enllaços, encapçalaments, negretes...)
  • Sí que traduïrem els literals dels enllaços. Per exemple, l'enllaç extern[https://docs.moodle.org/dev/Main_Page Developer Docs] hauria de quedar així: [https://docs.moodle.org/dev/Main_Page Documentació per a desenvolupadors] i l'enllaç intern [[Manual accounts]] així: [[Manual accounts|Comptes manuals]].
  • Si dubtem, sempre tenim (a sota) un 'Mostra una previsualització' que ens permet veure com està quedant l'edició.
  • En començar, a dalt de tot, com a primera línia, poseu un {{inici24}} que indicarà que aquesta pàgina ja ha iniciat la seva traducció i permetrà etiquetar-la i mantenir-la amb més agilitat. Això és una plantilla. Veureu altres plantilles com ara {{Courses}} (vegeu més avall l'apartat plantilles)) i també trobarem categories com [[Categoria:About Moodle]]. Aquests noms de plantilles i categories en anglès, no els traduirem, ja que enllacen altres pàgines i recursos.
  • Traduïm els textos respectant el codi de format, enllaços, etc. Les imatges, si bé és recomanable que els exemples estiguin també traduïts, les podem deixar per al final de la traducció.
  • En cas de dubte sobre com traduir un concepte, la referència ha de ser la traducció del paquet d'idioma català de Moodle. O sigui: aneu al vostre Moodle 2.4, assegureu-vos que teniu seleccionat l'idioma Català, i mireu com s'anomenen les coses. Els fitxers d'ajuda del Moodle també us poden ser d'utilitat.
  • Si en la consulta de les cadenes del paquet d'idioma trobem cadenes mal traduïdes o sense traduir podem avisar els companys de la traducció del paquet d'idioma al fòrum Traducció de Moodle al català
  • Si en acabar hem pogut enllestir la traducció de tota la pàgina, podrem substituir la plantilla {{inici24}} per {{final24}}. Això indicarà a l'administrador que la pàgina és a punt per a traduir-li el nom. Si encara falta traduir, deixarem la plantilla inicial que ja cataloga correctament la pàgina.
  • Potser trobem a la pàgina text en anglès que no ens apareix a l'edició (menús, caixes de text...). Això serà degut a que aquesta part l'insereix una de les plantilles de la pàgina. Vegeu més avall l'apartat de Plantilles.
  • Desem la pàgina. Si un cop desada veieu que us heu equivocat, sempre podeu revertir a la versió anterior clicant el botó "historial". Si el que heu fet era només un petit canvi, marqueu la casella "Aquesta és una modificació menor"

Si treballem amb Moodle 2.5

Seguirem les instruccions anteriors, canviant {{inici24}} i {{final24}} per {{inici25}} i {{final25}}, però hem de tenir present dues coses:

  • Abans de començar, haurem de copiar l'original de la versió anglesa (docs.moodle.org/25/en/nom_de_la_pàgina). En copiar-ho i substituir el text, per poc que traduïm, és important afegir la primera línia amb el {{inici25}} per que tothom tingui clar la versió de procedència (que per defecte és la 2.4).
  • Ja que hem de tenir davant el text de les versions 2.4 i 2.5, podem fàcilment comparar-los i afegir el resultat de la comparativa (que sovint serà un 'Sense canvis'). Per fer-ho, només cal que al final de la pàgina, afegim la plantilla {{canvis24}} i després indiquem les diferències entre les dues versions. Encara que no disposeu de temps, penseu que un simple 'Sense canvis' o 'Canvis en els paràmetres' o 'Funcionalitat totalment renovada' representarà un gran valor afegit per a moltes persones (que sabran si amb aquella informació tenen suficient o han de buscar en la versió anglesa).

Continuem la traducció d'una pàgina que trobem amb unes parts en català i altres en anglès

  • Com sempre, un cop autenticats, la pestanya modifica ens permetrà iniciar la traducció. Hauríem de trobar la plantilla {{inici2x}} ja que és una pàgina amb la traducció iniciada i no enllestida. Si no hi és, l'afegirem. També ens indica la versió de moodle que s'està documentant (inicialment la 2.4).
  • Treballarem com hem indicat en el apartat anterior. Només hem de tenir present que és possible que la persona que ha iniciat la traducció estigui encara treballant en aquesta pàgina. Per poder col·laborar sense duplicar esforços, podem tenir present aquests aspectes:
    • Mirant l'historial podrem copsar el moment d'edició de la pàgina (si s'està treballant actualment en ella o la traducció inicial és antiga)
    • A l'apartat de comentaris (page comments) podem trobar notes sobre el treball de traducció. Poden ser notes individuals que ha deixat una persona o podem trobar un document on diferents persones han consensuat aspectes sobre la traducció i redacció d'aquella pàgina.
    • Per últim, també tenim el fòrum de traducció de la documentació (a moodle.org) on podem compartir els nostres dubtes, suggeriments...

moodledocs modifica4.png

Si treballem amb la mateixa versió de Moodle que la traducció iniciada

És el cas més senzill... Només continuem una feina ja iniciada.

Si treballem amb una versió de Moodle superior que la traducció iniciada

La clau és poder avançar i respectar la feina feta anteriorment. Per tant, seguirem les mateixes indicacions que s'han descrit abans en iniciar una traducció. La diferència és que aquí podem aprofitar la traducció ja realitzada i que haurem de fer servir al final l'etiqueta {{canvis24}} per documentar les diferències entre les versions i així poder mantenir algun fragment traduït que ara desapareixeria. Això es pot fer de moltes maneres (alguna vegada comprovarem que les dues versions són idèntiques i només caldrà posar a la nota un 'Sense canvis' per poder documentar l'observació) però per un cas més complicat podríem procedir de la següent manera:

  • Primer copiem l'original anglès de la versió superior (docs.moodle/2x/en) a la part superior de la pàgina i afegim l'etiqueta de treball a la primera línia (per exemple '{{inici25}}'.
  • A la versió incial (ara a sota) li canviarem l'etiqueta (per exemple, '{{inici24}}' passarà a ser '{{canvis24}}')
  • Mirarem tot el que podem aprofitar de la versió inicial (en l'exemple, la 2.4), copiant el text a la versió superior (la 2.5).
  • En fer aquest primer arranjament, ja haurem pogut comprovar les diferències entre les dues versions. Podrem canviar el redactat de la versió inferior per estalviar redundàncies i deixar només les diferències. En molts casos haurem de constatar un 'Sense canvis'. En d'altres, deixarem només la part canviada (podria ser una llista de paràmetres, on han canviat alguns). Potser en algun cas, el canvi serà tan gran que caldrà deixar les dues pàgines senceres...

Esmenem una pàgina ja traduïda

Podem fer una esmena a una traducció (alguna errada, una explicació millor, afegir una captura de pantalla...) o podem voler actualitzar una versió (la traducció està en 2.4 i nosaltres treballem en 2.5). Seguirem els criteris explicats en els apartats anteriors. Com hi ha molts casos... només apuntem com hauria de quedar la pàgina:

  • Començarà amb una etiqueta que ens indica la darrera versió documentada i el seu estat. Tindrem un {{inici2x}}, o {{final2x}}, o {{cat2x}}.
  • Trobarem el text íntegre de la documentació, en l'estat de traducció que sigui.
  • Trobarem al final del text diferents etiquetes {{canvis2y}}, {{canvis2z}} on trobarem la informació relativa a les altres versions que s'han treballat (indicant si són iguals, o quins són els canvis...)

Plantilles

Les plantilles serveixen per moltes coses:

  • Marcar pàgines per al seu processament posterior. Per exemple {{inici24}}
  • Fer aparèixer textos com ara "Pendent de traduir"
  • Categoritzar pàgines, en combinació amb les categories. Per exemple {{cat24}} ( = traduïda al català, versió moodle 2.4)
  • Fer aparèixer un menú d'enllaços relacionats, per exemple la plantilla {{Courses}} genera això:

plantilla.png

Plantilles especials de la documentació en català

  • Tenim una sèrie de plantilles que afecten a la categorització general de les pàgines i als missatges generals de la documentació. No hauríem d'editar-les per aconseguir canvis puntuals en una pàgina, ja que afecten a tota la documentació.
  • Aquestes plantilles són bàsicament les que fem servir en l'edició ({{inici2x}}, {{final2x}}, {{cat2x}} i {{canvis2x}}), encara que podem trobar altres: {{cat}}, {{moodle2x}}....

Traduir plantilles que encara són en anglès

  • Per a modificar una plantilla, obrim en edició la pàgina que la conté. Al peu de la finestra d'edició, veurem el missatge "Aquesta pàgina utilitza la plantilla XXX > modificar". Cliquem a "Modificar" per a traduir-la
  • Mantenim els noms en anglès de les plantilles
  • Traduïm el text del cos de les plantilles, respectant el codi.
  • Les etiquetem per poder fer el seu manteniment. El procediment és semblant al de totes les pàgines, però en aquest cas, ha d'estar dins l'etiqueta '<noinclude>' (en moltes plantilles ja trobem aquesta etiqueta amb informació sobre la plantilla, però si no apareix, l'hem de crear) per a que no afecti a la resta de pàgines. Per exemple, una plantilla que hem traduït totalment seguint la versió 2.4 de Moodle, tindrà al final el codi <noinclude>{{final24}}</noinclude>
  • Si un cop desada veieu que us heu equivocat, podeu revertir a la versió anterior clicant el botó "historial"

moodledocs plantilles1.png

Enllaços multillengua

  • Els enllaços a les pàgines corresponents en altres idiomes s'afegeixen teclejant, per exemple
    [[es:Títol corresponent en espanyol]]
    en una pàgina en català, o
    [[ca:Títol corresponent en català]]
    a la pàgina en espanyol. Aquests enllaços es posen al final de la pàgina, a sota de l'enllaç de categoria. Els enllaços multillengua apareixen automàticament al bloc "En altres llengües".