# We set options first [options] # ##### START OF REQUIRED SETTINGS # # # Destination directory to contain the produced book # DO NOT USE THE CURRENT DIRECTORY OR ANY DIRECTORY CONTAINING DATA! # The first action of the htmlbook.sh output script is to remove the # entire directory and create a new one. # So all existing data in the directory is lost when running the htmlbook.sh # script. output directory = /home/joe/work/test-html # Book title title = Introduction to something # Url where to publish the book url = http://www.my-server.org/something # Impressum included in contents # Alternatively you could use "impressum page" impressum link = http://www.my-server.org/impressum.html # The authors name # May be changed per node. author = Me, myself and I # Location where the book is produced # May be changed per node. location = Somewhere # # # ##### END OF REQUIRED SETTINGS # Character set, us-ascii or utf-8. # May be changed per node. html charset = utf-8 # Template used for all the output files # May be changed per node. template = web.hbt # Style used for all the output files # You may want to modify the stylesheet for a color scheme corresponding # to your corporate identity colors. # May be changed per node. style = style.css # Do not print page-internal table of contents # May be changed per node. page toc = no # File used to build index.html index file = index.txt # We do not want to create an index file with clickable keywords indexkw.html create index = no # In our *.txt files we use the correct &... codes ourselves, no need # to convert & to & # May be changed per node. replace ampersand = no # HTML tidy is available, so we use it # May be changed per node. tidy = yes # Use ln instead of cp for resource files # May be changed per node. ln = yes # Write parent headers of current page too to show the current # position in the book # May be changed per node. write position = yes # For the navigation section we can show just icons (icons), # text links (text) or both (both). # This option was intended originally but skipped. # navigation = icons # Shortcut icon # May be changed per node. shortcut icon = favicon.ico # Produce for HTML for CHM (yes) or normal HTML (no) chm = no # We create the following script to install the files to the output directory output script = htmlbook.sh # By default add line numbers to code of sourcefile and code special commands. code line numbers = yes # This optional section is only processed when htmlbook is started by # "htmlbook -o chm index.prj". # You can use it to generate HTML for a CHM. # To enable multiple optional sections, separate them by comma, i.e. # "htmlbook -o chm,windows,this,that... index.prj". [options:chm] chm = yes template = chm.hbt code line numbers = no # The language setting for the CHM project, default is # 0x409 English (USA) # Should correspond to the LANG setting in Makefile/GNUmakefile. # # chm language = 0x407 Deutsch (Deutschland) # [options:web] chm = no template = web.hbt # This optional section is only processed on Windows systems, you do not # need to activate it using "-o windows", this section is processed # automatically. # On non-Windows systems a corresponding [options:non-windows] section # is processed automatically if present. [options:windows] output script = htmlbook.cmd # Additional files to copy [files] example1.c # And now the book contents # Here you see an example structure, replace it by Section headings, # short section headings and file names you need. [contents] Something Install something on Linux/Unix @short = Installation Linux/Unix @file = installu.txt Installation from source @short = Source installation @file = instalus.txt Installation using program X @short = Installation using X @file = instalux.txt Install something on Windows @short = Windows installation @file = installw.txt Start something Start something on Linux/Unix @short = Linux start @file = startu.txt Start something on Windows @short = Windows start @file = startw.txt