Merge pull request #288 from vkbo/project_options

Project XML Modifications

nw/core/project.py

@@ -331,6 +331,8 @@ class NWProject():
             hexVersion = xRoot.attrib["hexVersion"]
         if "fileVersion" in xRoot.attrib:
             fileVersion = xRoot.attrib["fileVersion"]
+
+        # The following are deprecated and will be removed
         if "saveCount" in xRoot.attrib:
             self.saveCount = checkInt(xRoot.attrib["saveCount"], 0, False)
         if "autoCount" in xRoot.attrib:
@@ -409,6 +411,14 @@ class NWProject():
                     elif xItem.tag == "author":
                         logger.verbose("Author: '%s'" % xItem.text)
                         self.bookAuthors.append(xItem.text)
+                    elif xItem.tag == "saveCount":
+                        self.saveCount = checkInt(xItem.text, 0)
+                    elif xItem.tag == "autoCount":
+                        self.autoCount = checkInt(xItem.text, 0)
+                    elif xItem.tag == "editTime":
+                        self.editTime = checkInt(xItem.text, 0)
+
+                    # The following is deprecated, and will be removed
                     elif xItem.tag == "backup":
                         self.doBackup = checkBool(xItem.text, False)
 
@@ -417,7 +427,9 @@ class NWProject():
                 for xItem in xChild:
                     if xItem.text is None:
                         continue
-                    if xItem.tag == "spellCheck":
+                    if xItem.tag == "doBackup":
+                        self.doBackup = checkBool(xItem.text, False)
+                    elif xItem.tag == "spellCheck":
                         self.spellCheck = checkBool(xItem.text, False)
                     elif xItem.tag == "autoOutline":
                         self.autoOutline = checkBool(xItem.text, True)
@@ -489,21 +501,23 @@ class NWProject():
             "appVersion"  : str(nw.__version__),
             "hexVersion"  : str(nw.__hexversion__),
             "fileVersion" : "1.1",
-            "saveCount"   : str(self.saveCount),
-            "autoCount"   : str(self.autoCount),
             "timeStamp"   : formatTimeStamp(saveTime),
-            "editTime"    : str(int(self.editTime + saveTime - self.projOpened)),
         })
 
+        editTime = int(self.editTime + saveTime - self.projOpened)
+
         # Save Project Meta
         xProject = etree.SubElement(nwXML, "project")
         self._packProjectValue(xProject, "name", self.projName,  True)
         self._packProjectValue(xProject, "title", self.bookTitle, True)
         self._packProjectValue(xProject, "author", self.bookAuthors)
-        self._packProjectValue(xProject, "backup", self.doBackup)
+        self._packProjectValue(xProject, "saveCount", str(self.saveCount))
+        self._packProjectValue(xProject, "autoCount", str(self.autoCount))
+        self._packProjectValue(xProject, "editTime", str(editTime))
 
         # Save Project Settings
         xSettings = etree.SubElement(nwXML, "settings")
+        self._packProjectValue(xSettings, "doBackup", self.doBackup)
         self._packProjectValue(xSettings, "spellCheck", self.spellCheck)
         self._packProjectValue(xSettings, "autoOutline", self.autoOutline)
         self._packProjectValue(xSettings, "lastEdited", self.lastEdited)

sample/nwProject.nwx

@@ -1,13 +1,16 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" saveCount="270" autoCount="40" timeStamp="2020-06-04 19:14:21" editTime="4118">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 20:53:20">
   <project>
     <name>Sample Project</name>
     <title>Sample Project</title>
     <author>Jane Smith</author>
     <author>Jay Doh</author>
-    <backup>False</backup>
+    <saveCount>273</saveCount>
+    <autoCount>40</autoCount>
+    <editTime>4125</editTime>
   </project>
   <settings>
+    <doBackup>False</doBackup>
     <spellCheck>True</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>636b6aa9b697b</lastEdited>
@@ -24,9 +27,6 @@
       <unnumbered>%title%</unnumbered>
       <scene>Scene %ch%.%sc%: %title%</scene>
       <section></section>
