DocBook

DocBook é uma linguagem de marcação semântica para documentação técnica. Foi originalmente criada para escrita de documentos técnicos da área de informática, mas pode ser usada para publicação de todo tipo de documentação.

Como uma linguagem semântica, DocBook permite separar a apresentação do conteúdo, permitindo criar documentos numa forma neutra que captura a estrutura lógica do conteúdo; esse conteúdo poderá ser publicado depois numa variedade de outros formatos, incluindo HTML, XHTML, EPUB, PDF, páginas man e Ajuda HTML, sem que seja necessário alterar o documento fonte.

Resumo

DocBook é uma linguagem XML. Na sua versão (5.0), a linguagem do DocBook é formalmente definida por um schema RELAX NG com regras Schematron integradas. (Há também versões W3C XML Schema+Schematron e Document Type Definition (DTD) do esquema disponível, mas não são considerados padrões.)

Como uma linguagem semântica, um documento escrito em DocBook não descreve como "ele será apresentado" mas sim "o significado" do conteúdo do documento. Por exemplo, ao invés de definir como o resumo de um livro deve ser exibido ou formatado, o DocBook diz apenas que uma seção particular do documento é o resumo; Uma aplicação de processamento de texto externa é que decide onde e como o resumo deve estar na publicação final, inclusive se será publicado.

O DocBook oferece uma vasto conjunto de marcadores de elementos semânticos divididos em três categorias: estrutural, nível de bloco e em linha.

Os marcadores Estruturais definem as características gerais do documento: o elemento book, por exemplo, especifica que seus elementos filhos representam partes de um livro: o título, capítulos, glossário, apêndices e etc. Os marcadores estruturais do DocBook incluem, entre outros, são:

  • set: uma coleção de um ou mais livros. Um set<> poderá conter outros sets.
  • book: uma coleção de capítulos, artigos, e/ou partes, com conteúdos opcionais: glossários, apêndices e outros.
  • part: uma coleção de um ou mais capítulos. Uma parte pode englobar outras partes. Pode ter um texto introdutório especial.
  • article: uma coleção titulada e não numerada de elementos de nível de bloco.
  • chapter: uma coleção titulada e numerada de elementos de nível de bloco. DocBook não requer a numeração obrigatória dos capítulos; é compreensível que semanticamente o número do capítulo atual é o do capítulo anterior mais um.
  • appendix: o texto contido representa um adendo/apêndice.
  • dedication: o texto representa a dedicatória do documento.

Os elementos estruturais podem conter outros elementos estruturais. Os elementos estruturais são os elementos permitidos somente de nível superior em um documento DocBook.

Marcadores de nível de Bloco são elementos que descrevem parágrafos, listas e outros. Nem todos eles podem conter textos diretamente neles. elementos de nível de bloco sequenciais devem ser apresentados um após o outro. Esse "após", neste caso, pode ter significado variados dependendo da língua. Em muitas línguas ocidentais, "após" significa abaixo: parágrafos são impressos abaixo da página. Em outroas línguas, como o japonês, o texto é escrito em colunas, com parágrafos dispostas da direita para a esquerda. As semânticas do DocBook são inteiramente neutras às línguas humanas.

Marcadores de nível de linha são elementos que descrevem textos enfatizados, atalhos (hyperlink) e outros. Eles quebram o texto dentro de um elemento de nível de bloco. Estes elementos não quebram o texto quando inseridos em parágrafos, mas normalmente fazem o processador de texto aplicar algum tratamento tipográfico ao texto delimitado, ou trocando o tipo da fonte de texto, tamanho ou atributos similares. (A especificação DocBook cita que é esperado tratamento tipográfico diferenciado, sem explicitar este tratamento), por exemplo, o marcador emphasis não obriga o processador de texto a usar "negrito" no texto enfatizado.

Exemplo Simples

 <?xml version="1.0" encoding="UTF-8"?>
 <book xml:id="simple_book" xmlns="http://docbook.org/ns/docbook" version="5.0">
   <title>Exemplo Simples de um Livro</title>
   <chapter xml:id="cap001">
     <title>Capitulo 1</title>
     <para>Ola', mundo!</para>
     <para>Desejo-te um <emphasis>maravilhoso</emphasis> dia!</para>
   </chapter>
   <chapter xml:id="cap002">
     <title>Capitulo 2</title>
     <para>Ola', de novo!</para>
   </chapter>
 </book>

