Added the code needed for opening documentation in the viewer

2019-06-09 10:35:12 +02:00
parent c8888e7536
commit b3df4ee0f2
4 changed files with 33 additions and 1 deletions
@@ -0,0 +1,8 @@
+<html>
+<head>
+    <title>novelWriter Help</title>
+</head>
+<body>
+    <h1>novelWriter Help</h1>
+</body>
+</html>
@@ -104,6 +104,7 @@ class Config:
        self.homePath  = path.expanduser("~")
        self.appPath   = path.dirname(__file__)
        self.appRoot   = path.join(self.appPath,path.pardir)
+        self.helpPath  = path.join(self.appRoot,"help","en_GB")
        self.guiPath   = path.join(self.appPath,"gui")
        self.themePath = path.join(self.appPath,"themes")

@@ -13,7 +13,7 @@
 import logging
 import nw

-from PyQt5.QtCore    import Qt
+from PyQt5.QtCore    import Qt, QUrl
 from PyQt5.QtWidgets import QTextBrowser
 from PyQt5.QtGui     import QTextOption

@@ -59,6 +59,7 @@ class GuiDocViewer(QTextBrowser):

    def clearViewer(self):
        self.clear()
+        self.setSearchPaths([""])
        return True

    def initEditor(self):
@@ -74,6 +75,10 @@ class GuiDocViewer(QTextBrowser):

    def loadText(self, tHandle):

+        if tHandle == "Help":
+            self.loadHelp()
+            return True
+
        tItem = self.theProject.getItem(tHandle)
        if tItem is None:
            logger.warning("Item not found")
@@ -94,4 +99,12 @@ class GuiDocViewer(QTextBrowser):

        return True

+    def loadHelp(self):
+
+        self.clearViewer()
+        self.setSearchPaths([self.mainConf.helpPath])
+        self.setSource(QUrl("index.html"))
+
+        return True
+
 # END Class GuiDocViewer
@@ -516,6 +516,16 @@ class GuiMainMenu(QMenuBar):
        menuItem.triggered.connect(self._showAboutQt)
        self.helpMenu.addAction(menuItem)

+        # Help > Separator
+        self.helpMenu.addSeparator()
+
+        # Document > Preview
+        menuItem = QAction(QIcon.fromTheme("text-html"), "Documentation", self)
+        menuItem.setStatusTip("View documentation")
+        menuItem.setShortcut("F1")
+        menuItem.triggered.connect(lambda : self.theParent.viewDocument("Help"))
+        self.helpMenu.addAction(menuItem)
+
        return

 # END Class GuiMainMenu