-      <withSynopsis>True</withSynopsis>
-      <withComments>True</withComments>
-      <withKeywords>False</withKeywords>
     </titleFormat>
     <status>
       <entry blue="100" green="100" red="100">New</entry>

tests/reference/gui/0_nwProject.nwx

@@ -1,11 +1,14 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="2" autoCount="0" timeStamp="2020-05-29 23:05:28">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 21:05:07">
   <project>
     <name>New Project</name>
     <title></title>
-    <backup>True</backup>
+    <saveCount>2</saveCount>
+    <autoCount>1</autoCount>
+    <editTime>0</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>False</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>None</lastEdited>

tests/reference/gui/1_nwProject.nwx

@@ -1,11 +1,14 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="4" autoCount="1" timeStamp="2020-05-30 15:31:30" editTime="12">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 21:06:00">
   <project>
     <name>New Project</name>
     <title></title>
-    <backup>True</backup>
+    <saveCount>5</saveCount>
+    <autoCount>1</autoCount>
+    <editTime>11</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>True</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>31489056e0916</lastEdited>

tests/reference/gui/2_nwProject.nwx

@@ -1,13 +1,16 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="2" autoCount="0" timeStamp="2020-05-29 23:07:05">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 21:07:03">
   <project>
     <name>Project Name</name>
     <title>Project Title</title>
     <author>Jane Doe</author>
     <author>John Doh</author>
-    <backup>True</backup>
+    <saveCount>2</saveCount>
+    <autoCount>1</autoCount>
+    <editTime>1</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>False</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>None</lastEdited>

tests/reference/gui/3_nwProject.nwx

@@ -1,11 +1,14 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="2" autoCount="0" timeStamp="2020-05-29 23:07:37">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 21:07:51">
   <project>
     <name>New Project</name>
     <title></title>
-    <backup>True</backup>
+    <saveCount>2</saveCount>
+    <autoCount>1</autoCount>
+    <editTime>0</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>False</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>None</lastEdited>

tests/reference/proj/1_nwProject.nwx

@@ -1,11 +1,14 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="1" autoCount="0" timeStamp="2020-05-29 23:03:58">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 20:58:52">
   <project>
     <name>New Project</name>
     <title></title>
-    <backup>True</backup>
+    <saveCount>1</saveCount>
+    <autoCount>0</autoCount>
+    <editTime>0</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>False</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>None</lastEdited>

tests/reference/proj/2_nwProject.nwx

@@ -1,11 +1,14 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="4" autoCount="0" timeStamp="2020-05-29 23:04:31">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 21:03:18">
   <project>
     <name>New Project</name>
     <title></title>
-    <backup>True</backup>
+    <saveCount>4</saveCount>
+    <autoCount>0</autoCount>
+    <editTime>0</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>False</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>None</lastEdited>

tests/reference/proj/3_nwProject.nwx

@@ -1,11 +1,14 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="0.7.0rc1" hexVersion="0x000700c1" fileVersion="1.1" saveCount="5" autoCount="0" timeStamp="2020-05-29 23:04:50">
+<novelWriterXML appVersion="0.8.0rc1" hexVersion="0x000800c1" fileVersion="1.1" timeStamp="2020-06-05 21:04:10">
   <project>
     <name>New Project</name>
     <title></title>
-    <backup>True</backup>
+    <saveCount>5</saveCount>
+    <autoCount>0</autoCount>
+    <editTime>0</editTime>
   </project>
   <settings>
+    <doBackup>True</doBackup>
     <spellCheck>False</spellCheck>
     <autoOutline>True</autoOutline>
     <lastEdited>None</lastEdited>

tests/test_gui.py

@@ -45,7 +45,7 @@ def testMainWindows(qtbot, nwTempGUI, nwRef, nwTemp):
 
     # Check the files
     projFile = path.join(nwTempGUI,"nwProject.nwx")
-    assert cmpFiles(projFile, path.join(nwRef,"gui","0_nwProject.nwx"), [2])
+    assert cmpFiles(projFile, path.join(nwRef,"gui","0_nwProject.nwx"), [2, 6, 7, 8])
     qtbot.wait(stepDelay)
 
     # qtbot.stopForInteraction()
