tomschr / dbcookbook Goto Github PK
View Code? Open in Web Editor NEWCookbook for DocBook and DocBook XSL stylesheets
Home Page: http://doccookbook.sf.net/
License: Other
Cookbook for DocBook and DocBook XSL stylesheets
Home Page: http://doccookbook.sf.net/
License: Other
Maybe it's worth to think about creating a specific GitHub domain dedicated to this project.
Related to #19
With a domain, it could be easier to separate tools, result HTML, and source code.
Moved from https://sourceforge.net/p/doccookbook/tickets/21/
These are some of the ideas about manipulating the DocBook document structure. The list is no guarantee that all will be implemented.
phrase
...)Moved from https://sourceforge.net/p/doccookbook/tickets/18/
There is a chapter missing about EPUB customizations
Moved from https://sourceforge.net/p/doccookbook/tickets/22/
These are some of the ideas about print customizations. The list is no guarantee that all will be implemented.
The project and book name is a bit cheasy.
Rename it to "DocBook Style Guide: Best Practices for Authors and Developers"
Although DocBook does not enforce how you create your project, it could be helpful to give some information about the "things around DocBook".
Some ideas that could be integrated under this topic. The list is no guarantee that all will be implemented:
Related issue: #11
Is your feature request related to a problem? Please describe.
Describe the <?dbhtml?>
processing instruction for chunking.
Additional context
HTML, related to #10
Moved from https://sourceforge.net/p/doccookbook/tickets/19/
These are some of the ideas about markup. Most is probably already mentioned in "The Definitive Guide" so not all can/will be implemented.
Knowing the Differences Between DocBook's Version 4 and Version 5
Modularize your Document with Assemblies
Differentiate DocBook Elements (Divisions, Block, Inline)
Writing Topics with DocBook
Using Tables
Writing a Glossary
Writing a Reference
Writing Bibliographies
Inserting Indexterms
Adding Images
Adding Codelistings
Utilize Extended XLinks
http://www.balisage.net/Proceedings/vol7/html/Vlist01/BalisageVol7-Vlist01.html
Knowing DocBook Derivates: Simple DocBook, Publishers Schema
Using Manpage Notation
<citerefentry>
<refentrytitle>foo</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
Is your feature request related to a problem? Please describe.
How to use and preserve entities are not described.
Describe the solution you'd like
Add topics about how to use and how to preserve entities
Additional context
Should be added to "Manipulating DocBook Document Structure" chapter.
Related to #8
You are using the URL "http://docbook.sourceforge.net/release/xsl-ns/current/fo/docbook.xsl" in various programlistings. For example in the "Print Customization" chapter: "http://doccookbook.sourceforge.net/html/en/dbc.fo.design-titlepages.html"
As far as I know this is an old URL to version 1.78.x. From my opinion this should be "https://cdn.docbook.org/release/xsl/current/fo/docbook.xsl", which is 1.79.2 or newer.
Is your feature request related to a problem? Please describe.
Describe the HTML parameters for chunking
Additional context
HTML, related to #10
A book should contain a topic concerning configuring and using fonts with FO-formatter. This topic will be Apache FOP related only.
Not know yet.
User would like to leave a comment for a specific page.
Create infrastructure to enable users to insert comments for each paragraphs, similar to the Mercurial book (see http://hgbook.red-bean.com/)
Another idea: Probably a link to the GH issue page should be enough.
The code pretty printer from Google has changed its link:
Old link: http://code.google.com/p/google-code-prettify/
New link: https://github.com/google/code-prettify
http://doccookbook.sourceforge.net/html/en/dbc.html.sh.google-code-prettifiy.html
Reported by Peter Schmelzer
Change link to new link.
Moved from https://sourceforge.net/p/doccookbook/tickets/23/
These are some of the ideas about (X)HTML customizations. The list is no guarantee that all will be implemented.
Is your feature request related to a problem? Please describe.
The current look of my HTML pages are a bit... boring. Furthermore, it should be readable on smartphones and desktop PCs.
Describe the solution you'd like
Is your feature request related to a problem? Please describe.
Missing sitemap.xml
to improve Google SEO results.
Describe the solution you'd like
Add a sitemap.xml
.
Additional context
To split big sitemaps into smaller ones, use this URL: https://support.google.com/webmasters/answer/75712?visit_id=0-636655319635101674-843455639&rd=1
Sitemap Schema: https://www.sitemaps.org/schemas/sitemap/0.9/
Chapter 1, section 1.2 Selecting the Right Top Level Element, Discussion section
There a many more possible root elements, not only book.
It looks like a grammar error.
I think that it should be written as "There are many more possible root elements, not only book.
"
Moved from https://sourceforge.net/p/doccookbook/tickets/17/
Reported by David Cramer.
Certain programlistings contain very long lines:
http://doccookbook.sf.net/html/en/DoCookBook.html#dbc.structure.remove-blocks-in-para
As a result, the entire html page has a huge horizontal scroll bar. Perhaps put a box with a scroll bar (if necessary) around each programlisting?
Moved from https://sourceforge.net/p/doccookbook/tickets/16/
Reported by Michael Wiedmann
Please create an EPUB version of the source files.
A first try using the ruby script dbtoepub (which is part of the DocBook-XSL distribution) without any customization already gives very promising output!
Make HTML and PDF also available as downloads.
Currently, all HTML pages are stored at SourceForge. It would be nice to have it all under one roof.
As a showcase, use assemblies in the future
Moved from https://sourceforge.net/p/doccookbook/tickets/29/
Implement syntax highlighting in online output for screen or programlisting.
Useful links:
Reported from @sknorr via mail (found in http://doccookbook.sf.net/html/en/dbc.structure.move-blocks-in-para.html):
Example:
<para>
This manual uses the following
<!-- comment --><phrase>commands</phrase>:
<screen>foo</screen>
</para>
Output is:
<para>
This manual uses the following
</para>
<screen>foo</screen>
Patch:
diff --git i/en/xml/structure/remove-blocks-in-para/move-blocks-outof-para.xsl w/en/xml/structure/remove-blocks-in-para/move-blocks-outof-para.xsl
index 5f87f64..5ed971e 100644
--- i/en/xml/structure/remove-blocks-in-para/move-blocks-outof-para.xsl
+++ w/en/xml/structure/remove-blocks-in-para/move-blocks-outof-para.xsl
@@ -33,7 +33,7 @@
select="following-sibling::*[&dbselfblocks;][1]"/>
</xsl:template>
- <xsl:template match="d:para/*|d:para/text()" mode="copy">
+ <xsl:template match="d:para/node()" mode="copy">
Moved from https://sourceforge.net/p/doccookbook/tickets/26/
Write a colophon explaining how this book is/was produced; which tools, fonts, etc. are used
We need an issue template.
Whenever someone opens a new issue, the user should see a basic structure.
The "Release" link in GitHub misses a HTML (or PDF) file which is automatically created by Travis CI.
After a new release, Travis builds the HTML (or PDF) and uploads it to the "Release" page.
Moved from https://sourceforge.net/p/doccookbook/tickets/25/
It seems, there is an interested in a chapter about [a] DocBook toolchain(s). The chapter could explain what software/tools you need, how to install it, and how to use it.
Unfortunately, this is a (very?) broad topic. Requirements, operating systems, and steps differ a lot. As such, DocBook does not have an "official" toolchain.
Currently, it's not of high priority for me, although it would be probably very beneficial. If someone wants to take this over, please go ahead! :-)
Moved from https://sourceforge.net/p/doccookbook/tickets/20/
These are some of the ideas about common customizations. The list is no guarantee that all will be implemented.
The book needs a decent index, maybe created semi-automatically.
The book contains an index with the following properties:
I would like to contribute to your cookbook as well as helping you to get it published. I have a relationship with Apress Books and I could have the manuscript submitted for publication. I am interested in anything I can contribute including existing and new content. I have a special interest in using open source tools to transform DocBook into content like pdf, html, and other open formats.
Currently I am finishing my second book with Apress and I will be available shortly to work on content for your book. I only ask to be considered a co-author should my contributions be considered good enough.
I look forward to hearing from you and providing new content for your book.
Thank you,
W. David Ashley
[email protected]
512.289.7506
Austin, Texas
How to use database driven reusable content in a Docbook article/book?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.