Регистрация за конференцията

Надзорният потребител може да намерите в интернет на много документи с един и същ тип навигация между страниците чрез връзките Предишна, в непосредствена близост, нагоре, Топ, и един и същ инструмент може да се предлагат в няколко формата: каскадни HTML, единствен HTML, PDF (Фигура 1.).

Ясно е, че документите в различни формати, генерирани от един източник. От какво? За да разберете, погледнете "смелостта" - в HTML кода:

набор от знаци = ISO-8859-1 »>


на ръководства добавя към Samba документация през годините.

Какво е толкова привлекателна тази технология и на кого тя може да бъде полезна? В действителност, тъй като има много програми за обработка на текст (като се започне с Microsoft Word), предпечатна (например Xerox Ventura Publisher, Adobe PageMaker) и езици за маркиране (UNIX nroff / Troff, TeX / LaTeX, същата HTML). Неговите предимства наследени от DocBook XML:

• прост HTML-подобен език за маркиране;
• ясно разделение на съдържание и оформление, което не е за HTML;
• мощен набор от стандарти и подпомагане инструменти за обработка на текстове (XSLT, XSL-FO, XPath);
• независимост от търговски производители и техните стандарти, наличието на инструменти с отворен код;
• разтегливост.

В допълнение, HTML не ясно формализирани. Разбира се, има официален стандарт на W3C, но в действителност, браузъри и уеб-майстор-широко използване на нестандартни конструкции. Това усложнява автоматична обработка на HTML-документи, без които не можеш да направиш, когато става въпрос за корпоративна среда.

Като разчита на XML за DocBook липсва редица недостатъци, присъщи на HTML-инструментариум. По този начин, само структурни тагове са налични в DocBook. Много от тях (около 400), но работи само няколко дузини вместо

и т.н. Форматът на документ е строго се поддържа, например, всеки отварящ етикет е длъжен да се съобрази със затварянето. В противен случай, нито една програма не такъв документ няма да бъде обработена. И накрая, като добре структурирана вход документ адаптирани към автоматизирана обработка, получаване на изхода на документа, изготвен в корпоративния стил, в HTML, PDF, WinHelp или друг, това е въпрос на техника - независимо от факта, че вече има една голяма част от инструментите, стандарт XSL- процесори.

Тя е лесна и интуитивна.

инструменти

Преобразуватели - с XSLT процесор и скриптове. И двете са на разположение като част от разпределението на почти всяка по-голяма или по-малка модерна версия на операционната система Linux. Scripts постоянно се развиват, например, във версия 1.68 поправя пропуски в индекса на руски, така че те не са незабавно актуализира, като изтеглите най-новата версия (docbook.sourceforge.net/projects/xsl) и внедряване на архива на сървъра.

За да се превърне оригиналния документ в изходен формат е необходимо да наберете следната команда:

$ Xsltproc /usr/docbook/xsl-stylesheets/html/chunk.xsl article.xml

- xsltproc - наречен програма, XSLT процесор (един от няколко);

- / ЮЕсАр / DocBook / XSL-стилови - това е мястото, на сървъра, който е домакин на XSLT-скриптове;

- HTML / chunk.xsl - едно изпълнение на генерирането на изходния документ;

- article.xml - оригинален документ DocBook.

Готово! В текущата директория трябва да се появи на HTML-файлове, по един за всеки раздел на статията и общата маса на съдържанието.

На първо място, най-лесният ниво на персонализация - е изборът на старта на сценария. В по-ранния пример е този на HTML / chunk.xsl - това е най-търсените, но не е единственият. Повече възможности за контрол на външния вид на изходния документ осигурява параметри, които само chunk.xsl има повече от 200. Пример: принуди Гвоздеят в отделен файл първата част от документацията и да определите кодирането на изходния документ прозорци-1251 вместо UTF-8, приета по подразбиране:

