Package org.apache.sis.internal.book


package org.apache.sis.internal.book
Takes the source HTML files in the sis-site/main/source/developer-guide/ directory and assembles them in a single file to be published in the asf-staging/book/ directory.

The main class in this package is Assembler. Other classes are helper classes that should be ignored. Assuming the following directory layout:

<current directory>
 ├─ master
 │   └─ core
 │       └─ sis-build-helper
 └─ site
     ├─ main
     │   └─ source
     └─ asf-staging
         └─ book
 
Then the command can be used as below on Unix systems:
java -classpath master/core/sis-build-helper/target/classes org.apache.sis.internal.book.Assembler site

Future evolution

We may replace (at least partially) this tools by some more advanced open-source alternatives. Known candidates are: A goal is to keep HTML5 as the language of source files, not DocBook or AsciiDoc or others. See HTML5 as an alternative to DITA and DocBook.
Since:
0.7
Version:
1.3
  • Class
    Description
    Generates the developer guide from the given input file.
    Thrown when an error is found in the content of the HTML files used for building the developer guide.
    Utilities related to the handling of characters.
    Apply syntax colorization on Java code.
    The specifier of an identifier.