====== Criteris editorials per als materials didàctics de l'IOC ====== ===== Aspectes generals a tenir en compte ===== * Comprovar que el **contingut** (text + imatges) estigui **ben organitzat**. Això vol dir que: * Segueix l'**estructura** marcada. * Aconsegueix la **finalitat didàctica**. * Comprovar que les frases siguin **comprensibles** pel que fa a la seva **estructura gramatical**. Si no entenem una frase en la primera lectura pot ser que estigui mal construïda, o que admeti una construcció millor. En aquest cas, la tasca de l’editor és **reconstruir-la**. * Cal evitar que les frases siguin **massa llargues**; quan ho són, sovint podem dividir-les en dues. Exemple: ::example: :title: Les administracions locals, per tal de protegir els menors en el seu temps d'oci i lliure, són responsables directes que les zones i les instal·lacions recreatives d'ús públic reuneixin les condicions adequades de seguretat i salubritat per tal que el joc afavoreixi el desenvolupament dels infants i potenciï la socialització i el respecte pel medi ambient. \\ \\ Les administracions locals, per tal de protegir els menors en el seu temps d'oci i lliure, són responsables directes que les zones i les instal·lacions recreatives d'ús públic reuneixin les condicions adequades de seguretat i salubritat. __Aquestes característiques permeten__ que el joc afavoreixi el desenvolupament dels infants i potenciï la socialització i el respecte pel medi ambient. ::: * Modificar aquells elements que puguin afectar negativament la **llegibilitat** del text, com les paraules repetides (que es poden substituir per pronoms o elisions), o la puntuació. Exemple: ::example: :title: Amb l'esquema XSD el sistema pot saber de quin tipus són les dades de cada element XML i així organitzar internament les dades, de manera que sigui possible fer recerques més eficients. \\ \\ Amb l'esquema XSD el sistema pot saber de quin tipus són les dades de cada element XML i així organitzar-__les__ internament, de manera que sigui possible fer recerques més eficients. ::: * Les frases acaben sempre amb un **punt final**. Excepcions: * En **llistes d’ítems**, quan la frase no porta verb i no és massa extensa. * En les **taules**, quan hi ha una única frase en una cel·la. * En els **títols**. * En els **títols de figura i de taula**. * Assignació de recursos tipogràfics segons la seva funció: * **Negreta** per destacar * //Cursiva// per diferenciar * ''Monospace'' per codi. * No fem servir el __subratllat__ (en el seu lloc, negreta) ni les frases escrites en MAJÚSCULES (en el seu lloc, negreta o jerarquies de títols). * La negreta i la cursiva són complementàries; d’altra banda convé no abusar de la seva combinació, per higiene visual. * Comprovar la **funcionalitat i validesa** de tots els **recursos** a informació externa: hipervincles, vídeos, documents descarregables (en el cas del web). La tecnologia evoluciona ràpid i els formats canvien, i les adreces dels llocs web es modifiquen sovint. * Comprovar que la **informació** és **correcta**. No cal aplicar-ho constantment, però sí en aquelles ocasions en què es proporcionen informacions puntuals en les quals els errors puguin ser fàcilment detectables (per exemple, l’any de naixement d’un personatge històric, la seu central d’una multinacional...). * Desplegament de **termes abreujats**. Cal que, el primer cop que apareix un terme abreujat, aquest aparegui desplegat entre parèntesis; o bé a la inversa: desplegar el terme indicant entre parèntesis la seva versió abreujada. Exemple: ::example: :title: En el cas de les modulacions AM (Amplitud Modulada) i FM (Freqüència Modulada) ... ::: * **Homogeneïtzació terminològica**: cal que triem un únic terme per referir-nos a cada concepte; en cas que autoria s’hi refereixi de diferents maneres, caldrà que en triem una. Atenció: això no fa referència a maneres sinònimes de referir-se a un concepte, que de fet seria desitjable. Exemples: ::example: :title: Ldap / LDap / LDAP \\ \\ Detallista / Minorista ::: * Gestionar les **enumeracions de conceptes** per optimitzar la seva comprensió: * En un paràgraf mitjançant separació per **comes**, quan es tracti de noms o expressions breus, i aquestes no siguin nombroses (no més de dues o tres). Especialment emprada per exemplificar (en aquest cas, no fer servir l’”etc.” o l’”etcètera”; fem servir, en canvi, els punts suspensius: “...”). * En una **llista d’ítems**. Aquestes sempre han d’anar introduïdes per una frase acabada en dos punts. Pot ser: * **De pics**: quan els conceptes no impliquen un ordre. * **Numerada**: quan els conceptes han d’anar ordenats. * Corregir **redundàncies**. Exemple: ::example: :title: El més normal sol ser... \\ \\ El més normal __és__... ::: * En les ocasions en què ens dirigim al lector, cal adaptar la **forma verbal** a l’estil que haguem definit: en el nostre cas, la **segona persona del plural**. ::example: :title: En els “Annexos” pots trobar més informació sobre... En els “Annexos” es pot trobar més informació sobre... \\ \\ La forma correcta seria: En els “Annexos” trobareu més informació sobre... ::: * **Proporcionar recursos** d’informació quan considerem que pot ser útil per millorar la comprensió o l’estudi de certes parts del material. Pot ser bibliografia, documentació en pdf, enllaços web... però sempre ho hem de sotmetre a la **decisió d’autoria**. Estem trepitjant la línia. * Comprovar que les imatges tinguin les propietats tècniques i estilístiques adequades per ser publicades. * Tècniques: Han de tenir una resolució propera als **300 dpi** si han d’imprimir-se. El format **png** és l’òptim en el nostre cas. * Estilístiques: El contingut ha d’estar ben distribuït, i ha de contenir blancs suficients perquè els seus elements respirin. La mida del text ha de ser lleugerament superior que el cos del text, però no gaire més gran. * **Evitar les exageracions** en aquells casos que no tinguin una base objectiva (és a dir, que tinguin una base de caràcter subjectiu o no demostrable en termes científics). ::example: :title: El programari genèric permet abaratir moltíssim els costos. \\ \\ El programari genèric permet abaratir __molt__ els costos. \\ \\ La instal·lació es fa a través d'un sistema d'instal·lació basat en finestres que no té cap secret. \\ \\ La instal·lació es fa a través d'un __senzill__ sistema d'instal·lació basat en finestres. ::: ===== Aspectes concrets en l'edició dels materials d'FP ===== ====Referències als propis materials==== * Títol de la família: rodona (Administració i gestió) * Títol del cicle: rodona (Administració i finances) * Títol del mòdul: cursiva (El mòdul //Gestió administrativa de personal//...) * Apartat: entre cometes (En l'apartat “Dret del treball” s'analitza...) * Secció: entre cometes (Vegeu en la secció “Adreces d'interès”...) ====Guions==== * Guió mig: * Signe menys (–14º) * Incisos (similar als parèntesis) * Guió llarg: * Diàlegs * Guionet: * Separació sil·làbica * Composició de mots (Castella - La Manxa) * Correlació de mots (unitats 3-7) Per afegir els guions mig i llarg, cal que pitjeu el botó //Caràcters especials//, i trieu d'entre els símbols que se us desplegaràn els que indiquem en la imatge següent: ::figure: :title: :footer: {{:doc:indicacions_edicio:guions.png?200|}} ::: (* L'explicació per la qual no adoptem el guió llarg per als incisos és per la seva connotació literario-acadèmica de la que volem fugir en favor d'una connotació pedagògica). ====Cometes==== * Cometes dobles altes: Aportar un significat especial, matís irònic... (La manera "correcta" de fer-ho és...) * Cometes dobles baixes: Per a indicar una citació (Segons Castañer i Camerino, l'orientació espacial és «l’aptitud per mantenir constant la localització del nostre cos en funció dels objectes»). * Cometes simples: Per explicar el significat d’un terme en una altra llengua (//Sparkling// vol dir ‘escumós’ en anglès) (* L'explicació per la qual no adoptem les cometes baixes per aportar un significat especial o un matís irònic és per la seva connotació literario-acadèmica de la que volem fugir en favor d'una connotació pedagògica). ====Altres==== * Unitat: entre cometes (...podeu consultar la unitat "Preparació i codificació comptable".) * Punts suspensius: * Al final: sense espai (La comunicació i el registre...) * A l’inici: amb espai (... del contracte de treball) * Percentatge: sense espai (15%) * Unitats de mesura: en minúscula ===== Especificacions de la guia d'imatges (només per a editors) ===== Tal com està establert el flux de treball, la guia d'imatges ha de venir preparada d'autoria. Això no vol dir que sempre hagi d'arribar correctament, pot passar que alguns elements quedin mal complimentats. Així doncs, una de les tasques de l'editor serà assegurar-se que la guia queda correctament conformada. Per fer-ho, proposem el protocol següent: * Valorar la qualitat de les imatges * Explicitar les tasques per als grafistes * Comprovar la presència i correcció dels textos **1. Valorar la qualitat de les imatges** Cal tenir present que, per norma general, les imatges que s'envien a impremta han de tenir una resolució superior a les d'aquelles que es publiquen directament en pantalla, concretament un 400% superior, aproximadament. Així, hi ha la convenció que una imatge tindrà una resolució òptima per a pantalla quan tingui uns 72 ppp (punts per polzada, //dpi// en anglès), mentre que la resolució òptima per a l'edició impresa ha de rondar els 300 ppp. Això obliga l'editor a estar atent a la resolució de base de les imatges que lliuri autoria. En aquells casos en què s'hagin lliurat imatges que se suposen definitives (fotografies pròpies o amb la llicència CC corresponent), i l'editor detecti que la resolució és insuficient per a la versió de paper, haurà de demanar a autoria que torni a aportar les imatges originals amb una major resolució. En el cas que la resolució màxima disponible sigui intermèdia (entre els 150 i els 250 ppp) caldrà valorar la conveniència d'eliminar-la del material, o de mantenir-la si aporta una informació molt necessària i/o es valora que, per les seves característiques, pot tenir una definició prou bona un cop impresa. Hi ha una **excepció** a aquesta regla: les **captures de pantalla** (és a dir, quan el contingut de la imatge mostra la interfície d'un programa d'ordinador o derivats); en aquest cas la imatge serà sempre definitiva, al marge de la seva resolució. **2. Explicitar les tasques pels grafistes** En el cas de les imatges que hem marcat com a "Proposta" (les definitives ja no es tocaran), cal definir quina és la feina que hi ha de fer el grafista. Les tasques dels grafistes poden ser tres: - "**Preparar gràfic a partir de la mostra**": qualsevol gràfic que aporti autoria s'haurà de refer i readaptar a l'estil gràfic d'aquests materials; així doncs, caldrà especificar-ho a la guia d'imatges si l'autor no ho ha fet. - "**Preparar il·lustració a partir de la mostra**": és el mateix cas que l'anterior, però aplicat a casos en què el gràfic implica una complexitat major, no automàtica (per exemple, quan hi ha figures humanes, situacions socials que no es troben fàcilment en fotografies o bancs d'imatges, etc.). Es tracta dels casos més excepcionals, ja que quasi sempre es pot optar per la fotografia o el gràfic abans de recórrer a la il·lustració. - "**Editar imatge amb els textos nous**": es tracta del fet que el grafista, tot prenent com a base la imatge aportada per autoria, readapti les anotacions que hi pugui haver (és un cas títpic el de les captures de pantalla amb anotacions) al format dels materials, tant pel que fa a la tipografia com a l'estil de línies, fletxes... **3. Comprovar la presència i correcció dels textos** En aquells casos de gràfics o il·lustracions que incorporin textos, se suposa que autoria els ha de proveir. Si autoria s'oblida de fer-ho, cal que l'editor els reclami, ja que si no ni els lingüistes podran corregir-los, ni els grafistes podran afegir els textos als gràfics en qüestió. En cas que els textos hagin arribat correctament de forma majoritària, pot ser que calgui fer-hi modificacions (no oblidem que l'editor ha d'editar també les imatges, i comprovar, per exemple, que un determinat terme sigui igual en el text que en la imatge). Si els textos són en un altre idioma, tenim dues opcions: si coneixem aquest idioma, els podem traduir directament (en el 90% dels casos l'altre idioma serà el castellà), i els lingüistes s'encarregaran de corregir-los; si no coneixem l'idioma, demanarem a autoria que ens porti la traducció en una incidència (recordeu que les incidències relatives als gràfics sempre han de constar en el contingut en qüestió, mai en la guia d'imatges, ja que aquesta guia, un cop fetes les imatges, autoria no se la tornarà a mirar). En qualsevol cas, es pressuposa que el text ja vindrà traduït directament d'autoria. ===== Especificacions per a l'edició de materials d'informàtica ===== Els materials de l'àmbit de la informàtica tenen unes característiques singulars: contenen abundants expressions en llenguatge codi (programació) així com elements especials (noms d'arxius, noms de formats, anglicismes difícils de traduir, hipervincles a internet...). És per això que, quan editem aquest tipus de materials, hem de tenir presents un seguit de directrius que es resumeixen en: * Ús del tipus de lletra monospace (tipus courier) * Ús del tipus de lletra rodona (normal) * Ús del tipus de lletra cursiva * Aplicació de vocabulari específic ==== Ús de la monospace ==== Fem servir monospace (Courier) en els casos següents: * Paràgrafs sencers en monospace per: * Expressions regulars * Codi (//script//) * Dins del text normal: qualsevol element en l'explicació que pertanyi a la línia de comandes o a l'//script// (ja sigui una classe, un valor o un punt i coma). El factor clau és identificar que l'element pertany al context de les comandes i el codi, no només diferenciar-lo del text normal. Quins són aquests elements? La llista següent mira d'englobar-los tots, però sempre hi haurà elements que no es poden preveure en genèric. Són: * Etiquetes (en llenguatges de marques): '''' * Classes * Atributs * Variables: ''var1'' * Valors: ''text/javascript'' * Funcions: ''getelementbyid()'' * Ordres: ''echo'' * Operadors: ''complex_major'' * Paràmetres * Sentències: ''UPDATE'' * Mètodes: ''CasAlumne_Adreça'' * Instruccions: ''assertTrue'' * Vectors: ''vectEstudis'' * Noms de programes a la línia de comandes o //shell// * Arguments: ''string table'' * Clàusules: ''WHERE'' ==== Ús de la rodona ==== Fem servir la lletra rodona (o normal) en els casos següents: * Noms de **programes**, encara que continguin paraules en altres idiomes, tant si són programes amb interfície gràfica (per exemple, Microsoft Word) com sense -executables des de línies de comandes- (per exemple, psql). En aquest darrer cas, poden no començar amb majúscula. Si tenim dubtes sobre la manera correcta d'escriure el nom d'un programa, la referència serà sempre la pàgina web del seu fabricant. * Noms de **llenguatges de programació**: HTML, PL/PgSQL. * Combinacions de tecles: Ctrol + D * Noms d'arxius: prova.doc * Noms de domini: pc01.inf.ioc.cat. ==== Ús de la cursiva ==== Fem servir la lletra cursiva en els casos següents: * Rutes de menús: //Opcions// / //Instal·lar nou software//. Tant és que sigui en el nostre idioma o en un d'estranger, en els dos casos aniria en cursiva. * Noms de carpetes i directoris: //bin// * Botons: //Següent// * Protocols: FTP (//File Transfer Protocol//) ==== Vocabulari específic ==== El següent llistat recull un seguit de termes que han anat apareixent en els nostres materials d'informàtica i que, per raons d'homogeneïtat i estil, cal aplicar també en les edicions i correccions dels materials que anirem produint. En la taula següent, la columna de la dreta conté la forma incorrecta d'aquests mots, mentre que en la de la dreta hi trobareu la forma que emprarem en els nostres materials. Els continguts d'informàtica (o que incorporin apartats d'informàtica aplicada a altres àmbits) tenen un tret que els fa particulars pel que fa al vocabulari, que és el fet que la majoria d'usuaris estan acostumats a sentir i emprar certa terminologia en anglès. Accions com fer un //login// o descarregar els //drivers// d'un determinat //hardware// estan a l'ordre del dia, i normalment el seu ús s'estén abans que s'hagi elaborat la traducció corresponent al català. Donat que els nostres materials tenen una vocació pràctica, malgrat traduïm aquests termes al català en alguns casos (en aquells pels quals s'hagi trobat una traducció prou vàlida), cal que el primer cop que aparegui el terme (almenys un cop per unitat) s'afegeixi el terme original entre parèntesis, per exemple: ::example: :title: Accions com iniciar la sessió (fer un //login//) o descarregar els controladors (//drivers//) d'un determinat maquinari (//hardware//) estan a l'ordre del dia. ::: Excepcionalment, hi haurà termes que no es traduiran, ja sigui perquè no s'ha trobat una equivalència terminològica al català que considerem prou descriptiva, ja sigui perquè es tracta de termes tan emprats en la llengua original que no li veiem sentit a la traducció. ::table:tab1 :title: Vocabulari específic per als materials d'informàtica :footer: :large: (bool) ^ Forma incorrecta ^ Forma correcta ^ | //link// | enllaç, hipervincle | | //script// | script (*S'accepta sense cursiva a partir d'Agost de 2013) | | //socket// | sòcol | | //host// | //host//, amfitrió | | memòria //cache// | memòria cau | | //gateway// | passarel·la | | //router// | encaminador | | //log// | //log//; en ocasions pot ser registre. | | //driver// | controlador | | //buffer// | memòria intermèdia | | //software// | programari | | //hardware// | maquinari | | //blog// | blog | | //data mining// | //data mining// | | //data warehouse// | //data warehouse// | | //event// | //esdeveniment//; però //event// quan el text original hi aparegui la paraula en cursiva. | balanç de càrrega | repartiment | | //debugging//| depuració | | //breakpoint//| punt de ruptura | ::: ==== Altres consideracions ==== * Tot seguit es mostra la forma que hem adoptat pels llenguatges de programació més freqüents: * HTML, XHTML, HTML5 * C * JavaScript * En quins casos podem editar el contingut d'un script? Quan podem corregir lingüísticament els seus termes? Els llenguatges de programació quasi sempre habiliten la redacció de comentaris que no són visibles per la màquina, dirigits als mateixos programadors, que ajuden a estructurar i entendre el contingut de l'//script//. Només en aquest cas, i única i exclusivament si s'està segur que es tracta de comentaris, podem corregir el seu contingut, i sempre afegint una nota per autoria especificant-t'ho. * Els formats dels documents s'indicaran sense el punt inicial i en majúscules (PDF, DOC) en el cas que siguin formats coneguts d'ús comú -la majoria dels casos. Excepcionalment s'admetrà el format en minúscules i amb punt al davant quan es tracti de formats especialitzats i poc freqüents per al lector mitjà (.class). * Eventualment, si així ho determina autoria, les classes poden portar accent.