Semanticamente, este documento é um "livro" with a "título" que contém 2 "capítulos". Cada "capítulo" contem seu "título" e 1 "parágrafo".

Olhando com mais detalhes, o elemento raiz do documento é o book. Todos os elementos DocBook estão em uma Namespace XML, assim o elemento raiz possui um atributo xmlns para definir o namespace atual. Também, o elemento razi do documento DocBook precisa ter um atributo version que especifica a versão do formato que o documento foi gerado.

(Documentos XML podem incluir elementos de múltiplos namespaces. Por simplicidade, o exemplo não ilustra isso.)

Um elemento book precisa conter um elemento title, ou um elemento info contendo um title. Isto deve acontecer antes de aparecer os demais elementos estruturais filhos. Após o título, segue os elementos filhos, neste caso, 2 elementos chapter. Cada um precisa ter um elemento title. Eles contem elementos de nível de bloco para que contém texto simples e outros elementos em linha como emphasis no segundo parágrafo do primeiro capítulo.

Esquemas e Validação

Regras como aquelas citadas no item anterior ("um elemento book deve conter um elemento title, ou um elemento info contendo um elemento title," etc.) são formalmente definidos no esquema' DocBook. Ferramentas de programação específicas podem ser usada para validar um documento XML (DocBook ou outro), frente ao seu esquema correspondente, para determinar se (e onde) o documento falha na conformidade do esquema. Ferramentas de edição XML podem também usar informações do esquema para evitar a criação de documentos fora do padrão.

Edição no DocBook

Porque o DocBook é um texto XML, os documentos podem ser criados e editados em qualquer editor de texto. Qualquer editor XML é um editor DocBook funcional. Alguns editores gráficos, como o MS Word, vêm com a capacidade de editar arquivos DocBook.

Processamento do DocBook

Porque o DocBook é um formato XML, todo documentos DocBook poderá ser validado e processado usando qualquer ferramenta que inclua suporte ao XML.

Arquivos DocBook são usados para gerar saídas numa variedade de formatos. Quase sempre, eles vêm acompanhado de arquivos contendo folhas de estilo que transformam documentos DocBook em outros (HTML, XSL-FO, PDF, etc).

Porque as folhas de estilo XLS padrões do DocBook são bem-formadas, e o DocBook é um XML bem-formado, qualquer um pode escrever sua própria folha de estilo e usar um processador XLS para gerar sua própria saída alternativa.

História

O DocBook começou em 1991 como um projeto conjunto da HAL Computer Systems e O'Reilly & Associates e manteve sua própria equipe de mantenedores (the Davenport Group) até ser movido (1998) para o SGML Open consortium, que depois passou a se chamar OASIS. o Comitê Técnico do DocBook é quem mantem as especificações DocBook dentro da OASIS.

DocBook está disponível nos formatos SGML e XML, como uma DTD. Os formatos RELAX NG e W3C XML Schema da versão XML também estão disponíveis. A partir do DocBook 5, a versão RELAX NG é a forma "normativa" da qual os outros formatos são gerados.

DocBook inicialmente começou como uma aplicação SGML, mas uma aplicação XML equivalente foi desenvolvida veio a substituí-la.

O DocBook foi adotado pela comunidade de código aberto e se tornou padrão na criação de documentação para muitos projetos, incluindo FreeBSD, KDE, documentação GNOME, referências do API de GTK+, a documentação do Linux (núcleo)kernel Linux, e o trabalho do Projeto de Documentação Linux (LDP).

Norman Walsh e a equipe de desenvolvimento do projeto DocBook mantêm a aplicação-chave para produzir a saída de documentos fonte DocBook: um conjunto de folhas de estilo XSL (bem como um legado conjunto de folhas de estilo DSSSL) que pode gerar HTML de alta qualidade e arquivos (FO/PDF) de saída, assim como a saída em outros formatos, incluindo RTF , páginas man e HTML Help.

Walsh também é o autor principal do livro DocBook: The Definitive Guide, a documentação oficial do DocBook. Este livro está disponível on-line sob a GFDL, e também como uma publicação impressa.

