aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Documentation/Makefile8
-rw-r--r--Documentation/user-manual.txt4
-rw-r--r--subsurface.pro15
3 files changed, 19 insertions, 8 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.
diff --git a/subsurface.pro b/subsurface.pro
index 6d13c1de8..2eaed32f5 100644
--- a/subsurface.pro
+++ b/subsurface.pro
@@ -15,6 +15,11 @@ else: TARGET = subsurface
VERSION = 4.0.2
+# enable or disable the dive planner
+planner {
+ DEFINES += ENABLE_PLANNER
+}
+
HEADERS = \
color.h \
deco.h \
@@ -226,7 +231,10 @@ QTTRANSLATIONS = \
qt_sv.qm \
qt_zh_TW.qm
-doc.commands += $(CHK_DIR_EXISTS) $$OUT_PWD/Documentation || $(MKDIR) $$OUT_PWD/Documentation $$escape_expand(\\n\\t)$(MAKE) -C $$PWD/Documentation OUT=$$OUT_PWD/Documentation/ doc
+# Should we enable the planner sections in the manual?
+planner: ENABLE_PLANNER=1
+else: ENABLE_PLANNER=0
+doc.commands += $(CHK_DIR_EXISTS) $$OUT_PWD/Documentation || $(MKDIR) $$OUT_PWD/Documentation $$escape_expand(\\n\\t)$(MAKE) -C $$PWD/Documentation OUT=$$OUT_PWD/Documentation/ ENABLE_PLANNER=$$ENABLE_PLANNER doc
all.depends += doc
QMAKE_EXTRA_TARGETS += doc all
@@ -267,10 +275,5 @@ QMAKE_INFO_PLIST = packaging/macosx/Info.plist.in
OTHER_FILES += $$DESKTOPFILE $$ICON $$MANPAGE $$XSLT_FILES $$DOC_FILES $$MARBLEDIR \
$$QMAKE_INFO_PLIST
-# enable or disable the dive planner
-planner {
- DEFINES += ENABLE_PLANNER
-}
-
include(subsurface-gen-version.pri)
include(subsurface-install.pri)