https://github.com/tomschr/dbcookbook

Cookbook for DocBook and DocBook XSL stylesheets
https://github.com/tomschr/dbcookbook

cookbook docbook xml xslt

Last synced: 6 days ago
JSON representation

Cookbook for DocBook and DocBook XSL stylesheets

• Host: GitHub
• URL: https://github.com/tomschr/dbcookbook
• Owner: tomschr
• License: other
• Created: 2017-05-21T19:48:57.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2020-08-27T21:31:17.000Z (about 4 years ago)
• Last Synced: 2023-03-23T12:37:23.784Z (over 1 year ago)
• Topics: cookbook, docbook, xml, xslt
• Language: XSLT
• Homepage: http://doccookbook.sf.net/
• Size: 35.1 MB
• Stars: 15
• Watchers: 3
• Forks: 5
• Open Issues: 24
• Metadata Files:
  • Readme: README.rst
  • Changelog: Changelog
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
===================================

Welcome to "The DoCookBook"

===================================

.. image:: https://travis-ci.org/tomschr/dbcookbook.svg?branch=develop

    :target: https://travis-ci.org/tomschr/dbcookbook

:Info: See https://github.com/tomschr/dbcookbook

:Author: Thomas Schraitle 

:Description: Cookbook for DocBook and DocBook XSL stylesheets

:HTML: http://doccookbook.sourceforge.net

License

-------

The book is licensed as Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Germany License

(CC by-nc-sa 3.0 DE) See http://creativecommons.org/licenses/by-nc-sa/3.0/de/

Mission

-------

The DoCookBook project aims to create an open source book about DocBook and the DocBook XSL 

stylesheets written in a cookbook-style manner and released under a Creative Commons license.

Concept

-------

This book is written in a "cookbook" style. The book contains "topics"

which are divided into a problem, the corresponding solution, some 

discussions, and optional related information.

It is very easy just to go to the table of contents and see if there

is something useful that fits to your problem.

Solutions are usually written in a procedural style which contain

several steps.

Target Group

------------

It is assumed you have a decent knowledge about XML and DocBook. It doesn't

hurt if you know CSS and XSLT. As such, it is aimed more at DocBook 

developers than writers.

Structure of the Book and Organization

--------------------------------------

The main file is "en/xml/DocBook-Cookbook.xml". It contains xi:include

elements which refer to chapters, appendices and other second level

elements.

::

  

  # Structure of Book with Main Chapters 

  en/xml/DocBook-Cookbook.xml

  |

  +-- 5.1/        # (1)

  |

  +-- common/     # (2)

  |

  +-- db/         # (3)

  |

  +-- epub/       # (4)

  | 

  +-- fo/         # (5)

  |

  +-- html/       # (6)

  |

  +-- structure/ # (7)

::

  

  (1) Contains the DocBook Schema and possible customizations

  (2) Contains topics to common customizations

  (3) Contains topics to DocBook's markup

  (4) Planned: will contain customizations to EPUB output format

  (5) Contains topics to FO customizations

  (6) Contains topics to HTML, XHTML, and other customizations based on HTML

  (7) Contains topics how to manipulate DocBook's structure

Some topics contain directories which store XSLT, XML, or other example files.

In some cases these are incorporated into the XML source, sometimes they are

just lying around for testing purposes.

Each topic is a self-contained matter of a specific problem and its solution

with discussion. Use the skeleton file "en/xml/topic.empty.xml"  as a starting point.

It contains the basic structure and you just need to add the flesh of your topic.

Contribute

----------

Do you miss anything? Have you discovered an error? Have an idea about how

to improve the book? Great! If you want to contribute to the book, you can

do it in different ways:

* Write me a mail to  and send me your comments

* Extend the tickets (Ideas for New Topics) at http://github/tomschr/dbcookbook/issues

* Clone this repository and send me patches

This repository uses `git flow` from https://github.com/petervanderdoes/gitflow-avh 

see `Vincent Driessen Git branching model `_

How to build the book

---------------------

Currently, building the book works but it's not as nice as I would

like to see it.

* Building chunked HTML: use ./bin/dbsaxon

* Building single HTML: use bin/dbsaxon9 

At the moment, it is a mixture of XSLT 1.0 and XSLT 2.0 stylesheets.

To avoid maintaing two different CSS files (one for the XSLT 1.0 output,

the other for 2.0), the HTML files coming from XSLT 1.0 are "cleaned up".

This cleanup step makes the structure compatible to the XSLT 2.0 output.

How you can help

----------------

* Find typos, grammar problems, inconsistencies, or plain errors

* Send me patches

* Write your own topic