Commit graph

16 commits

Author SHA1 Message Date
Michael Keller
618e38151a CICD: Automate Processing of the Documentation.
Automate processing of the documentation to ensure it is processable.
Also fix some bugs in the existing input files for the documentation and
re-enable linting.

Signed-off-by: Michael Keller <github@ike.ch>
2024-02-10 09:32:31 -08:00
Dirk Hohndel
4197faf1b7 update documentation processing
- fix typo in Makefile
- remove unmaintained Russian translation
- try to fix incompatibilities with current asciidoc version
- update processed files

Unfortunately I wasn't able to figure out one error that stops the linting of
the mobile manual from succeeding - as a result I turned of linting for now
(that's the '-L' flag that was added to a2x)

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2024-02-08 13:26:39 -08:00
Dirk Hohndel
9891bdc9ee mobile manual: update version and date
Also update the rendered version.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-10-30 08:50:30 -07:00
Dirk Hohndel
e454669215 documentation: remove location service reference from mobile manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-09-13 11:21:34 -07:00
Dirk Hohndel
56ffa95459 mobile/user-manual: update date and version
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-03-31 10:20:44 -07:00
Dirk Hohndel
9686b4cf74 documentation: gentle nudge back to standardized US-English
Just changing the two user manuals. This also includes a couple other spell
fixes as well as one small adjustment regardinf IrDA support on Linux (which
has been gone for a while now).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-03-11 08:12:40 -08:00
Willem Ferguson
a651bb4550 mobile/manual: small changes to improve mobile manual
Better image placement, other small changes.

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2021-02-24 10:03:12 -08:00
willemferguson
9da9133372 Mobile user manual update: statistics
As the title says. This is a first pass because I cannot see what it looks like
on the mobile device if it has not been pulled into master. I need to see what
size the images have on the mobile screen and how the organisation of text above
and below the images is rendered. There will definitely be a second PR to refine
the content for the mobile screen and to ensure proper integration of the
statistics section with the overall user manual..

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
2021-02-17 07:21:01 -08:00
Willem Ferguson
70ebc2bee7 documentation/mobile-manual: create a merged v3 manual
Unintentionally two versions of the mobile manual were created. This brings all
of Willem's changes into the version for Subsurface-mobile v3, and restores the
last version of the v2 mobile manual.

This commit was manually created from a pull request that was signed off by
Willem, given that he wrote most of the text I am copying that SOB into this
commit and will assign authorship to him.

To avoid further confusion, we now have a v2 and a v3 manual, explicitly named.
The corresponding .html.git files were also updated (reflecting our switch to
asciidoctor).

Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-05-05 17:55:02 -07:00
Dirk Hohndel
716c3c3ed5 mobile/user-manual: update to remove reference to 'map it' button
It's still in the screen shot, but I'll fix that some other time.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-31 08:42:20 -07:00
Dirk Hohndel
851c8c273a mobile/user-manual: add hyperlinks where useful
Suggested-by: Martin de Weger <martin@deweger.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27 12:32:06 -07:00
Crawford Currie
b0572dd043 mobile/user-manual: small language tweaks
[Dirk Hohndel: added another fix to Crawford's commit]

Signed-off-by: Crawford Currie <curriedot@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-27 12:31:43 -07:00
Miika Turkia
a8e2aef785 mobile/user-manual: some tuning of the text
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-24 16:44:26 -07:00
Miika Turkia
5d3f92362d mobile/user-manual: typo fixes
Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-24 16:43:45 -07:00
Dirk Hohndel
0b83971ff9 macOS: still issues with mixed case names
It's 2020. And by default the file system in macOS is still case
insensitive. Right. Of course.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-23 20:58:49 -07:00
Dirk Hohndel
97c7fad53d Subsurface-mobile v3 user manual
While this is based in large parts on the existing manual, it is a fairly
substantial rewrite with mostly new screenshots.

Includes edits by Rainer Mohr.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-03-23 20:48:03 -07:00