Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All Other

All other documents share a common web-book style sheet definition, which is located in docs/css/trafodion-manuals.css.

The source tree for each manual is organized as follows:

File/DirectoryContent
pom.xml

Maven Project Object Model (POM) used to build the document.

src/

The source files used to define the document.

src/asciidocAsciidoc files for the document.
src/asciidoc/index.adoc

Main asciidoc defining the document. Includes the different chapters from the _chapters directory.

src/asciidoc/_chapters/Source files for the different chapters in the document.
images/Images used in the document.
resources/Other include materials; for example, source examples that are included with the document.
target/Build output directory. Contains the web book, the PDF file, and supporting directories.
target/index.pdfGenerated PDF version of the document.
target/images/

Copy of the images/ directory.

target/resources/

Copy of the resources/ directory.

target/site/Generated web-book directory.
target/site/index.html

Generated web book.

target/site/css/

Style sheets related to the web book. The common style sheet is included in the index.html file.

target/site/images/

Copy of the images/ directory.

target/site/resources/

Copy of the resources/ directory.

...

Do the following:

  1. Build the web site.
  2. Build the different document as described in Making Changes above.
  3. Build the Trafodion Document Tree as described in Build Trafodion Document Tree above.

 

The resulting docs/target/docs/ directory is checked into the web-site SVN branch.

...