Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Project Tree (#847)

Browse Source 
* Rename index textCounts to fileMeta and add main header level
* Add new icons for document layouts
* Add function in NWItem to describe the item
* Use the icons and description in the project tree and details panel
* Remove flags column and add status column with optional full text
* Update handling and display of header level in editor
* Fix potential bug in project tree
* Update tests
This commit is contained in:
Veronica Berglyd Olsen
2021-08-15 17:55:57 +02:00
committed by GitHub
parent cf7cd5502c
commit 97aebc5b84
34 changed files with 833 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nw/core/index.py
+42 -30
View File
@@ -54,10 +54,10 @@ class NWIndex():
self.indexBroken = False
# Indices
self._tagIndex = {}
self._refIndex = {}
self._fileIndex = {}
self._textCounts = {}
self._tagIndex = {}
self._refIndex = {}
self._fileIndex = {}
self._fileMeta = {}
# TimeStamps
self._timeNovel = 0
@@ -73,13 +73,13 @@ class NWIndex():
def clearIndex(self):
"""Clear the index dictionaries and time stamps.
"""
self._tagIndex = {}
self._refIndex = {}
self._fileIndex = {}
self._textCounts = {}
self._timeNovel = 0
self._timeNotes = 0
self._timeIndex = 0
self._tagIndex = {}
self._refIndex = {}
self._fileIndex = {}
self._fileMeta = {}
self._timeNovel = 0
self._timeNotes = 0
self._timeIndex = 0
return
def deleteHandle(self, tHandle):
@@ -97,7 +97,7 @@ class NWIndex():
self._refIndex.pop(tHandle, None)
self._fileIndex.pop(tHandle, None)
self._textCounts.pop(tHandle, None)
self._fileMeta.pop(tHandle, None)
return
@@ -162,7 +162,7 @@ class NWIndex():
self._tagIndex = theData.get("tagIndex", {})
self._refIndex = theData.get("refIndex", {})
self._fileIndex = theData.get("fileIndex", {})
self._textCounts = theData.get("textCounts", {})
self._fileMeta = theData.get("fileMeta", {})
nowTime = round(time())
self._timeNovel = nowTime
@@ -189,7 +189,7 @@ class NWIndex():
outFile.write(f'"tagIndex": {jsonEncode(self._tagIndex, nmax=1)},\n')
outFile.write(f'"refIndex": {jsonEncode(self._refIndex, nmax=2)},\n')
outFile.write(f'"fileIndex": {jsonEncode(self._fileIndex, nmax=2)},\n')
outFile.write(f'"textCounts": {jsonEncode(self._textCounts, nmax=1)}\n')
outFile.write(f'"fileMeta": {jsonEncode(self._fileMeta, nmax=1)}\n')
outFile.write("}\n")
except Exception:
@@ -212,7 +212,7 @@ class NWIndex():
self._checkTagIndex()
self._checkRefIndex()
self._checkFileIndex()
self._checkTextCounts()
self._checkFileMeta()
self.indexBroken = False
except Exception:
@@ -256,7 +256,7 @@ class NWIndex():
# Run word counter for the whole text
cC, wC, pC = countWords(theText)
self._textCounts[tHandle] = [cC, wC, pC]
self._fileMeta[tHandle] = ["H0", cC, wC, pC]
# If the file is archived or trashed, we don't index the file itself
if self.theProject.projTree.isTrashRoot(theItem.itemParent):
@@ -374,6 +374,9 @@ class NWIndex():
"synopsis": "",
}
if self._fileMeta[tHandle][0] == "H0":
self._fileMeta[tHandle][0] = hDepth
return True
def _indexPage(self, tHandle, itemLayout):
@@ -573,6 +576,13 @@ class NWIndex():
return theHeaders
def getHandleHeaderLevel(self, tHandle):
"""Get the header level of the first header of a handle.
"""
if tHandle in self._fileMeta:
return self._fileMeta[tHandle][0]
return "H0"
def getTableOfContents(self, maxDepth, skipExcluded=True):
"""Generate a table of contents up to a maxiumum depth.
"""
@@ -617,10 +627,10 @@ class NWIndex():
pC = 0
if sTitle is None:
if tHandle in self._textCounts:
cC = self._textCounts[tHandle][0]
wC = self._textCounts[tHandle][1]
pC = self._textCounts[tHandle][2]
if tHandle in self._fileMeta:
cC = self._fileMeta[tHandle][1]
wC = self._fileMeta[tHandle][2]
pC = self._fileMeta[tHandle][3]
else:
if tHandle in self._fileIndex:
if sTitle in self._fileIndex[tHandle]:
@@ -809,23 +819,25 @@ class NWIndex():
return
def _checkTextCounts(self):
def _checkFileMeta(self):
"""Scan the text counts index for errors.
Warning: This function raises exceptions.
"""
for tHandle in self._textCounts:
for tHandle in self._fileMeta:
if not isHandle(tHandle):
raise KeyError("textCounts key is not a handle")
raise KeyError("fileMeta key is not a handle")
tEntry = self._textCounts[tHandle]
if len(tEntry) != 3:
raise IndexError("textCounts[a] expected 3 values")
if not isinstance(tEntry[0], int):
raise ValueError("textCounts[a][0] is not an integer")
tEntry = self._fileMeta[tHandle]
if len(tEntry) != 4:
raise IndexError("fileMeta[a] expected 4 values")
if not tEntry[0] in H_VALID:
raise ValueError("fileMeta[a][0] is not a header level")
if not isinstance(tEntry[1], int):
raise ValueError("textCounts[a][1] is not an integer")
raise ValueError("fileMeta[a][1] is not an integer")
if not isinstance(tEntry[2], int):
raise ValueError("textCounts[a][2] is not an integer")
raise ValueError("fileMeta[a][2] is not an integer")
if not isinstance(tEntry[3], int):
raise ValueError("fileMeta[a][3] is not an integer")
return
nw/core/item.py
+28 -1
View File
@@ -29,7 +29,7 @@ from lxml import etree
from nw.enum import nwItemType, nwItemClass, nwItemLayout
from nw.common import checkInt, isHandle, isItemClass, isItemLayout, isItemType
from nw.constants import nwLists
from nw.constants import nwLabels, nwLists, trConst
logger = logging.getLogger(__name__)
@@ -151,6 +151,33 @@ class NWItem():
return
##
# Methods
##
def describeMe(self, hLevel=None):
"""Return a string description of the item.
"""
descKey = "none"
if self.itemType == nwItemType.ROOT:
descKey = "root"
elif self.itemType == nwItemType.FOLDER:
descKey = "folder"
elif self.itemType == nwItemType.FILE:
if self.itemLayout == nwItemLayout.DOCUMENT:
if hLevel == "H1":
descKey = "doc_h1"
elif hLevel == "H2":
descKey = "doc_h2"
elif hLevel == "H3":
descKey = "doc_h3"
else:
descKey = "document"
elif self.itemLayout == nwItemLayout.NOTE:
descKey = "note"
return trConst(nwLabels.ITEM_DESCRIPTION.get(descKey, ""))
##
# Set Item Values
##