$ Xsltproc --param chunk.first.sections 1
> --stringparam chunker.output.encoding прозорци-1251
> /usr/docbook/xsl-stylesheets/html/chunk.xsl article.xml

За истинска работа ще искате да зададете поне дузина параметри, но да го направи чрез неудобните на команден ред. Поради това, можете да използвате така наречените «XSL-водача." В резултат на манипулация можем да се гарантира, че генерираните HTML-страници ще се срещнат напълно идеите си за естетика и ергономичност, или просто да съответства на вашия корпоративен стил (фиг. 2).

Максимална гъвкавост при използването на XSL-скриптове може да се постигне, ако неговият заместник не само стойностите на параметрите, но и кода, използван за лечение на тези или други маркери. Например, ако не сте доволни от начина, по който той е работил чрез шаблон, можете просто да го копирате от файла в директорията / ЮЕсАр / DocBook / XSL-стилови до шофьора си, както и правото да я както намерите за добре. Шаблони, които пишете, ще блокира вноса. По подобен начин можете не само да се промени при обработването на съществуващи маркери, но също така да въведете собствен!

Възможно е вашият документ ще бъде от гледна точка на XML от, но няма да съответства на схемата DocBook. Така например, той ще бъде изобретен потребителски тагове. XSL-скриптове се държат много разумно: съдържаща се в тези тагове текст попада в изходния документ, но това ще бъде осветен в червено. Сега ние трябва да се напише манипулатор (XSL: шаблон) за маркер на изобретения и го поставете в своя водач, а дори и по-добре - да се внася от един файл.

изходни формати

Преминаване от DocBook към HTML стандартни XSL-скриптове работил почти перфектно. Няма проблем и с генерирането на помощта към Windows HTML. htmlhelp / htmlhelp.xsl скрипт създава набор от HTML файлове и изисква обслужване. След това работи Помощ-компилатор hhc.exe, която Microsoft разпространява свободно, и генерира HTML Help.

FOP-търговска процесори, може би, най-добрият досега е продукт на RenderX XEP от ценовия около $ 300. Това е зрял продукт и проблемите, свързани с руски език не са в полза на целия екип на рускоезичните разработчици. За съжаление, "извън кутията" на кирилица шрифтове той не работи и не е инструкция, която би разумно обяснява как да им се даде възможност. Но ако сте се досетили, че нещата продължават да се показват гладко, има дори трансфери към руски текст.

Втората алтернатива - междинно превръщане латекс. Стандартните XSL-скриптовете не го поддържат, но, например, db2latex - пакет от XSL-скриптове, които могат да бъдат направени, за да направи това, което е необходимо. "Извън кутията", тя не работи с руски букви - искате да конфигурирате XSLT-шофьор. Генериран документ в LaTeX формат може да се превърне PDF pdflatex команда, с която разполага Linux персонал. След това се появява руски текст, но резултатът е далеч от задоволително: са недостатъци в парцела, в подравняването на текста в PDF отметки и т.н. Също така не се поддържа db2latex morerows атрибут - в таблиците по-невъзможно да се съчетаят вертикалните клетките. Освен това, стана ясно, че за да се приведе тази опция за ума не може без задълбочено проучване на TeX / LaTeX.

И накрая, но не на последно място на източника на проблемите е компания PDF Adobe по - трудности с подкрепата на руски език има почти всички свои продукти: в Photoshop, а в FrameMaker и Acrobat. Очевидно е, че сред разработчиците на Adobe не са имигранти от бившия Съветски съюз. Ето какво компанията е около Adobe Acrobat версия 6: "При създаване на PDF от HTML-файлове, текст написан на кирилица шрифтове, заменени от грешен символ, или кухини." С други думи, тя не работи - и трябва!

В резултат на това стигнахме до заключението, че единственият просто и надеждно работещи вариант на PDF поколение на Руски - е Acrobat Distiller, което може да включва шрифтовете, използвани в генерирания документ, което гарантира неговото четене на всеки компютър, а не само върху това, което е оборудвано с руски версия на Windows.

