Ja s’ha parlat per aquí de l’editor html Quanta+, idò bé: Per aquells que no l’hagueu provat encara o simplement vos hagueu quedat al primer cop d’ull, una petita referència al fantàstic sistema de documentació que porta.
Veurem com es pot instalar la documentació més habitual en Debian (o qualsevol altre distribució de Linux) i també com integrar altres fonts de documentació electrònica HTML per tenir tot el que necessitam sembre a l’abast d’un ‘click’ 🙂
Si instalau (apt-get install quanta) i provau (quanta) el quanta, veureu que a l’esquerra teniu una columna a la que hi podeu trobar algunes utilitats…
Una d’elles és el sistema de documentació de Quanta que ens ajuda en la nostra tasca de programació posant-nos a l’abast d’una manera molt pràctica gairebé tota la documentació que podem necessitar (si mes no la més comuna).
El que passa és que quan instalam el quanta ens venen els índexos d’aquesta documentació però la documentació no s’instal·la. …És la típica “pega” famosa de Linux: …tot sembla que estigui fet a mitges 🙁
…però NO: No és que estigui fet a mitges, sino que està fet bé, perque en GNU/Linux mai es fan grans macroprojectes inacabables sino, gràcies precisament a que sempre (o quasi sempre) es fa feina amb llicència lliure, normalment podem aprofitar les feines dels altres per complementar les nostres de manera que cadascú pot dedicar-se a fer bé allò que realment sap fer.
Per això la documentació no ve amb Quanta: perque forma part de projectes diferents i així no necessitam esperar a que surti la propera versió de Quanta per tenir la darrera actualització de la documentació de PHP o de javascript. A l’apartat ‘Quanta Documentation/Welcome’ tenim enllaços a quatre paquets de documentació molt interessants en format .tar.bz2:
- html.tar.bz2 — HTML 4.0 reference
- css.tar.bz2 — Cascading Style Sheets
- php.tar.bz2 — PHP documentation
- javascript.tar.bz2 — Java Script documentation
Òbviament és preferible fer servir paquets específics per a la nostra distribució en comptes de disseminar fitxers indiscriminadament pel nostre sistema desempaquetatnt dirèctament els .tar.bz2 i executant els scripts d’instalació que porten sense cap control.
En Debian, per exemple, podem trobar els paquets:
- wdg-html-reference — Que conté la documentació de HTML i css.
- phpdoc — Amb la documentació oficial del website de php.org.
…però ens falta la documentció de javascript que no he pogut trobar cap paquet que la contengui (a lo millor hi és, però no l’he trobat). De tota manera sempre queda davallar el paquet .tar.bz2, desempaquetar-lo en un directori i fer servir l’script d’instalació o, millor encara, instalar la documentació dirèctament a ma seguint les instruccións que dono a l’apartat següent.
Fins i tot, si vos hi veis amb ganes, podeu tornar a empaquetar-lo amb l’estructura de directoris correcta i fer el paquet .deb amb l’ajuda de l’alien(1)
Actualització: Una altra manera molt senzilla de fer-se el paquet és utilitzant Checkinstall(2) (apt-get install checkinstall en Debian).
…però encara n’hi ha més. També podem…
(continua…)
Integrar la nostra propia documentació electrònica al sistema de documentació de Quanta:
…Tant si és documentació que tenim emmagatzemada localment al nostre disc dur com documentació ubicada a Internet gràcies a la forma tan senzilla amb que Quanta integra la documentació en el seu entorn.
Básicament, el sistema de documentació de quanta és una finestra incrustada del navegador Web konqueror i la columna d’index en forma de bookmarks de l’esquerra.
El contingut d’aquesta columna es crea en el moment d’arrancar quanta a partir de la informació d’uns fitxers de text amb extensió .docrc situats al directori /usr/share/apps/quanta/doc. Simplement afegint un fitxer amb aquesta extensió i que segueixi la mateixa estructura a n’aquest directori estarem indexant la nostra documentació electrònica en format html.
La sintaxi dels fitxers no necessita ni comentar-se. Si no feu un cop d’ull a un d’ells com, per exemple el quanta.docrc que vos copio a continuació:
/usr/share/apps/quanta/doc/quanta.docrc
# KDE Config File
[Tree]
Doc dir=../doc
#top level elements
Top Element=Quanta documentation
Quanta documentation=Welcome,Quanta Documentation,
Quanta Tag Dialog Definition XML
Welcome=intro.html
Quanta Documentation=maindoc.html
Quanta Tag Dialog Definition XML=quanta-dialog-xml.html
# keywords for context help
[Context]
ContextList=dialog-xml
dialog-xml=quanta-dialog-xml.html
…i fins i tot podeu fer servir una còpia d’un ja fet com a patró pel vostre.
No cal dir (però ho direm :-)) que per que aparegui la nostra nova documentació al sistema
de documentació de Quanta hem d’obrir (i per tant tancar abans si el teniem obert) el Quanta
perque llegeixi el nostre fitxer .docrc.
Anau alerta amb els paths dels fitxers. Com podeu observar podeu fer servir tant paths
absoluts com relatius, però si son relatius ho son respecte del directori base indicat com a ‘Doc dir’
(que, a l’exemple, podeu veure que també és un path relatiu, aquesta vegada respecte del directori on està
el nostre .docrc (/usr/share/apps/quanta/doc) …de manera que si volem instalar la nostra documentació en forma
de subdirectoris d’aquest, podem deixar aquesta línia tal i com està a l’exemple (que no s’ha de tocar pràcticament res, vaja! :-)).
Ala! A disfrutar!!! 🙂Lista de enlaces de este artículo:
Este post ha sido traido de forma automatica desde https://web.archive.org/web/20140625063149/http:/bulma.net/body.phtml?nIdNoticia=1246 por un robot nigromante, si crees que puede mejorarse, por favor, contactanos.