Pré DocBook v5.0

A atual versão do DocBook, 5.0, é ainda muito recente. Como versões anteriores do DocBook ainda são muito usadas, esta seção oferece um resumo do que mudou no DocBook 5.0 em relação às versões 4.x e anteriores.

Até o lançamento do DocBook 5, o DocBook era definido por um documento DTD. Como o DocBook foi construído originariamente como uma aplicação da SGML, o DTD foi a única linguagem de esquema disponível. Os formatos do DocBook 4.x podem ser o SGML ou XML, mas a versão XML não possui seu próprio espaço de nomes XML.

Como uma conseqüência da definição de um DTD, os formatos do DocBook 4.x sofreram restrições de quem é definida por um DTD. O mais importante para o idioma é que um nome de elemento define exclusivamente o seu conteúdo possível. Ou seja, um elemento nomeado inf deve conter as mesmas informações não importa onde ele é declarado no arquivo DocBook. Como tal, há muitos tipos de elementos info no DocBook 4.x: bookinfo, chapterinfo, etc. Cada um possui um teor de modelo diferente, mas eles compartilham alguns de seus modelos de conteúdo. Além disso, eles repetem a informação de contexto. O elemento info do book, por ser um filho direto do livro, ele não precisa ser nomeado especialmente para um leitor humano. No entanto, porque o formato foi definido por um DTD, ele teve que ser chamado como tal.

O elemento raiz não precisa ter uma version, pois a versão está embutida na declaração DTD no topo do documento pre-DocBook 5.

Os documentos DocBook 4.x não são compatíveis com o DocBook 5, mas podem ser convertidos através de uma folha de estilo XSLT que vem no pacote da distribuição DocBook 5.

DocBook Simplificado

O DocBook oferece um grande número de características que podem ser trazer confusão para o novo usuário. Para aqueles que querem aprender o básico do DocBook sem grande esforço foi disponibilizado o DockBook Simplificado. Ele é uma pequena parte do DocBook desenvolvida para pequenos documentos como artigos ou pequenos livros. O DTD do DocBook Simplificado está ainda na versão 1.1. [1]

Referências

  1. «Simplified DocBook». Consultado em 13 de março de 2011. Arquivado do original em 24 de setembro de 2006 

Leitura mais aprofundada

Ver também

Ligações externas

Read other articles:

Badminton tournament2000 IBF World Junior ChampionshipsTournament detailsEdition5thVenueTianhe Gymnasium[1]LocationGuangzhou, China ← 1998 Melbourne 2002 Pretoria → The 2000 IBF World Junior Championships was an international badminton tournament held in Guangzhou, China from 3-11 November 2000.[2] China sweep all the title in the team and individual events.[3][4] Team competition A total of 24 countries competed at the first team competition in BWF World J...

Hervormde kerk De Hervormde kerk is een voormalig protestants kerkgebouw te Helmond, dat is gelegen aan de Kerkstraat 19 aldaar. Het gebouw is een waterstaatskerk, ontworpen door Arnoldus van Veggel en ingewijd in 1847. Het gebouw is geklasseerd als Rijksmonument. Het is een bakstenen gebouw in neogotische stijl, dat oogt als een kruiskerkje, met een opvallend hoge en spitse centrale toren. De Hervormde kerk werd in 1963 onttrokken aan de eredienst. De hervormden kerkten voortaan in de pas ge...

Benteng San Carlos de La Cabaña Benteng San Carlos de la Cabaña, Havana, Kuba Fortaleza de San Carlos de la Cabaña (Benteng Santo Charles), yang lebih dikenal sebagai La Cabaña, adalah sebuah kompleks benteng abad ke-18, ketiga terbesar di benua Amerika, terletak di sisi timur bagian depan pelabuhan di Havana, Kuba. Benteng tersebut berada di atas ketinggian puncak bukit 200 kaki (60 m), bersama dengan Istana Morro (benteng). Pada Januari 1959, para pemberontak komunis pimpinan Fidel Cast...