@@ -246,7 +246,7 @@ def testMainWindows(qtbot, nwTempGUI, nwRef, nwTemp):
 
     # Check the files
     refFile = path.join(nwTempGUI, "nwProject.nwx")
-    assert cmpFiles(refFile, path.join(nwRef, "gui", "1_nwProject.nwx"), [2])
+    assert cmpFiles(refFile, path.join(nwRef, "gui", "1_nwProject.nwx"), [2, 6, 7, 8])
     refFile = path.join(nwTempGUI, "content", "0e17daca5f3e1.nwd")
     assert cmpFiles(refFile, path.join(nwRef, "gui", "1_0e17daca5f3e1.nwd"))
     refFile = path.join(nwTempGUI, "content", "98010bd9270f9.nwd")
@@ -342,7 +342,7 @@ def testProjectEditor(qtbot, nwTempGUI, nwRef, nwTemp):
 
     # Check the files
     projFile = path.join(nwTempGUI,"nwProject.nwx")
-    assert cmpFiles(projFile, path.join(nwRef, "gui", "2_nwProject.nwx"), [2])
+    assert cmpFiles(projFile, path.join(nwRef, "gui", "2_nwProject.nwx"), [2, 8, 9, 10])
 
     nwGUI.closeMain()
     # qtbot.stopForInteraction()
@@ -391,7 +391,7 @@ def testItemEditor(qtbot, nwTempGUI, nwRef, nwTemp):
 
     # Check the files
     projFile = path.join(nwTempGUI,"nwProject.nwx")
-    assert cmpFiles(projFile, path.join(nwRef, "gui", "3_nwProject.nwx"), [2])
+    assert cmpFiles(projFile, path.join(nwRef, "gui", "3_nwProject.nwx"), [2, 6, 7, 8])
 
     nwGUI.closeMain()
     # qtbot.stopForInteraction()

tests/test_project.py

@@ -30,7 +30,7 @@ def testProjectNew(nwTempProj,nwRef,nwTemp):
     assert theProject.setProjectPath(nwTempProj)
     assert theProject.saveProject()
     assert theProject.closeProject()
-    assert cmpFiles(projFile, refFile, [2])
+    assert cmpFiles(projFile, refFile, [2, 6, 7, 8])
 
 @pytest.mark.project
 def testProjectOpen(nwTempProj):
@@ -43,7 +43,7 @@ def testProjectSave(nwTempProj,nwRef):
     refFile  = path.join(nwRef,"proj","1_nwProject.nwx")
     assert theProject.saveProject()
     assert theProject.closeProject()
-    assert cmpFiles(projFile, refFile, [2])
+    assert cmpFiles(projFile, refFile, [2, 6, 7, 8])
     assert not theProject.projChanged
 
 @pytest.mark.project
@@ -55,7 +55,7 @@ def testProjectOpenTwice(nwTempProj,nwRef):
     assert theProject.openProject(projFile, overrideLock=True)
     assert theProject.saveProject()
     assert theProject.closeProject()
-    assert cmpFiles(projFile, refFile, [2])
+    assert cmpFiles(projFile, refFile, [2, 6, 7, 8])
 
 @pytest.mark.project
 def testProjectNewRoot(nwTempProj,nwRef):
@@ -73,7 +73,7 @@ def testProjectNewRoot(nwTempProj,nwRef):
     assert theProject.projChanged
     assert theProject.saveProject()
     assert theProject.closeProject()
-    assert cmpFiles(projFile, refFile, [2])
+    assert cmpFiles(projFile, refFile, [2, 6, 7, 8])
     assert not theProject.projChanged
 
 @pytest.mark.project
@@ -86,7 +86,7 @@ def testProjectNewFile(nwTempProj,nwRef):
     assert theProject.projChanged
     assert theProject.saveProject()
     assert theProject.closeProject()
-    assert cmpFiles(projFile, refFile, [2])
+    assert cmpFiles(projFile, refFile, [2, 6, 7, 8])
     assert not theProject.projChanged
 
 @pytest.mark.project