Commit graph

16 commits

Author SHA1 Message Date
Anton Lundin
0bf79e216f Use the ENABLE_PLANNER macro in the manual too
This introduces ifdef control structures in the manual too, so we can
continue to develop both the planner and its manual, until its ready for
release.

Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-04-07 10:17:45 -07:00
Thiago Macieira
3318aefa46 Make sure the user-manual.html output always ends up in $(OUT)
If you're doing a non-local build, it would get saved in the source
dir. Then qmake would complain that it couldn't find it in the target
dir.

Signed-off-by: Thiago Macieira <thiago@macieira.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-25 15:30:38 -08:00
Dirk Hohndel
17dfee415a Include the user-manual.html file in the git tree
This way when building Subsurface asciidoc is not necessary at all - except if
you want to work on the user manual and want to see the result of your work.

Previously the build wouldn't fail without asciidoc, but there would be no
working user manual when pressing F1 from within the application. This solves
the problem by shipping the HTML file with the sources.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-20 16:39:56 -08:00
Sergey Starosek
12981030a5 Fix asciidoc CSS path
Both JS and CSS resources need to be embedded into HTML

Signed-off-by: Sergey Starosek <sergey.starosek@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-10 14:38:45 +01:00
Willem Ferguson
8b74ffc35b Updated user manual
1) Added Main Menu items description
2) Added Divelogs.de description
3) Removed paragraph defining EAD & END
4) Several typos corrected
5) Positions of several figures standardised to align="central"

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 21:38:16 +01:00
Dirk Hohndel
4675ab0617 Fix possible compatibility issue with asciidoc
Apparently some version os asciidoc don't support the --theme option.
Work around this by using -a theme='theme' instead.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 16:12:36 +01:00
Willem Ferguson
3a49ad6ba5 Update to manual
- Companion app added
- Figures updated & reorganised
- Small amount of reorganisation of text
- Typos corrected

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-09 13:54:11 +01:00
Willem Ferguson
d84f397790 Add compact style to the Documentation
The Makefile changes were authored by Dirk, the CSS is based on a public
domain CSS file and authored by Willem

Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-12-08 07:50:34 +01:00
Thiago Macieira
67e49d6480 Implement a qmake-based build for Subsurface
This is working for me, but requires a bit more testing. To build,
run:
  qmake [options]

Where options might be:
  V=1               disable "silent" build
  LIBDCDEVEL=1      use side-by-side libdivecomputer
  INCLUDEPATH+=xxx  add -Ixxx (e.g., INCLUDEPATH+=/usr/local/marble/include)
  LIBS+=xxx         add xxx to the linker flags (e.g. LIBS+=-L/usr/local/marble/lib)
  or any other qmake option, including debug and release options

If your distribution is already using qtchooser in place of qmake, you
may need to pass an extra option to qmake to select the a
cross-build. For example:

  qmake -qt=i686-w64-mingw32-qt4

If your distribution is not yet using qtchooser, then you need to file
a bug report requesting it and you need to run the full path to qmake.

Note:
 - there are some ### left in the buildsystem

Signed-off-by: Thiago Macieira <thiago@macieira.org>
2013-10-08 23:29:33 -07:00
Dirk Hohndel
de8bfe9bc3 Crude hack to stop the build from failing without asciidoc
This could be made much more elegant. For now it serves its purpose.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-08-05 17:22:11 +02:00
Cristian Ionescu-Idbohrn
806f4f87e0 Makefile quorks :( Yes we want a 'doc' target for itself...
...to avoid generating the HTMLDOC target even if it needs not to.

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 15:16:41 -08:00
Miika Turkia
8facc61e8f [PATCH] Adding screen captures of dive planning
[Dirk Hohndel: removed the images folder from the Documentation directory
               Makefile clean target]

Signed-off-by: Miika Turkia <miika.turkia@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:55:38 -08:00
Cristian Ionescu-Idbohrn
17638aa7b0 Cleanup more and rearrange targets.
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:51:29 -08:00
Cristian Ionescu-Idbohrn
bc98b3f6f2 Improved maitainability.
Cleans up more files.
Got even an 'all' target :)

Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19 06:50:20 -08:00
Reinout Hoornweg
51cac900aa Updates to the user-manual: DivePlanning
- Added some more text to Miika's great start describing the planner.
- Tried doing something more with the formatting options asciidoc give us.

[Dirk Hohndel: merged with my earlier changes to the same section]

Signed-off-by: Reinout Hoornweg <reinout@xs4all.nl>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18 13:28:25 -08:00
Linus Torvalds
1a83bf43b6 First try at converting user-manual to AsciiDoc
You can do "make doc" in the main directory to create the html version,
and if you want to play around with it, do "make show" in the
Documentation subdirectory to start firefox on the end result.

It's by no means perfect, but it gives somewhat reasonable results, and
this is enough initial work for people to play around with, I think.

NOTE! You need "asciidoc" installed to do this: it's a python program,
so it should be pretty easy even on non-Linux platforms.  And on Linux,
most distributions package it, so you just have to do something like

	yum install asciidoc

to get it (replace with apt-get/zypper/whatever).

Asciidoc can generate other output too (man-pages, LaTeX, etc), maybe
people want to play with that part too.

Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2012-01-01 15:12:28 -08:00