{"id":25096571,"url":"https://github.com/jceb/docbook-bootstrap","last_synced_at":"2025-04-02T02:14:13.616Z","repository":{"id":6750475,"uuid":"7996895","full_name":"jceb/docbook-bootstrap","owner":"jceb","description":"Bootstrapping environment for getting started with DocBook","archived":false,"fork":false,"pushed_at":"2021-02-02T06:33:39.000Z","size":747,"stargazers_count":4,"open_issues_count":6,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-22T21:02:20.655Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"XSLT","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jceb.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-02-03T21:27:16.000Z","updated_at":"2021-02-02T06:33:41.000Z","dependencies_parsed_at":"2022-08-26T04:21:29.100Z","dependency_job_id":null,"html_url":"https://github.com/jceb/docbook-bootstrap","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fdocbook-bootstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fdocbook-bootstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fdocbook-bootstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jceb%2Fdocbook-bootstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jceb","download_url":"https://codeload.github.com/jceb/docbook-bootstrap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246741119,"owners_count":20826066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-07T16:48:53.979Z","updated_at":"2025-04-02T02:14:13.594Z","avatar_url":"https://github.com/jceb.png","language":"XSLT","funding_links":[],"categories":[],"sub_categories":[],"readme":"= DocBook Bootstrap\n\n== Purpose\nSetting up a DocBook build environment seems to be extra difficult and\ncumbersome.  The goal of this project is to create a platform\nindependent, easy to depoly environment that brings you to the core\ntasks of getting started with THE document within seconds.\n\n.Objectives\n* Incorate all wisdom and hints from\n  http://www.docbook.org/tdg51/en/html/\n* Be platform independent -\u003e embrace the Java eco-system as much as\n  possible\n* Make using DocBook a breeze\n\n== Setup and Usage\n\nimage::https://github.com/jceb/docbook-bootstrap/blob/master/examples/clone-template.gif[Set up docbook project]\n\n1. Get all the additional software (see section\n   \u003c\u003cadditional-software-needed,Additional Software Needed\u003e\u003e).\n   Hopefully, you've to do this just once (in a while).\n2. Make a copy of the `template` folder and put it where you want to\n   create your next document/project.\n   * The `clone-template` script will do the work under Linux and\n     MacOSX.\n   * For Windows adjust the `Makefile` as needed.  (The document can\n     also be passed as an argument to make: `make in=FILE`)\n   * Many \u003c\u003cinput_formats,input formats\u003e\u003e are supported\n3. Start writing your document!\n4. Run `make` to convert the document to PDF.  It will be stored in the\n   `build` directory.\n   * Additional \u003c\u003coutput_formats,outupt formats\u003e\u003e are supported\n   * Example: `make html` to create HTML output\n   * Example2: `make help` to get a list of supported output formats\n5. Run `make watch` and `make stopwatch` to automatically start/stop\n   document builds through \u003c\u003cadditional-software-needed,watchman\u003e\u003e.\n6. Do you need more customization?  Ok, here you go:  The file\n   `build.properties` holds the general settings for building a DocBook\n   file.  Platform specific values are stored in the\n   `build.properties.PLATFORM` files.  Customization of stylesheets is\n   possible.  Check out the included stylesheet for some ideas:\n   `stylesheets/fo/docbook.xsl`\n\n== Details\n\n[[output_formats]]\n=== Output Formats / Build Tasks\nRun the following tasks the create the desired output\nformat, e.g. `ant pdf`.  All output is stored it the directory `build`,\nit's customizable throught the variable `output.dir`:\n\n* `pdf`           : create PDF output (default task)\n* `epub`          : create EPUB output\n* `epub3`         : create EPUB3 output\n* `xhtml`         : create XHTML output\n* `xhtmlchunk`    : create chunked XHTML output\n* `xhtml5`        : create XHTML5 output\n* `xhtml5chunk`   : create chunked XHTML5 output\n* `validate`      : validates the DocBook document\n* `clean`         : delete all dynamically created files/the \"out\" directory\n* `test`          : execute all creation tasks one after the other\n\n[[input_formats]]\n=== Input Formats\n* http://asciidoc.org/[AsciiDoc]\n* http://docbook.org/[DocBook]\n* http://daringfireball.net/projects/markdown/[Markdown]\n* http://orgmode.org[Org mode]\n* http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html[reStructuredText]\n* and many more through http://pandoc.org/[Pandoc]\n\nSee section \u003c\u003cadditional_software,Additional Software Needed\u003e\u003e for more\ninformation.  Set property `file.format` to `asciidoc` and change\n`file.suffix` to the suffix of the input file - it's necessary because\nthere doesn't seem to be way to figure this out using Ant.\n\n=== Examples\n.Convert any DocBook file to PDF without editing build.properties\nThis takes advantage of ant's ability to specify properties on the\ncommmand line.\n\n ant -Dfile=myfile.xml pdf\n\n.Convert this AsciiDoc file to PDF\nActually, it doesn't work yet!  The reason is that AsciiDoc doesn't ship\na DocBook 5 backend.  When you run this command, you can take the\nresulting DocBook file (build/README.xml) and tweak it to make compile\nproperly.\n\n ant -Dfile=README.adoc -Dfile.format=asciidoc -Dfile.suffix=adoc pdf\n\n== Customization\n\n=== Include custom Fonts\nIt is possible to include custom fonts into fop-generated\ndocuments.  Follow these steps:\n\n.Include True Type Fonts\nCopy all required True Type Fonts in the directory `lib/fonts`.\n\n.Generate XML description for the custom True Type Font\nExecute the following command in the fop folder `lib/fop` to generate an\nXML description for each font:\n\n for font in ../fonts/*.ttf; do\n   java -cp lib/commons-io-1.3.1.jar:lib/commons-logging-1.0.4.jar:build/fop.jar:lib/avalon-framework-cvs-20020806.jar:lib/xml-apis.jar:lib/xercesImpl-2.2.1.jar:lib/xalan-2.4.1.jar org.apache.fop.fonts.apps.TTFReader \"${font}\" \"${font%.ttf}.xml\"\n done\n\nOn Linux and Mac OS X systems executing the command\n`lib/fonts/compile.sh` will perform this task as well.\n\nThe following discussions might also be of interest to you:\n\n* Discussion at http://www.mail-archive.com/fop-user@xml.apache.org/msg13631.html\n* More information at http://xmlgraphics.apache.org/fop/0.94/fonts.html#register\n\n.Include fonts in fop.xconf\nAdd the custom font to the fonts section.  Here is an example for the\nukai font:\n\n \u003cfonts\u003e\n ...\n \u003cfont metrics-url=\"lib/fonts/ukai.xml\" kerning=\"yes\" embed-url=\"lib/fonts/ukai.ttf\"\u003e\n   \u003cfont-triplet name=\"ARPLZenKaiUni\" style=\"normal\" weight=\"normal\"/\u003e\n   \u003cfont-triplet name=\"ARPLZenKaiUni\" style=\"normal\" weight=\"bold\"/\u003e\n   \u003cfont-triplet name=\"ARPLZenKaiUni\" style=\"italic\" weight=\"normal\"/\u003e\n   \u003cfont-triplet name=\"ARPLZenKaiUni\" style=\"italic\" weight=\"bold\"/\u003e\n \u003c/font\u003e\n ...\n \u003c/fonts\u003e\n\n.Include fonts in stylesheet\nAdd the font to the fo-stylesheet (`stylesheets/fo/docbook.xsl`):\n\n \u003cxsl:param name='title.font.family'\u003esans-serif,ARPLZenKaiUni\u003c/xsl:param\u003e\n \u003cxsl:param name='body.font.family'\u003eserif,ARPLZenKaiUni\u003c/xsl:param\u003e\n\nThere are even more font family parameters that can be set:\n\n \u003cxsl:param name='monospace.font.family'\u003emonospace\u003c/xsl:param\u003e\n \u003cxsl:param name='symbol.font.family'\u003eSymbol,ZapfDingbats\u003c/xsl:param\u003e\n\n=== More to come\n...\n\n[[additional_software]]\n== Additional Software Needed!\n* Make sure you have a working https://www.java.com/[Java] and\n  http://ant.apache.org/[Ant] setup\n* For AsciiDoc input http://ascidoctor.org[Asciidoctor] needs to be\n  installed\n* For any other input form http://pandoc.org/[Pandoc] needs to be\n  installed\n* For automatic builds, https://facebook.github.io/watchman/[watchman]\n  needs to be installed\n\nIMPORTANT: *You also need to download the software listed in file link:SETUP[].*\n\n* If you are running Linux or Mac OS X, executing `setup.sh` will\n  download all dependencies\n\n== Licensing and Copyright\n\n----\n  Copyright (C) 2013-2015 Jan Christoph Ebersbach \u003cjceb@e-jc.de\u003e\n\n  Licensed to the Apache Software Foundation (ASF) under one\n  or more contributor license agreements.  See the NOTICE file\n  distributed with this work for additional information\n  regarding copyright ownership.  The ASF licenses this file\n  to you under the Apache License, Version 2.0 (the\n  \"License\"); you may not use this file except in compliance\n  with the License.  You may obtain a copy of the License at\n\n  http://www.apache.org/licenses/LICENSE-2.0\n\n  Unless required by applicable law or agreed to in writing,\n  software distributed under the License is distributed on an\n  \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n  KIND, either express or implied.  See the License for the\n  specific language governing permissions and limitations\n  under the License.\n----\n\n// vi: ft=asciidoc:tw=72:sw=2:ts=4\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjceb%2Fdocbook-bootstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjceb%2Fdocbook-bootstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjceb%2Fdocbook-bootstrap/lists"}