Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.93 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.93 KB

Building Scientific Web Books

This web book describes how to build a scientific web book using the makeWebBook program (source, windows executable):

A book consists of a set of HTML files. A configuration file (configuration.json) defines the order of the files. With the command

makeWebBook bookDirectory

the following actions are preformed provided a corresponding element starts with the text "Chapter" or "Appendix" (otherwise the section is not modified; this is useful for a preface or a reference chapter):

  • <h1>, <h2>, <h3>, <h4> elements are updated with section numbers.

  • <caption> elements are updated with table numbers.

  • <figcaption> elements are updated with figure numbers.

  • <div class="equation"> $$ ... $$ </div> are updated with equation numbers.

  • <a href=”..”>..</a> elements are updated with file name, link text and tool tip if the link points to a position in the book.

If a number is not present, it is introduced (with exception of <h1> element, where a number is only introduced if the text starts with "Chapter" or with "Appendix"). If it is present and correct, nothing is changed. Otherwise, the number is updated.

A navigation bar is introduced in all files with links to the "table of contents" file, the previous, and the next file.

The "table of contents" file is updated with the actual document structure.

This project consist of the following elements:

/Tutorial               // tutorial book of the approach
/TemplateBook           // template to start a new book
makeTemplateBook.bat    // clicking on it runs 
                        // makeWebBook_win64.exe on TemplateBook
makeWebBook_win64.exe   // makeWebBook command for win64