diff options
| author |  Anton Lundin <glance@acc.umu.se> | 2014-04-07 14:25:03 +0200 |
|---|---|---|
| committer |  Dirk Hohndel <dirk@hohndel.org> | 2014-04-07 10:17:45 -0700 |
| commit | 0bf79e216f312010b78c81904e12b2feadcdaa14 (patch) | |
| tree | 1b609d0ef73454a6cdce879a9d8e4211fbde2cdd /Documentation | |
| parent | 57bfa7e353975f3f8cd754ca8632460cf9ef8822 (diff) | |
| download | subsurface-0bf79e216f312010b78c81904e12b2feadcdaa14.tar.gz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Makefile | 8 | ||||
| -rw-r--r-- | Documentation/user-manual.txt | 4 |
2 files changed, 10 insertions, 2 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 204aeb8e8..611bd2fb0 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -15,6 +15,10 @@ A2X = a2x BROWSER = firefox THEME = compact_subsurface PWD = $(realpath .) +ENABLE_PLANNER := 0 +ifeq ($(ENABLE_PLANNER), 1) +ENABLE_PLANNER_ATTR=-a ENABLE_PLANNER=$(ENABLE_PLANNER) +endif all: doc $(addprefix $(DOCNAME).,pdf text) @@ -29,11 +33,11 @@ $(OUT)$(DOCNAME).pdf: $(DOCSOURCE) $(OUT)$(HTMLDOC): $(DOCSOURCE) @echo "if asciidoc isn't found the html file included in the sources is copied" $(ASCIIDOC) -a toc -a toclevels=3 -a themedir=$(PWD) -a theme=$(THEME) -a stylesdir=$(PWD) \ - -o $(OUT)$(HTMLDOC) $< || cp $(HTMLDOC).git $(OUT)$(HTMLDOC) + $(ENABLE_PLANNER_ATTR) -o $(OUT)$(HTMLDOC) $< || cp $(HTMLDOC).git $(OUT)$(HTMLDOC) # Alternatively:: $(OUT)$(DOCNAME).xhtml: $(DOCSOURCE) - $(A2X) --icons -f xhtml $< + $(A2X) $(ENABLE_PLANNER_ATTR) --icons -f xhtml $< show: $(HTMLDOC) $(BROWSER) $< diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index a80dfe6c9..67b3c0ae6 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1775,6 +1775,7 @@ language / country settings as the underlying OS. If this is for some reason undesirable users can uncheck this checkbox and pick a language / country combination from the list of included localizations. +ifdef::ENABLE_PLANNER[] [[S_DivePlanner]] == The Subsurface dive planner The dive planner is accessed by selecting _Log -> Plan Dive_ from the main menu. This @@ -1868,6 +1869,7 @@ there is no provision for any reserve gas. image::images/Planner2.jpg["FIGURE: Planning a dive: evaluation",align="center"] This part of the software is in active development. +endif::ENABLE_PLANNER[] == Description of the Subsurface Main Menu items @@ -1906,7 +1908,9 @@ from _www.Divelogs.de_. - <<S_EnterData,_Add Dive_>> - Manually add a new dive to the *Dive List* panel. - <<S_Renumber,_Renumber_>> - Renumber the dives listed in the *Dive List* panel. +ifdef::ENABLE_PLANNER[] -_Plan Dive_ - This experimental feature allows planning of simple dives. +endif::ENABLE_PLANNER[] - <<S_Group,_Auto Group_>> - Group the dives in the *Dive List* panel into dive trips. - _Edit Device Names_ - Edit the names of dive computers. |