За техническа писател

Традиционно документация предимно разбира отпечатания документ или книга. Но днес, документацията, изисквана в повечето случаи и в печатен и в електронен вид. Ако вече имате документ, който изложи за печат, най-лесният (и гъвкав) начина, по който да го направи електронна версия - за да използвате Adobe Acrobat Distiller. Ще получите PDF, които могат да бъдат изгорени на CD или пуснати на сайта. Въпреки това, PDF - не роден в интернет формат. Документите ви няма да бъде неразделна част от сайта и ще ядосат потребителя дългосрочно натоварване, те няма да могат да се свържат стандартната Дизайнът на сайта (шапки, панел, услуги), те са трудни за използване на връзки и инструменти за търсене на сайта.

Концептуалният подход към въпроса за DocBook документи в различни формати, е най-компетентните: изходния код, абсолютно не са обвързани с изходен формат, както и контрол на параметрите на програмата генерира изходни документи. В практическо прилагане на генериране на HTML-документи е решен, като PDF все още не е напълно гладка, но все пак проблемът е решен, също.

В допълнение, технически писател се нуждае от сервиз: автоматично номериране на секции, маси, фигури, автоматично генериране на таблици със съдържание, списък на фигурите, индекс. С всички тези проблеми DocBook дръжки.

сътрудничество

Много хай-тек, ниски режийни разходи. В същото време, без да пречи един с друг, документът може да работи един голям отбор.

Съдържание, дизайн и структура

Единственото нещо, което не ни допадна да работя с DocBook, - това "опашки» SGML, което се появява в основния файл за организиране на връзки към части от документа. Първо, всеки файл, трябва да се спомене два пъти (веднъж при определяне, през втората поставянето); но къде дублирането, да възникнат грешки. На второ място, работа с сложни структури, организирани по подходящ начин. В този пример, само два фрагмента, реалните документи за софтуерни продукти могат да се състоят от стотици фрагменти на значителна дълбочина на гнездене на секциите. Налице е естественото желание да се направи структурата по-видими. Но най-ясно отразява йерархичната структура, която е документ DocBook? Очевидно е, че йерархията директория.

Ето защо, ние сме внедрили следната схема на работа с документи разклонена DocBook. В секцията на всяко ниво, отделна директория. раздел съдържание се вписва в XML файл, който се намира в тази директория и подразделения са нейните поддиректории. Монтаж парчетата се извършва автоматично проста програма, написана на черупката и XSLT. Правилния ред от секциите се постига с помощта на изрична атрибут «номер» в таговете. SGML декларация станат ненужни.

Последното е важно от гледна точка на не само технологично (в крайна сметка, с припокриващи се раздели на имената могат да се справят), но концептуално. Ако необходимостта от разделяне на съдържанието и дизайна - е повече или по-малко общо място, ние отидохме по-далеч и постига разделяне на съдържание, дизайн и структура.

Общият брой на документация

XML-стратегия

DocBook XML-базирани технологии. Трябва ли да се страхуваме, ако тези технологии са нови за вас? По наше мнение, XML заслужава да е образувала всеки ИТ компания срещу него се използва собствената си стратегия. XML - не е прищявка, макар и не с магическа пръчка. Това е ефективно решение за широк кръг от проблеми, които все още са слабо съпротива автоматизация. Компютри отдавна са пригодени за съхранение и обработка на, от една страна, строго структурирана и данните за обема, а от друга - semistructured данни, като например текстови документи. Силата на една и съща XML е, че тя дава възможност за ефективно организиране и манипулиране quasistructured информация: спецификация и API; на изискванията на клиентите и сценарии за използване; данни и сценарии за изпитване; често задавани въпроси; курсове за обучение с лекции, примери и тестове. Тази информация обикновено е колекция от предмети с една и съща структура най-високо ниво и текстови описания по-ниски нива. За разлика от представянето на такава информация под формата на текст, XML позволява да отразяват структурата. От друга страна, в сравнение с XML бази данни, че има много по-голяма гъвкавост, а количеството на информацията, е малък и се изисква силата на базата данни. Има много примери за успешно използване DocBook на тези проблеми. Например, образователна лекция, представена под формата на XML файл, който се генерира автоматично от: пързалки за преподаватели; листовки за ученици; опитни данни за лабораторна работа; проблеми, въпроси и изпитни тестове.

