Usuari:Coet/Viquiestris/Documentació

Diumenge 25 de març de 2007 a les 01:57

Nomenclatura de variables i constants

1. les variables i constants intermodulars comencen per ve
2. les variables i constants intramodulars comencen per pq
3. els següents elements no duen prefix:
   1. les constants sí, no, meu, comú, ambdós, esquerra i dreta. (Emprats per facilitar la configuració dels Viquiestris.)
   2. les variables d'una funció,
   3. variables d'un objecte,
   4. variables d'un bucle,
   5. variables de manipulació de cadenes.

De manera que l'assignació de variables i constants amb el prefixe ve- només es poden allotjar en els mòduls principals. Estos són el monobook.js de cada usuari, viquiestris.js i el dels paràmetres de configuració dels Viquiestris, paràmetres.js per al la configuració bàsica i paràmetres.js per a una configuració personalitzada.

Les constants de valors booleans també s'ubiquen a viquiestris.js.

càrrega de mòduls

funció carrega()

La funció carrega() pot carregar qualsevol mòdul en javascript (.js) o stylesheet (.css). Per enrutar un mòdul s'han d'especificar tres paràmetres:

• servidor
• usuari
• mòdul

Els paràmetres hauran d'anar entre cometes separats per comes. Així, per carregar el mòdul Usuari:Pasqual/viquiestris.js del present projecte (ca.wikipedia.org) haurem d'escriure el següent codi:

carrega ("ca.wikipedia.org", "Pasqual", "viquiestris.js");

valors per defecte - enrutament simplificat

Per facilitar l'enrutament sense repetir els arguments per a cada mòdul, la funció carrega() té assignades unes valors predeterminades per al servidor i l'usuari. Com que en la majoria de casos es carreguen mòduls en llenguatge JavaScript, l'extensió del mòdul també té una valor per defecte.

Les dues primeres tenen com a predeterminades el servidor ca.wikipedia.org i l'usuari Pasqual

El mòdul té assignada per defecte l'extensió .js, fet pel qual no és necessari afegir-la. Per carregar un stylesheet serà obligat sufixar l'extensió .css al nom del mòdul.

L'exemple anterior es pot resumir de la següent manera:

carrega ("", "", "viquiestris");

A més a més si volem carregar un mòdul allotjat en un altre servidor només cal especificar el codi fins al primer punt. Per exemple escriurem "en" per a "en.wikipedia.org"

Exemples per carregar altres codis:

Usuari:SMP/strings-ca.js : carrega ("", "SMP", "strings-ca.js");

en:User:Lupin/popups.js  : carrega ("en", "Lupin", "popups");

de:User:ASM/quickedit.js : carrega ("de", "ASM", "quickedit");

prefix scripts/

Els mòduls dels Viquiestris s'han allotjat en l'espai de l'usuari Pasqual/scripts/... Per seguir l'enrutament simplificat evitant repetir arguments esta funció també té predeterminat que en el cas de carregar un mòdul de l'usuari Pasqual, llevat del mòdul viquiestris.js, s'incloga el prefix scripts/, de manera que per carregar el mòdul Usuari:Pasqual/scripts/topaz.js sols caldria indicar el següent codi:

carrega ("", "", "topaz");

funció inclou()

La funció inclou() que figura al mòdul viquiestris.js és una drecera de l'anterior funció on només s'ha d'especificar el nom del mòdul.

La funció inclou() sols serà vàlida després de carregar el mòdul viquiestris.js pel que serà incorrecte incloure-la en un mòdul monobook.js. No es recomanable el seu ús ja que es limita a carregar mòduls dels Viquiestris.

funcions condicionals de càrrega de mòduls

Les funcions inclou_propi(), inclou_si() i inclou_també() són funcions condicionals que permeten carregar un mòdul segons la valor que el propi usuari atorga a les opcions incloses en el seu mòdul de paràmetres, el mòdul de configuració dels Viquiestris.

Com la funció inclou() aquestes no poden ser introduïdes en un mòdul monobook.js ja que són definides a Usuari:Pasqual/viquiestris.js. Tanmateix, sí que es podrien utilitzar al mòdul de configuració tenint en compte el seu funcionament. Per raons d'inteligibilitat i homogeneïtat, és recomanable emprar la funció carrega(), inclosa en el monobook.js de cada usuari.

inclou_propi()

La funció inclou_propi() permet a cada usuari activar l'enrutament d'un mòdul propi amb el que es personalitza els Viquiestris.

inclou_si()

La funció inclou_si() carrega un mòdul dels Viquiestris depenent de la valor assignada.

inclou_també()

La funció inclou_també() carrega un mòdul estàndard i un de propi, o només un dels dos mitjançant la valor de l'opció.

Esta funció permet a l'usuari disposar de les eines que ell desitge.

diferències entre les tres funcions.

• inclou_propi() enruta únicament cap a l'espai de l'usuari enregistrat.
• inclou_si() enruta únicament cap a l'espai assignat als mòduls dels Viquiestris.
• inclou_també() pot enrutar cap als dos espai o un sol segons les exigències de l'usuari.
  • inclou_també(mòdul, meu) equival a inclou_propi(mòdul, sí)
  • inclou_també(mòdul, comú) equival a inclou_si(mòdul, sí)
  • inclou_també(mòdul, ambdós) combina les dues modalitats anteriors.