تاريخ الأبجديةتاريخ الأبجديةأبجدية سينائية أولية 18 c. BCE أوغاريت 15 c. BCE فينيقية 12 c. BCE عبرية قديمة 10 c. BCE سومرية 6 c. BCE آرامية 8 c. BCE كتابة غراندهاري 6 c. BCE برهمية 6 c. BCE أبجدية برهمية عبرية 3 c. BCE بهلوية 3 c. BCE اويستا 4 c. CE أبجدية تدمرية 2 c. BCE سريانية 2 c. BCE سوغدية 2 c. BCE أورخون (تركية قديمة) ...

Pfarrkirche St. Peter und Paul Südseite, Chor und Sakristei Die römisch-katholische Pfarrkirche St. Peter und Paul in Gündlkofen, einem Ortsteil der Gemeinde Bruckberg im niederbayerischen Landkreis Landshut, wurde in der Mitte des 18. Jahrhunderts im Stil des Rokoko errichtet. Die Kirche gilt als eines der Hauptwerke des Landshuter Hofbaumeisters Johann Georg Hirschstötter und steht auf der Liste der geschützten Baudenkmäler in Bayern.[1] Die Kirche mit dem Patrozinium der...

Salih al-AruriNama dalam bahasa asli(ar) صالح محمد سليمان العاروري BiografiKelahiran19 Agustus 1966 (57 tahun)Data pribadiNama samaranأبو محمد PendidikanHebron University (en) KegiatanPekerjaanPolitikus Saleh al-Arouri (Arab: صالح العاروري), dapat dialih aksarakan sebagai Salah al-Arouri atau Salih al-Aruri, adalah pemimpin terkemuka dari Hamas dan merupakan komandan pendiri Brigade Izzuddin al-Qassam. Ia dianggap sebagai komandan militer Tepi Bara...

يفتقر محتوى هذه المقالة إلى الاستشهاد بمصادر. فضلاً، ساهم في تطوير هذه المقالة من خلال إضافة مصادر موثوق بها. أي معلومات غير موثقة يمكن التشكيك بها وإزالتها. (أبريل 2020) هذه المقالة يتيمة إذ تصل إليها مقالات أخرى قليلة جدًا. فضلًا، ساعد بإضافة وصلة إليها في مقالات متعلقة بها. ...

Singkatan stasiun ini bukan berarti ion tiosianat (SCN-). Stasiun Sicincin L02 Emplasemen Stasiun Sicincin saat masih menggunakan tiga jalur kereta api.LokasiSicincin, 2x11 Enam Lingkung, Padang Pariaman, Sumatera BaratIndonesiaKetinggian+89 mOperatorKereta Api IndonesiaDivisi Regional II Sumatera BaratLetak dari pangkalkm 53+131 lintas Teluk Bayur–Padang–Lubuk Alung–Sawahlunto[1]Jumlah peron-Jumlah jalur3 (jalur 2: sepur lurus)Informasi lainKode stasiunSCN7037[2]Klasifi...

  أمابا   أمابا أمابا  خريطة الموقع تاريخ التأسيس 5 أكتوبر 1988  تقسيم إداري البلد البرازيل  [1][2] العاصمة ماكابا  التقسيم الأعلى البرازيل  خصائص جغرافية إحداثيات 1°23′00″N 51°48′00″W / 1.3833333333333°N 51.8°W / 1.3833333333333; -51.8  [3] المساحة 142814.6 كيلومت

Chinese TV series or program Cao CaoJapanese DVD release posterAlso known asYingxiong Cao Cao (英雄曹操)Chinese曹操Hanyu PinyinCáo Cāo bui OlplbnGenreHistorical dramaWritten byJin LeshiHe YanjiangDirected byHu MeiPresented byLin JunboYang ShouchengStarringZhao LixinSun HongtaoHan XueLeo KuTheme music composerIkurō FujiwaraEnding themeXia Gu Rou Qing (侠骨柔情) performed by Mi JingCountry of originChinaOriginal languageMandarinNo. of episodes41ProductionExecutive producersWei...

Sporting event delegationSouth Sudan at the2020 Summer OlympicsIOC codeSSDNOCSouth Sudan National Olympic Committeein TokyoJuly 23, 2021 (2021-07-23) – August 8, 2021 (2021-08-08)Competitors2 in 1 sportFlag bearers (opening)Lucia MorisAbraham GuemFlag bearer (closing)Abraham GuemMedals Gold 0 Silver 0 Bronze 0 Total 0 Summer Olympics appearances (overview)201620202024Other related appearances Sudan (1960–) Independent Olympic Athletes...