По този начин, за високотехнологични компании ще Docbook органичен допълнение вече използват XML-базирани приложения, както и за другите - технологичен резерв, които ще допринесат за изпълнението на XML.

Анатолий Belychook ([email protected]), Мария Николаева ([email protected]), Надежда Матвеева ([email protected]), Станислав Фридкин ([email protected]) - служители на компанията "Бизнес Console" (Москва) ,

DocBook стандарт

Материално DocBook - е XML-схемата (DTD) и скриптове (DSSSL, XSLT). Те са свободно достъпни: те могат да използват за всякакви цели, променят и копират без ограничения и специално разрешително. Единственото нещо, което е забранено в съответствие с духа на общността на отворения код - е да се ограничи друга свободно използване и разпространение на DocBook или негови модификации.

Стандартно в популярния представянето DocBook предостави насоки [1, 2], което прави "избор": като се започне около 400 тагове намалени до 100 най-широко използваните (и най-вероятно това е много повече от наистина е необходимо). За настройки XSLT-инструмент и параметри, които влияят върху типа на изхода, ще трябва водач [3] и справка [4].

литература

1. Норман Уолш, Леонард Muellner. DocBook: Окончателните Наръчник (www.docbook.org).
2. Норман Уолш. Опростен DocBook: Окончателните Наръчник (www.docbook.org).
3. Боб Stayton. DocBook XSL: Пълно ръководство (www.sagehill.net/docbookxsl).
4. Norman Уолш, Боб Stayton, Jirka Kosek DocBook XSL Stylesheet Референтен документация (docbook.sourceforge.net/release/xsl/ ток / док / reference.html).

DocBook Сайт

Ново заявление на DocBook - създаване на уеб-сайтове. Идеята е, както следва: с помощта на таговете на DokBook, можете да си създадете XML-файл на всяка страница от сайта (в главната маркер) плюс един XML-файла, съдържащ таблица на съдържанието. След това тези файлове се обработват с помощта на XSL-скриптове, при което се получава набор от HTML-страници, които правят сайта.

По време на генерирането на всяка страница, автоматично podverstyvaetsya панел с йерархична таблица на съдържанието на сайта, елементите, които можете да се разширяват и колапс. Също така в таблицата на съдържанието се маркира автоматично новите и променени страници. Прави впечатление, че връзките между страниците на сайта не са направени от обичайните, но с маркер помощ DocBook. Това гарантира, че всички вътрешни връзки на така получената сайта ще бъдат правилни.

Основното предимство на тази технология, като DocBook като цяло - последователното отделяне на съдържание от дизайн. Например, www.docbook.org сайтове. www.docbook.ru. изработен от тази технология, погледнете в строго академичен. Но, като се използват методите за установяване на стандарти на DocBook, е възможно да се промени радикално дизайна и оформлението на сайта е абсолютно без това да повлияе на неговото съдържание.

Сподели снимки с приятели и колеги

Покана Хауърд Rheingold като гост на следващото издание на "отворени системи" има специално значение за мен. Случило се така, че ние сме добре запознати с него; Аз от много години е участвал в създал

Експоненциалния растеж на Web, на къде всичко, разбира се, съм чувал, не може да продължи вечно, или ние просто чака падането на информацията. Обемът на натрупаната информация, която вече е толкова голямо, че "дави" в резултатите от търсене в интернет.

Аналитични програми вече стават основно средство за подобряване на ефективността на предприятията

Свързани статии

• развитие документация с DocBook