Refs #6101. First pass at the qtassistant setup.

Missing all autogenerated code and lots of information.

Code/Mantid/CMakeLists.txt

@@ -136,6 +136,8 @@ endif ( MAKE_VATES )
 
 add_subdirectory ( MantidPlot )
 
+add_subdirectory ( docs )
+
 # python unit tests
 if (PYUNITTEST_FOUND)
   add_subdirectory ( scripts )

Code/Mantid/docs/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory ( qtassistant )

Code/Mantid/docs/qtassistant/CMakeLists.txt

@@ -0,0 +1,30 @@
+######################################################################
+# QT assistant documentation generator
+######################################################################
+#QT_QCOLLECTIONGENERATOR_EXECUTABLE
+if (QT_QCOLLECTIONGENERATOR_EXECUTABLE)
+   message (STATUS "Adding information for qtassistant: mantid.qhc")
+   set (HELP_QHCP_SOURCE 
+         mantid.qhcp
+         img/Mantid_Logo_Transparent.png
+         img/MantidPlot_Icon_32offset.png
+         src/about.txt
+         src/algorithms.html
+         src/algorithms.qhp
+         src/fitfunctions.html
+         src/mantidgeneral.qhp
+        )
+
+   add_custom_command(OUTPUT  mantid.qhc algorithms.qch mantidgeneral.qch
+                      DEPENDS ${HELP_QHCP_SOURCE}
+		      COMMAND ${QT_QCOLLECTIONGENERATOR_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/mantid.qhcp
+		      )
+
+   add_custom_target ( qtassistant ALL
+                       DEPENDS mantid.qhc MantidPlot)
+
+#   install ( FILES mantid.qhc algorithms.qch mantidgeneral.qch
+#             DESTINATION ${GUI_HELP_DEST} <- TODO define this variable
+#             COMPONENT help )             <- TODO define this component
+
+endif()

Code/Mantid/docs/qtassistant/README.md

@@ -0,0 +1,12 @@
+mycollection.qhcp        - main collection file that has generic about information
+myapplication-manual.qhp - information about an individual manual
+mycollection.qhc         - final output file to use
+myapplication-manual.qch - cache file for the applications help info
+
+To generate the help run
+
+ qcollectiongenerator mycollection.qhcp -o mycollection.qhc
+
+To view use
+
+ assistant-qt4 -collectionFile mycollection.qhc

Code/Mantid/docs/qtassistant/mantid.qhcp

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<QHelpCollectionProject version="1.0">
+     <assistant>
+         <title>Mantid Help</title>
+         <startPage>qthelp://org.mantidproject/doc/index.html</startPage>
+         <applicationIcon>img/MantidPlot_Icon_32offset.png</applicationIcon>
+         <enableFilterFunctionality>false</enableFilterFunctionality>
+         <enableDocumentationManager>true</enableDocumentationManager>
+         <enableAddressBar visible="true">false</enableAddressBar>
+         <cacheDirectory>mantidproject/mantid</cacheDirectory>
+         <aboutMenuText>
+             <text>About Mantid</text>
+         </aboutMenuText>
+         <aboutDialog>
+             <file>src/about.txt</file>
+             <icon>img/Mantid_Logo_Transparent.png</icon>
+         </aboutDialog>
+     </assistant>
+     <docFiles>
+         <generate>
+             <file>
+                 <input>src/mantidgeneral.qhp</input>
+                 <output>mantidgeneral.qch</output>
+             </file>
+             <file>
+                 <input>src/algorithms.qhp</input>
+                 <output>algorithms.qch</output>
+             </file>
+         </generate>
+         <register>
+             <file>mantidgeneral.qch</file>
+             <file>algorithms.qch</file>
+         </register>
+     </docFiles>
+</QHelpCollectionProject>

Code/Mantid/docs/qtassistant/src/about.txt

@@ -0,0 +1 @@
+Lots of really helpful information about mantid.

Code/Mantid/docs/qtassistant/src/algorithms.qhp

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<QtHelpProject version="1.0">
+     <namespace>org.mantidproject.algorithms</namespace>
+     <virtualFolder>doc</virtualFolder>
+     <filterSection>
+         <!--
+         <toc>
+	   <section title="Algorithms" ref="./algorithms.html"/>
+         </toc>
+	 -->
+         <keywords>
+	   <keyword name="Algorithms" ref="./algorithms.html"/>
+	 <!--
+             <keyword name="Display" ref="./index.html"/>
+             <keyword name="Rich text" ref="./index.html"/>
+             <keyword name="Plain text" ref="./index.html"/>
+             <keyword name="Find" ref="./findfile.html"/>
+             <keyword name="File menu" ref="./findfile.html"/>
+             <keyword name="File name" ref="./filedialog.html"/>
+             <keyword name="File dialog" ref="./filedialog.html"/>
+             <keyword name="File globbing" ref="./wildcardmatching.html"/>
+             <keyword name="Wildcard matching" ref="./wildcardmatching.html"/>
+             <keyword name="Wildcard syntax" ref="./wildcardmatching.html"/>
+             <keyword name="Browse" ref="./browse.html"/>
+             <keyword name="Directory" ref="./browse.html"/>
+             <keyword name="Open" ref="./openfile.html"/>
+             <keyword name="Select" ref="./openfile.html"/>
+	 -->
+         </keywords>
+         <files>
+	   <file>algorithms.html</file>
+             <!--
+             <file>browse.html</file>
+             <file>filedialog.html</file>
+             <file>findfile.html</file>
+             <file>index.html</file>
+             <file>intro.html</file>
+             <file>openfile.html</file>
+             <file>wildcardmatching.html</file>
+             <file>images/browse.png</file>
+             <file>images/fadedfilemenu.png</file>
+             <file>images/filedialog.png</file>
+             <file>images/handbook.png</file>
+             <file>images/mainwindow.png</file>
+             <file>images/open.png</file>
+             <file>images/wildcard.png</file>
+	     -->
+         </files>
+     </filterSection>
+</QtHelpProject>