Updated user help generators to be more consistent with virtual folder in qt and html doc

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@13832 383ad7c9-94d9-4d36-a494-682f7c89f535

OpenFlipper/Documentation/UserHelpSources/coreplugins.docu

@@ -12,4 +12,7 @@
  * - \ref simplesmoother-plugin "Simple Smoother Plugin"
  * - \ref smoother-plugin "Smoother Plugin"
  *
+
+ *  - <a style="text-decoration:none;" href="../Plugin-Color/index.html"><b>Color Plugin</b></a>
+
  */

OpenFlipper/Documentation/UserHelpSources/mainpage.docu

-/** @mainpage OpenFlipper User Documentation
+/** @mainpage General_User_Doc OpenFlipper General User Documentation
  * @image html splash.png
  * @section intro_sec Introduction
  *
@@ -12,4 +12,9 @@
  * - \subpage scripting "Scripting"
  * - \subpage view "View functions"
  * - \subpage tools "Tools"
+ * - \subpage Plugin-Color-Doc
+*
+*
+
+ * \ref Plugin-Color-Doc
  */

OpenFlipper/Documentation/UserTarget/CMakeLists.txt

@@ -2,7 +2,7 @@ include (ACGDoxygen)
 
 IF (DOXYGEN_FOUND)
 
-  set(user_html_doc_dir "${CMAKE_BINARY_DIR}/Build/${ACG_PROJECT_DATADIR}/Doc/UserHTML")
+  set(user_html_doc_dir "${CMAKE_BINARY_DIR}/Build/${ACG_PROJECT_DATADIR}/Doc/UserHTML/Core")
 
   # Create directories in order to avoid doxygen warnings
   if(NOT (IS_DIRECTORY ${user_html_doc_dir}) )

OpenFlipper/Documentation/UserTarget/doxy.config.in

@@ -660,8 +660,7 @@ RECURSIVE              = YES
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources \
-                         @CMAKE_SOURCE_DIR@/MacOS
+EXCLUDE                = 
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded

OpenFlipper/widgets/helpWidget/helpWidget.cc

@@ -91,6 +91,8 @@ HelpWidget::HelpWidget(QWidget* parent, const QString& _homeSite)
 
   tabWidget_ = new QTabWidget(this);
 
+  // Generate the help engine. The filename is in the users home directory and
+  // contains all registered help resources.
   helpEngine_ = new QHelpEngine(filename, this);
   
   helpEngine_->setupData();
@@ -157,7 +159,39 @@ HelpWidget::HelpWidget(QWidget* parent, const QString& _homeSite)
   connect(textWindow_, SIGNAL(urlChanged(const QUrl&)), this, SLOT(update(const QUrl&)));
 
   // Register documentation
-  helpEngine_->registerDocumentation(filename);
+  // Seems to be an unneeded call!
+  //helpEngine_->registerDocumentation(filename);
+
+  QStringList tmp = helpEngine_->registeredDocumentations ();
+
+//#ifdef DEBUG
+  for ( int i = 0 ; i < tmp.size(); ++i) {
+    std::cerr << "=========================================================================================" << std::endl;
+    std::cerr << "Registered namespace: " << tmp[i].toStdString() << std::endl;
+    std::cerr << "From file : " << helpEngine_->documentationFileName(tmp[i]).toStdString() << std::endl;
+
+
+    QList<QStringList> filterAttribs = helpEngine_->filterAttributeSets (tmp[i]);
+//    std::cerr << "Filter attributes:" << std::endl;
+//    for ( int j = 0 ; j < filterAttribs.size(); ++j) {
+//      for ( int k = 0 ; k < filterAttribs[j].size(); ++k) {
+//        std::cerr <<  filterAttribs[j][k].toStdString() << std::endl;
+//      }
+//    }
+
+    // Print a list of all files included in this help file
+    if ( !filterAttribs.empty() ) {
+      QList<QUrl> list = helpEngine_->files ( tmp[i], filterAttribs[0]);
+      for ( int j = 0 ; j < list.size(); ++j) {
+        std::cerr << list[j].toString().toStdString() << std::endl;
+      }
+    } else {
+      std::cerr << "Error, empty filter! Unable to get list of included files." << std::endl;
+    }
+
+
+  }
+//#endif
 
   // Load main page
   textWindow_->open(QUrl(homeSite_));

Plugin-Color/userDoc/doxy.config.in

@@ -971,13 +971,13 @@ QCH_FILE               = @plugin_qt_help_dir@/Plugin-@plugin@.qch
 # Qt Help Project output. For more information please see
 # http://doc.trolltech.com/qthelpproject.html#namespace
 
-QHP_NAMESPACE          = "org.openflipper.user.plugin_@plugin@"
+QHP_NAMESPACE          = "org.openflipper.user.@plugin@"
 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
 # Qt Help Project output. For more information please see
 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
 
-QHP_VIRTUAL_FOLDER     = "doc"
+QHP_VIRTUAL_FOLDER     = "Plugin-@plugin@"
 
 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
 # For more information please see
@@ -1339,7 +1339,7 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by
 # the preprocessor.
 
-INCLUDE_PATH           = @CMAKE_SOURCE_DIR@
+INCLUDE_PATH           = 
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the

Plugin-Color/userDoc/mainpage.userdoc

-/** \mainpage Documentation for plugin Color
+/** \mainpage Plugin-Color-Doc Documentation for plugin Color
 
 \section Functionality