Docbook szisztematikus megközelítése dokumentáció nyílt rendszerek
Regisztráció a konferencia
Felügyeleti felhasználó megtalálja az interneten rengeteg dokumentum azonos típusú navigációs oldalak között linkek segítségével Előző, Következő, Fel, Fel, és egy és ugyanazon eszköz lehet kínálni különböző formátumokban: lépcsőzetes HTML, egyetlen HTML, PDF (1. ábra).
Egyértelmű, hogy a dokumentumok különböző formátumokban létrehozott egy kézből. Mi ellen? Ahhoz, hogy megtudja, nézd meg a „belek” - a HTML kódot:
charset = ISO-8859-1 »>
A HOGYANok adunk Samba dokumentációt az évek során.
Mi olyan vonzó ez a technológia és akinek ez hasznos lehet? Tény, mert van egy csomó programot szövegszerkesztő (kezdve a Microsoft Word), kiadványszerkesztés (pl Xerox Ventura Publisher, az Adobe PageMaker) és jelölő nyelvek (unix nroff / troff, TeX / LaTeX, ugyanaz a HTML). Annak előnyeit örökölt DocBook XML:
- Egy egyszerű HTML-szerű jelölőnyelv;
- világos elválasztása tartalmát és elrendezését, ami nem a HTML-;
- egy erős normák és támogató eszközök szövegek feldolgozásakor (XSLT, XSLFO, XPath);
- függetlenség kereskedelmi gyártók és a szabványok, a rendelkezésre álló nyílt forrású eszközök;
- bővíthetőség.
Ezen túlmenően, a HTML nem egyértelműen hivatalossá. Persze, van egy hivatalos szabvány, a W3C, de a valóságban, böngészők és Web-mester kiterjedt alkalmazása egyedi minták. Ez megnehezíti az automatizált feldolgozása HTML-dokumentumok, amelyek nélkül nem lehet csinálni, amikor a vállalati környezetben.
Támaszkodva XML DocBook hiányzik számos hátrányuk HTML-eszközkészlet. Így az egyetlen szerkezeti tag van jelen DocBook. Sok közülük (400), de a futás csak pár tucat helyett
stb A dokumentum formátum mereven tartjuk, például minden nyitó címke köteles betartani a zárás. Ellenkező esetben nincs program egy ilyen dokumentum nem kerül feldolgozásra. Végül, miután a jól strukturált dokumentum beviteli igazítani automatizált feldolgozása, a kiadott dokumentum, összeállított vállalati stílus, HTML, PDF, WinHelp vagy egy másik, ez a kérdés a technika - annak ellenére, hogy van már egy nagy részét a műszerek, szabványos XSL- processzorok.
Ez egyszerű és intuitív.
szerszámok
Átalakító - egy XSLT-processzor és szkripteket. Mindkettő kapható részeként eloszlása gyakorlatilag többé-kevésbé modern változata a Linux operációs rendszer. Scripts állandóan fejlesztik, például a verzió 1,68 javítások hibákat az index orosz, így azok azonnal nem frissíti letölti a legújabb verziót (docbook.sourceforge.net/projects/xsl), és telepíti az archívumot a szerver.
Átalakítani az eredeti dokumentumot a kimeneti formátum szükséges, hogy tárcsázza a következő parancsot:
$ Xsltproc /usr/docbook/xsl-stylesheets/html/chunk.xsl article.xml
- xsltproc - úgynevezett programot, XSLT-processzor (az egyik a sok közül);
- A / usr / docbook / XSL-stíluslapok - ez az a hely, a kiszolgáló, amely az XSLT-script;
- html / chunk.xsl - egyik megvalósítási módja szerint a generáció a kimeneti dokumentum;
- article.xml - eredeti dokumentum DocBook.
Kész! Az aktuális könyvtárban kell megjelennie HTML-fájlokat, egy-egy része a cikket, és az általános tartalomjegyzéket.
Először is, a legegyszerűbb a testreszabási - a választás a kezdete a forgatókönyvet. A korábbi példa, hogy html / chunk.xsl - ez a legkeresettebb, de nem az egyetlen. Több lehetőség, hogy ellenőrizzék a kimenet megjelenését dokumentum paramétereket, melyek esetében csak chunk.xsl több mint 200. példa: kényszeríteni a csúcspontja egy külön fájlban az első szakaszban a dokumentáció és a kódolást a kimeneti dokumentum windows-1251 helyett UTF-8 által elfogadott, alapértelmezett:
$ Xsltproc --param chunk.first.sections 1
> --stringparam chunker.output.encoding windows-1251
> /usr/docbook/xsl-stylesheets/html/chunk.xsl article.xml
Az igazi munka akar állítani legalább egy tucat paraméter, de csinálni parancssorból kényelmetlen. Ezért, ha lehet használni az úgynevezett «XSL-vezető.” Ennek eredményeként a manipuláció biztosítani tudjuk, hogy a generált HTML-oldalak teljes mértékben megfelelnek az ötleteket esztétika és ergonómia, vagy egyszerűen csak egyezik a vállalati stílus (ábra. 2).
Maximális rugalmasság a használatát XSL-scriptek lehet elérni, ha a helyettesítő nem csak az értékeket a paraméterek, hanem a kód kezelésére használt e vagy más címkéket. Például, ha Ön nem elégedett azzal, ahogyan dolgozott egy sablont, akkor egyszerűen átmásolni a fájlt a / usr / docbook / XSL-stíluslapok a sofőrjének, és az arra való joga, ahogy jónak látja. Sablonok, amit írsz, blokkolja import. Hasonló módon nem lehet csak megváltoztatni a feldolgozása meglévő címkéket, hanem adja el!
Elképzelhető, hogy a dokumentum lenne a szempontból XML, de nem felel meg a séma DocBook. Például, akkor kitalált felhasználó címkéket. XSL-scriptek viselkednek nagyon okosan: tartalmazza ezeket a címkéket szöveges esik a kimeneti dokumentumban, de ez lesz piros színnel kiemelve. Most, hogy írjon egy felvezető (xsl: template) a találmány szerinti címkét, és illessze be a sofőr, és még jobb - importálhatók egy fájlban.
kimeneti formátum
Konverzió DocBook HTML szabvány XSL-scriptek dolgozott ki majdnem tökéletesen. Nem probléma is a generáció a Windows HTML Help. HTMLHelp / htmlhelp.xsl script létrehoz egy sor HTML fájlokat és megfelelő szolgáltatást. Ezután futtassa Súgó-compiler hhc.exe, amelyet a Microsoft forgalmaz szabadon, és generált HTML Help.
FOP kereskedelmi processzorok, talán a legjobb messze van a termék az RenderX XEP ára körülbelül $ 300. Ez egy érett termék és a problémák az orosz nyelv nem az az előnye, hogy az egész csapat az orosz nyelvű fejlesztők. Sajnos, a „out of the box” cirill betűk nem működött, és nincs utasítás, amely érzékelhetően elmagyarázza, hogyan kell engedélyezni őket. De ha kitalálta, hogy a dolgok folyton simán, van még transzferek az orosz szöveget.
A második alternatíva - egy közbenső átalakítás a latex. A szabványos XSL-szkriptek nem támogatják, de van, például db2latex - egy csomag XSL-scriptek, amelyek lehet, hogy tegyenek meg minden szükséges. „Out of the box”, ez nem működik az orosz betűk - a konfigurálni kívánt XSLT-vezető. Kivált dokumentum LaTeX formátumban lehet konvertálni PDF pdfLaTeX dolgoz fel a parancsot, a személyzet elérhetővé a Linux. Ezt követően az orosz szöveg jelenik meg, de az eredmény messze nem kielégítő: a hibák a cselekmény, a nyomvonal a szöveget a PDF könyvjelzők stb Szintén db2latex nem támogatott morerows tulajdonság - a táblázatokban lehetetlen, hogy összekapcsolják a függőleges sejteket. Emellett kiderült, hogy annak érdekében, hogy ezt a lehetőséget, hogy az elme nem tud meglenni nélküle alapos tanulmányozása TeX / LaTeX.
Végül, de nem utolsósorban a forrása a probléma a cég PDF Adobe - nehézségek a támogatást az orosz nyelv van szinte valamennyi terméke: a Photoshop, és a FrameMaker, és az Acrobat. Úgy tűnik, többek között a fejlesztők az Adobe nincsenek bevándorlók, a volt Szovjetunióban. Itt van, amit a cég a Adobe Acrobat 6-os verzió: „Amikor létrehoz egy PDF HTML-fájlokat, begépelt szöveg cirill betűk, helyébe egy hibás karakter vagy üres.” Más szóval, ez nem működik - és kell!
Ennek eredményeként arra a következtetésre jutottunk, hogy az egyetlen olyan egyszerű és megbízható operációs változata PDF generációs orosz - jelentése Acrobat Distiller, amely magában foglalhatja a használt betűtípusok a generált dokumentum, amely garantálja, hogy olvasás bármilyen számítógépen, nem csak a mi fel van szerelve orosz Windows-verzió.
Technikai író
Dokumentációt hagyományosan elsősorban érteni a nyomtatott dokumentum vagy könyv. De ma, a szükséges dokumentáció és a legtöbb esetben a nyomtatott és elektronikus formában. Ha már van egy dokumentum, amely lefektetett nyomtatáshoz, a legegyszerűbb (és sokoldalú) módja annak, hogy egy elektronikus változatot - az Adobe Acrobat Distiller. Ön kap egy PDF, amelyet el lehet égetni a CD-re vagy fel az oldalon. Azonban a PDF - nem őshonos Internet formátumban. A dokumentumok nem lesz szerves része a helyszínen, és zavarja a felhasználót a hosszú távú terhelés nem lesz képes összekapcsolni a standard design a helyén (sapkák, panel, szolgáltatások), de nehezen használható linkeket és keresőrendszer oldalon.
Az elvi probléma megközelítése DocBook dokumentumok több formátumban is a legilletékesebb: a forráskód, egyáltalán nem kötődik a kimeneti formátumot, és vezérli a paramétereket a program kimenetet generál dokumentumokat. Egy gyakorlati végrehajtása generációs HTML-dokumentumok már megoldódott, a PDF még nem teljesen sima, de még mindig a probléma megoldódik is.
Ezen túlmenően, a műszaki író javításra szorul: automatikus számozása szakaszok, táblázatok, ábrák, automatikus generációs tartalomjegyzékkel, ábrajegyzéket indexét. Mindezeket a problémákat DocBook- kezeli.
együttműködés
Nagyon high-tech, alacsony rezsi. Ugyanakkor nem zavarja egymást, a dokumentum lehet futtatni egy nagy csapat.
Tartalom, felépítése és szerkezete
Az egyetlen dolog, ami nem illik hozzánk dolgozni DocBook- - ez a „farok» SGML, amely megjelent a fő fájl a szervezet a linkeket szakaszok a dokumentumot. Először is, minden fájlt meg kell említeni kétszer (egyszer meghatározó, a második gyakorlat); de ahol a párhuzamos, hibák. Másodszor, a munka bonyolult szerkezetű szervezett megfelelően. Ebben a példában csak két töredék, a tényleges dokumentumok szoftver termékek állhat száz töredékek a jelentős mélységű egymásba szakaszok. Van egy természetes vágy, hogy a szerkezet látható. De a legtöbb világosan tükrözi a hierarchikus struktúrát, amely a dokumentum DocBookról Nyilvánvaló, hogy a könyvtár hierarchia.
Ezért már végre a következő séma munka dokumentumokat elágazó DocBook-. Szakasza értelmében bármely szinten, egy külön könyvtárba. Tartalom részben illeszkedik XML-fájl, amely abban rejlik, ezt a könyvtárat, és részlegeik vannak az alkönyvtárak. Összeszerelése a darabokat automatikusan megy végbe egyszerű programot írt héj és XSLT. A megfelelő sorrendben a szakaszok segítségével érjük el explicit attribútum «nr» a címkéket. SGML-nyilatkozat feleslegessé válik.
Ez utóbbi fontos szempontjából nem csak a technológiai (a végén, egymást átfedő részei a nevek tudta kezelni), de elvi. Ha szükséges, hogy a szétválasztás tartalmi és formai - többé-kevésbé közös helyen, mentünk tovább, és elért A tartalom, felépítése és szerkezete.
teljes dokumentáció
XML-stratégia
DocBook XML-alapú technológiákat. Muszáj, hogy félj, ha ezek a technológiák új neked? Véleményünk szerint az XML megérdemli, hogy minden IT cég már kialakult ellene használja a saját stratégiáját. XML - nem egy hóbort, bár nem egy varázspálca. Ez egy hatékony megoldás széles körű problémák, amelyek még mindig rosszul ellenállt automatizálás. Számítógépek már régóta alkalmazkodott a tárolását és feldolgozását, egyrészt, mereven strukturált és a mennyiségi adatok, és a másik - félig strukturált adatok, például szöveges dokumentumokat. Az erőssége az azonos XML, hogy lehetővé teszi, hogy hatékonyan megszervezni és manipulálni quasistructured információ: specifikáció és API; fogyasztói igények és a használat módja; vizsgálati adatok és forgatókönyvek; Gyakori kérdések; képzések és előadások, példákkal és tesztekkel. Az ilyen információ általában egy gyűjtemény tárgyakat azonos felső szintű szerkezetét és szöveges leírások alacsonyabb szinteken. Ezzel szemben a bemutatása az ilyen információk formájában szöveg, XML lehetővé teszi, hogy az tükrözze a szerkezet. Másrészt, míg az XML adatbázisok ez sokkal nagyobb rugalmasságot, míg az információ mennyisége kicsi, és a hatalom az adatbázis szükséges. Számos példa van a sikeres használat DocBook az ilyen problémákra. Például az oktatási előadás formájában mutatják be az XML-fájl, amely automatikusan generált: csúszdák előadók; tájékoztatók a tanulók számára; vizsgálati adatok laboratóriumi munkát; vizsgálat problémákra, kérdésekre, és teszteket.
Így a technológiailag fejlett cégek docbook szerves kiegészítője a már használható az XML-alapú alkalmazásokat, és a többiek - a technológiai park, amely hozzájárul az XML.
Anatolij Belychook ([email protected]), Maria Nikolaeva ([email protected]), Nagyezsda Matveeva ([email protected]), Stanislav Friedkin ([email protected]) - a vállalat alkalmazottai "Business Console" (Moszkva) .
DocBook szabvány
Tárgyi DocBook - az XML-séma (DTD) és szkriptek (DSSSL, XSLT). Ők szabadon hozzáférhető: ezek használata engedélyezett bármilyen célra, módosítására és szaporodni korlátozások nélkül és külön engedély. Az egyetlen dolog, ami tilos, összhangban a szellem a közösség Open Source - az, hogy korlátozza a másik szabad felhasználása és forgalmazása DocBook vagy annak módosításait.
Szabványos a népszerű előadás DocBook- iránymutatást [1, 2], amely lehetővé tette a „selection”: kezdve mintegy 400 tag csökkent 100 legelterjedtebb (és valószínűleg ez sokkal több, mint valóban szükséges). XSLT-eszköz beállításait és paramétereket, amelyek befolyásolják a kimeneti típus, szüksége lesz egy útmutató [3] és hivatkozás [4].
irodalom
- Norman Walsh, Leonard Muellner. DocBook: A végleges útmutató (www.docbook.org).
- Norman Walsh. Egyszerűsített DocBook: A végleges útmutató (www.docbook.org).
- Bob Stayton. DocBook XSL: The Complete Guide (www.sagehill.net/docbookxsl).
- Norman Walsh, Bob Stayton, Jirka Kosek DocBook- XSL-stíluslap referenciadokumentációt (docbook.sourceforge.net/release/xsl/ áram / doc / reference.html).
DocBook honlap
Egy új alkalmazás a DocBook - létrehozását web-oldalak. Az ötlet a következő: a DocBook- tag, akkor létrehozhat egy XML-fájl minden oldalon a telek (a gyökér tag) és egy XML-fájl, amely tartalmazza a tartalomjegyzék. Ezeket a fájlokat majd feldolgozni a XSL-scriptek, így egy sor HTML-oldalak teszik ki a helyszínen.
A termelés minden oldal automatikusan podverstyvaetsya panel egy hierarchikus tartalomjegyzék az oldalon, a tételeket, amelyek akkor bővíteni és összeomlik. Szintén a tartalomjegyzék automatikusan kiemelte az új és a megváltozott oldalakat. Érdemes megjegyezni, hogy a linkeket az oldalak között a helyszínen készült nem a szokásos, de a segítségével docbook tag. Ez biztosítja, hogy az összes belső link az ebből eredő helyén lesz helyes.
A fő előnye ennek a technológiának, mint DocBook- egészében - a következetes szétválasztása tartalmakat design. Például www.docbook.org oldalakon. www.docbook.ru. tette ezt a technológiát, meg tudományosan szigorú. De a DocBook- szokásos beállítási módszerek, lehetséges, hogy gyökeresen megváltoztassa a tervezés és az elrendezés a webhely teljesen anélkül annak tartalmát.
Ossza meg képeit barátaival és kollégáival
Meghívó Howard Rheingold, mint vendég a következő kérdés a „nyílt rendszer” különleges jelentéssel bír számomra. Úgy történt, hogy mi jól ismeri őt; Már évek óta részt vesz a teremtett
Az exponenciális növekedés az interneten, hol mindent, persze, hallottam, nem tarthat örökké, vagy csak várja az összeomlás az információkat. A kötet a felhalmozott információk már olyan nagy, hogy „megfullad” Internet keresési eredmények között.
Analitikai programok ma már egyre elsődleges eszköze hatékonyságának javítása a vállalkozások