Sylvia Plath The Sylvia Plath effect is the phenomenon that poets are more susceptible to mental illness than other creative writers. The term was coined in 2001 by psychologist James C. Kaufman, and implications and possibilities for future research are discussed.[1] The effect is named after Sylvia Plath, who died by suicide at the age of 30. Building on the more general research that, from early adolescence through adulthood, women are twice as likely as men to experience depressio...

Exercise machine simulating watercraft rowing This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these template messages) This article possibly contains original research. Please improve it by verifying the claims made and adding inline citations. Statements consisting only of original research should be removed. (February 2019) (Learn how and when to remove this template message) This article needs additional citat...

Pour les articles homonymes, voir Armée de libération nationale et Armée libyenne. Ne pas confondre avec Armée nationale libyenne ou Forces armées de la Jamahiriya arabe libyenne. Armée de libération nationale libyenneجيش التحرير الوطني الليبي (ar) Devise : Free Army, Free Libya ! Idéologie Diverses Objectifs Renversement du régime de Mouammar Kadhafi Fondation Date de formation Mars 2011 Pays d'origine Libye Date de dissolution Octobre 2011 Organisati...

この記事は検証可能な参考文献や出典が全く示されていないか、不十分です。出典を追加して記事の信頼性向上にご協力ください。(このテンプレートの使い方)出典検索?: 師岡熊野神社 – ニュース · 書籍 · スカラー · CiNii · J-STAGE · NDL · dlib.jp · ジャパンサーチ · TWL(2018年2月) 師岡熊野神社 拝殿 所在地 神奈川県横浜市�...

App store by Amazon Amazon AppstoreDeveloper(s)Amazon.com Services, LLCInitial releaseMarch 22, 2011Stable releaserelease-32.52.1.0.204529.0_800923810 Operating systemFire OS, Android, BlackBerry 10, Windows 11Included withFire OS, BlackBerry 10TypeApp storeLicenseProprietaryWebsitewww.amazon.com/gp/mas/get/android/ Amazon Appstore is an app store for Android-compatible platforms operated by Amazon.com Services, LLC, a subsidiary of Amazon. The store is primarily used as the storefront for Am...

King of Anuradhapura ManavammaKing of AnuradhapuraReign684 A.D. - 718 A.D.PredecessorUnhanagara HatthadathaSuccessorAggabodhi VIssueAggabodhi VKassapa IIIMahinda IDynastyHouse of Lambakanna IIFatherKassapa II of AnuradhapuraReligionBuddhist Manavanna, also known as Manavarman in Indian sources, was king of Anuradhapura from 684 AD to 718 AD. Considered an important monarch of the Anuradhapura kingdom, he is known for concluding almost half a century of anarchy and ushering an era of prosperit...

У этого термина существуют и другие значения, см. Томск (значения). Не следует путать с Омском. ГородТомск Ансамбль купца Желябо, Богоявленский собор, жилой дом купца Смирнова, ночной вид на Томск, граффити на проспекте Ленина, Томский государственный университет Флаг Гер�...

Elezioni regionali in Lombardia del 2013 Stato  Italia Regione  Lombardia Data 24 e 25 febbraio Affluenza 76,74% ( 12,10%) Candidati Roberto Maroni Umberto Ambrosoli Partiti Lega Nord Indipendente Coalizioni Centro-destra Centro-sinistra Voti 2.456.92142,81% 2.194.16938,24% Seggi 49 / 80 22 / 80 Distribuzione del voto per comune Presidente uscente Roberto Formigoni (PdL) 2010 2018 Le elezioni regionali del 2013 si sono tenute il 24 e 25 febbraio 2013[1] a seguito delle dimis...

Un telekura a Tokyo Il termine telekura (テレクラ Terekura?), abbreviazione della parola inglese telephone club (テレフォン クラブ terefon kurabu?) indica in Giappone dei locali forniti di un centralino, dove i clienti attendono le chiamate delle studentesse per praticare l'enjo kōsai. Indice 1 Caratteristiche 2 Il termine nella cultura di massa 3 Note 4 Voci correlate 5 Altri progetti Caratteristiche I locali sono piccoli e sono forniti di un centralino e di alcune stanz...