The easiest way to begin a new document is to copy the directory
for an existing document and then make the necessary changes for
the new document. To facilitate this process, the
proto-doc directory of the
mysqldoc-toolset repository can be used as a
basis for a new document. Use it like this (assuming that you are
located in the root directory of the
repository and want to create a new document directory named
Make a copy of the
cp -r ../mysqldoc-toolset/proto-doc my-doc
Change location into the new directory:
proto-book.xmlfile to the name that you'll use for your document:
mv proto-book.xml my-doc.xml
my-doc.xmland edit as necessary. For example, change the title to something meaningful.
Makefileto change instances of
my-docand instances of
MY_DOC. Also read the other comments in the
Makefileand make any appropriate changes.
Makefileto list the correct dependencies for the document:
legalnotice.with the actual copyright date.
Change location a level up to the parent directory, add the new directory to the value of the
SUBDIRSvariable in the parent directory
At this point, you can develop the document further to create its content. Use Section 4.4, “General Document Organization”, as a guide to structuring it.