File	Date	Author	Commit
figures	2024-01-27	Rob Norris	[343fb8] Github #241: Improve Waypoint dialog layout.
README.txt	2024-07-06	Rob Norris	[d7f564] Github #265: Better ToC usability in PDF output
attribution.xml	2020-06-08	Rob Norris	[2ea5b0] More menu icons
commandline.xml	2024-05-26	Rob Norris	[fdc150] [DOC] Rework help system: Part 1 - Command Line
commandline_details.xml	2024-05-28	Rob Norris	[a998f8] [DOC] Turn list of Map Ids into a more readable...
config.xsl	2012-11-07	Rob Norris	[2151c4] Add configuration to generate help in HTML format
dem_layer.xml	2021-03-09	Rob Norris	[596ff0] Remember to commit test file changes for DEM ch...
edit_view_menus.xml	2024-09-29	Rob Norris	[a0e267] Github #305: Improvements to naming Map (Memory...
extending.xml	2025-07-05	Rob Norris	[c98119] Github #339: Change default download setting to...
geoclue_layer.xml	2020-10-24	Rob Norris	[2c1424] [DOC] GeoClue formatting
georef_layer.xml	2022-05-08	Rob Norris	[957066] SF Features#135: Support Georef layer image rot...
index.docbook	2025-09-29	Rob Norris	[5d8edc] Extend date based rename to work on TrackWaypoi...
legal.xml	2020-06-30	Rob Norris	[73312d] [DOC] Is not a GNOME Documentation Project
mapnik_rendering_layer.xml	2020-12-22	Rob Norris	[3b943b] SF Features#81: XDG-compliant file locations.
recommends.xml	2020-04-18	Rob Norris	[efc6b6] SF Features#153: Add TOC to MasterHelp wiki page
refsynopsis.xml	2025-01-26	Rob Norris	[6988eb] Github #313: Improve documentation for command ...
style.xsl	2024-07-06	Rob Norris	[d7f564] Github #265: Better ToC usability in PDF output
userconfig.xml	2024-05-26	Rob Norris	[692b74] [DOC] Rework help system: Part 3 - User Config
viking.css	2012-11-07	Rob Norris	[2151c4] Add configuration to generate help in HTML format

Read Me

# How to generate HTML from the xml:
xmlto html -m config.xsl index.docbook
# ATM config is setup for a single page - index.html
# then copy the generated *.html files and all files from figures/ into the version to upload
# (e.g. into viking-gps.github.io)

# To generate a block of text for the Wiki:
#html2wiki --dialect=MediaWiki \
#--wiki-uri=http://sourceforge.net/p/viking/wikiallura \
#--base-uri=http://sourceforge.net/p/viking/wikiallura \
#index.html > help.wiki

# Allura Wiki is in Markdown
# pandoc -f docbook index.docbook -t markdown -o help.md
# Note pandoc (at least 1.17.5.4) doesn't open included files within docbook,
#  if using xmlto (but output not that great):
#pandoc -f html index.html -t markdown -o help.md

# Otherwise manually resolve pandoc issues:
# Run for each instance:
pandoc -f docbook index.docbook -t markdown -o help-all.md
for x in $(ls [edgm]*.xml); do pandoc -f docbook $x -o help-$x.md; done
# These done in specific order to help the joining order
pandoc -f docbook recommends.xml -t markdown -o help-r.md
pandoc -f docbook commandline.xml -t markdown -o help-u.md
pandoc -f docbook attribution.xml -t markdown -o help-w.md
pandoc -f docbook legal.xml -t markdown -o help-z.md

# Copy the above outputted files together (with a blank line between them) e.g.:
for x in $(ls help-*.md); do cat $x >> vikhelp.md; echo >> vikhelp.md; done

# Fix APPNAME, APP & DHPACKAGE not being replaced in the .md output, e.g.:
sed -i s/APPNAME/viking/g vikhelp.md
sed -i s/APP/Viking/g vikhelp.md
sed -i s/DHPACKAGE//g vikhelp.md

#
# e.g. use 'retext' program (https://github.com/retext-project/retext) viewer/editor
#

# *Manually* fix broken cross refs:
## Search for ??? in the file and replace with the appropriate string
## (i.e. the text following the next '#' )

# Manually generate an initial contents - don't know an automatic way
## view output with yelp (yelp index.docbook)
## Copy and paste contents list into vikhelp.md
## for each item edit + add the appropriate [Name]'{#linkname}' to generate an internal link
### Each section should now have an id for the linkname in the source help
## (or maybe reuse a previous version of these contents as follows:)

[Introduction](#Introduction)

[General Concepts](#GeneralConcepts)

[File Types and the Main Window](#FileTypes)

[Edit and View Menus](#EditViewMenu)

[Layers](#Layers)

[TrackWaypoint Layer](#TrackWaypoint)

[GPS Layer](#GPS)

[DEM (Digital Elevation Model) Layer](#DEM)

[Map Layer](#Map)

[Aggregate Layer](#Aggregate)

[GeoRef Layer](#GeoRef)

[GeoClue Layer](#GeoClue)

[Mapnik Rendering Layer](#MapnikRendering)

[Coordinate Layer](#Coordinate)

[Tools](#tools)

[Preferences](#prefs)

[Howto's](#Howto)

[Extending Viking](#extend_viking)

[Recommended Programs](#recommends)

[Command Line](#commandline)

[Attributions](#attrib)

[Legal](#Legal)

# Then dump the entirity of the vikhelp.md into the single Wiki Help page.

# To generate the PDF:
dblatex -p style.xsl index.docbook -o viking.pdf