Skip to content

Commit

Permalink
Create a template for new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidpriest committed Nov 2, 2012
1 parent 063bd23 commit 9cfabd1
Show file tree
Hide file tree
Showing 11 changed files with 76 additions and 0 deletions.
6 changes: 6 additions & 0 deletions _TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# TEMPLATE

Copy this to your writing/working directory. Rename appropriately for
the document you will create. Modify `mk_bash.sh` or `mk_win.bat` as
appropriate, setting the path to DOCTOOLS.

7 changes: 7 additions & 0 deletions _TEMPLATE/_RootDocument.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Plain Text Publishing
=====================
:xshowcomments:

== Welcome to Plain Text Publishing

This is the root document for your next great work.
30 changes: 30 additions & 0 deletions _TEMPLATE/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<cover>
<para xml:id="brand">Product Brand Name</para>
<para xml:id="docinfo_sku">product sku</para>
<para xml:id="docinfo_copyright">&#xA9; 2012, My Big Company, Inc. All rights reserved.</para>
<para xml:id="docinfo_org">MBCI</para>
<para xml:id="docinfo_orgurl">www.w3.org</para>
</cover>


<legalnotice>
<title>Disclaimer</title>
<para>Copyright &#xA9; 2012 <orgname class="corporation">My Big Company,
Inc.</orgname></para>
<para>This documentation and any accompanying software are released
&#x201C;as is.&#x201D; My Big Company, Inc. (MBCI), makes no warranty of any kind, expressed or
implied, concerning these materials, including without limitation, any
warranties of merchantability or fitness for a particular purpose. In no
event will MBCI be liable for any damages, including any lost profits,
lost savings, or other incidental or consequential damages arising out of
the use, or inability of use, of documentation or any accompanying software,
even if informed in advance of the possibility of such damages.</para>
<title>Trademarks</title>
<para><trademark class="registered">MBCI</trademark> is a registered
trademarks of <orgname class="corporation">My Big Company, Inc.</orgname></para>
<para><trademark class="registered">Windows</trademark>, <trademark
class="registered">Internet Explorer</trademark>, and <trademark
class="registered">Windows Vista</trademark> are registered trademarks of
<orgname class="corporation">Microsoft Corporation</orgname> in the United
States and/or other countries.</para>
</legalnotice>
5 changes: 5 additions & 0 deletions _TEMPLATE/mk_bash.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/bash
DOCUMENT=_RootDocument.txt
export DOCTOOLS=$PWD/../ptp-tools

$DOCTOOLS/mksupport-common/mk_bash.sh $DOCUMENT -d book
6 changes: 6 additions & 0 deletions _TEMPLATE/mksupport/asciidoc.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[attributes]
docinfo1=

[replacements]
# ignore case, use word boundaries
(?i)\bMBCI\b=My Big Company, Inc.
7 changes: 7 additions & 0 deletions _TEMPLATE/mksupport/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
hr{color:blue;}
p.remark{margin:0em;padding:0em 0.25em;background-color:yellow;}
span.remark{background-color:yellow;}
span.remark:before{content:"# ";}
.review{border: thin solid red;}
.review + *{border: thin solid red;}
.draft + *{border: thin solid gray;}
3 changes: 3 additions & 0 deletions _TEMPLATE/mksupport/xsl/chunked.xsl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
<xsl:import href="http://davidpriest.ca/mksupport/xsl/chunked.xsl"/>
</xsl:stylesheet>
3 changes: 3 additions & 0 deletions _TEMPLATE/mksupport/xsl/epub.xsl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
<xsl:import href="http://davidpriest.ca/mksupport/xsl/epub.xsl"/>
</xsl:stylesheet>
3 changes: 3 additions & 0 deletions _TEMPLATE/mksupport/xsl/fo-article.xsl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
<xsl:import href="http://davidpriest.ca/mksupport/xsl/fo-article.xsl"/>
</xsl:stylesheet>
3 changes: 3 additions & 0 deletions _TEMPLATE/mksupport/xsl/fo.xsl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
<xsl:import href="http://davidpriest.ca/mksupport/xsl/fo.xsl"/>
</xsl:stylesheet>
3 changes: 3 additions & 0 deletions _TEMPLATE/mksupport/xsl/xhtml.xsl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
<xsl:import href="http://davidpriest.ca/mksupport/xsl/xhtml.xsl"/>
</xsl:stylesheet>

0 comments on commit 9cfabd1

Please sign in to comment.