Doc: Add a doc project for the Fossil plugin

Change-Id: Ic465b8838f090688fab2fc966fa3fbf7409c13a2
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

doc/config/fossil.qdocconf

@@ -0,0 +1,35 @@
+project     = "fossil"
+description = "Qt Creator Fossil Plugin Manual"
+
+sourcedirs += ../src
+#imagedirs += ../images
+
+include($$QTC_DOCS_DIR/config/macros.qdocconf)
+include($$QTC_DOCS_DIR/config/qt-cpp-ignore.qdocconf)
+include($$QTC_DOCS_DIR/config/qt-defines.qdocconf)
+
+sources.fileextensions  = "*.qdoc"
+
+depends += qtcreator
+
+qhp.projects                = fossil
+qhp.fossil.file             = fossil.qhp
+qhp.fossil.namespace        = org.qt-project.qtcreatorfossil.$$QTC_VERSION_TAG
+qhp.fossil.virtualFolder    = qtcreatorfossil
+qhp.fossil.indexTitle       = Qt Creator Fossil Plugin Manual
+qhp.fossil.filterAttributes = qtcreatorfossil $QTC_VERSION
+qhp.fossil.customFilters.QtCreatorFossil.name = Qt Creator Fossil Plugin $QTC_VERSION
+qhp.fossil.customFilters.QtCreatorFossil.filterAttributes = qtcreatorfossil $QTC_VERSION
+qhp.fossil.indexRoot        =
+
+qhp.fossil.subprojects                   = manual
+qhp.fossil.subprojects.manual.indexTitle = Qt Creator Fossil Plugin Manual
+qhp.fossil.subprojects.manual.title      = Qt Creator Fossil Plugin Manual
+qhp.fossil.subprojects.manual.type       = manual
+
+# Doxygen compatibility commands
+macro.see                       = "\\sa"
+macro.function                  = "\\fn"
+
+navigation.homepage = "Qt Creator Fossil Plugin Manual"
+buildversion        = "Qt Creator Fossil Plugin Manual $QTC_VERSION"

doc/doc.pri

@@ -0,0 +1,6 @@
+build_online_docs: \
+    QTC_DOCS = $$PWD/fossil-online.qdocconf
+else: \
+    QTC_DOCS = $$PWD/fossil.qdocconf
+
+include($$IDE_SOURCE_TREE/docs.pri)

doc/fossil-online.qdocconf

@@ -0,0 +1,16 @@
+include(config/fossil.qdocconf)
+
+HTML.footer = \
+    "   </div>\n" \
+    "   <p class=\"copy-notice\">\n" \
+    "   <acronym title=\"Copyright\">&copy;</acronym> 2017 The Qt Company Ltd.\n" \
+    "   Documentation contributions included herein are the copyrights of\n" \
+    "   their respective owners. " \
+    "   The documentation provided herein is licensed under the terms of the" \
+    "   <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation" \
+    "   License version 1.3</a> as published by the Free Software Foundation. " \
+    "   Qt and respective logos are trademarks of The Qt Company Ltd " \
+    "   in Finland and/or other countries worldwide. All other trademarks are property\n" \
+    "   of their respective owners. </p>\n"
+
+include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)

doc/fossil.qdocconf

@@ -0,0 +1,2 @@
+include(config/fossil.qdocconf)
+include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)

doc/src/creator-vcs-fossil.qdoc

@@ -30,12 +30,9 @@
 // **********************************************************************
 
 /*!
-    \contentspage {Qt Creator Manual}
-    \previouspage creator-vcs-cvs.html
     \page creator-vcs-fossil.html
-    \nextpage creator-vcs-git.html
 
-    \title Using Fossil
+    \title Qt Creator Fossil Plugin Manual
 
     Fossil is an open source distributed version control system, designed
     and developed by the creator of SQLite. A stand-alone Fossil executable
@@ -43,17 +40,21 @@
     wiki, and built-in web server. Fossil is available for Linux, Windows,
     and \macos.
 
+    To use Fossil from \QC, you must install and configure it, as described in
+    the following sections.
+
     \section1 Configuring Fossil
 
     \list 1
-        \li Download the \l{http://fossil-scm.org}{Fossil SCM client} and install
+        \li Download the \l{http://fossil-scm.org}{Fossil SCM client} and
-            the \c fossil executable file in your \c PATH.
+            install the \c fossil executable file in your \c PATH.
 
-        \li Create or designate a directory to store local Fossil repositories and
+        \li Create or designate a directory to store local Fossil repositories
-           remote clones. For example: \c ~/fossils/qt.
+            and remote clones. For example: \c ~/fossils/qt.
 
-        \li Configure \uicontrol {Version Control Options} for the Fossil plugin to use
+        \li Configure \uicontrol {Version Control Options} for the Fossil plugin
-           the designated directory as \uicontrol {Local Repositories Default path}.
+            to use the designated directory as
+            \uicontrol {Local Repositories Default path}.
     \endlist
 
     Now Fossil should become available as a VCS choice to create new local
@@ -63,8 +64,9 @@
     \section1 Additional Fossil Functions
 
     In addition to the standard version control system functions described in
-    \l{Using Common Functions}, the \uicontrol Fossil submenu contains
+    \l {Using Version Control Systems}, the \uicontrol Fossil submenu contains
     the following items:
+
     \table
         \header
             \li Menu Item

fossil.pro

@@ -1,2 +1,5 @@
 TEMPLATE = subdirs
 SUBDIRS += plugins/fossil
+
+include($$IDE_SOURCE_TREE/qtcreator.pri)
+include(doc/doc.pri)

plugins/fossil/fossilplugin.cpp

@@ -43,6 +43,7 @@
 #include <coreplugin/id.h>
 #include <coreplugin/vcsmanager.h>
 #include <coreplugin/coreconstants.h>
+#include <coreplugin/helpmanager.h>
 #include <coreplugin/icore.h>
 #include <coreplugin/idocument.h>
 #include <coreplugin/documentmanager.h>
@@ -152,6 +153,9 @@ bool FossilPlugin::initialize(const QStringList &arguments, QString *errorMessag
 
     createSubmitEditorActions();
 
+    Core::HelpManager::registerDocumentation({Core::ICore::documentationPath()
+                                              + "/fossil.qch"});
+
     return true;
 }