diff --git a/docs/FileFormatSpec-1.5.fodt b/docs/FileFormatSpec-1.5.fodt index 4e2d66ef..5721dff1 100644 --- a/docs/FileFormatSpec-1.5.fodt +++ b/docs/FileFormatSpec-1.5.fodt @@ -1,24 +1,24 @@ - Veronica Olsen2022-11-05T18:25:44.8874731592024-01-26T22:59:54.491819741Veronica OlsenPT4H2M7S55LibreOffice/7.4.7.2$Linux_X86_64 LibreOffice_project/40$Build-2 + Veronica Olsen2022-11-05T18:25:44.8874731592024-03-11T11:06:21.968626872PT4H19M4S57LibreOffice/7.4.7.2$Linux_X86_64 LibreOffice_project/40$Build-2 - 35971 + 141 0 - 26083 - 20394 + 27406 + 16198 true false view2 - 4692 - 47456 + 8186 + 12282 0 - 35971 - 26081 - 56363 + 141 + 27404 + 16337 0 1 false @@ -90,7 +90,7 @@ true true - 917862 + 928650 true false @@ -158,7 +158,7 @@ - + @@ -178,8 +178,8 @@ - - + + @@ -204,15 +204,15 @@ - + - + - + @@ -221,11 +221,11 @@ - + - + @@ -240,6 +240,10 @@ + + + + @@ -471,12 +475,17 @@ + + + + + - + - + @@ -1101,144 +1110,166 @@ + + + + - + - + - + - + - + - - - - + - + - + + + + - + - + - + - - - - + - + + + + - + - + - + - + - + - + - + - - - - + - + - + + + + - + - + + + + - - - - - - - + + + + + + + - - - - - - - - + + + + + + + + - + - - - - - - + + + + + + - - - + + + - + + + + + + + + + + + + + - + + + + @@ -1408,20 +1439,22 @@ - novelWriter + novelWriter Project File Format 1.5 Specification - - This document covers the file format specification for the 1.5 file format for novelWriter project files. See the documentation1 - See: https://docs.novelwriter.io for a full description of the app’s functionality. The file format was intrioduced in Release 2.0. - The target audience of this document is developers who intend to write a tool or script that generates valid novelWriter project files from data from other applications, or for templating purposes. - Note that flags are generally written out as yes/no values, but also true/false and on/off are understood by the application. The None value that occasionally occurs in actual project files is the text representation of the Python None value, and indicates that there is no value set. - Revisions + This document covers the file format specification for the 1.5 file format for novelWriter project files. See the documentation1 + See: https://docs.novelwriter.io for a full description of the app’s functionality. The file format was intrioduced in Release 2.0. + The target audience of this document is developers who intend to write a tool or script that generates valid novelWriter project files from data from other applications, or for templating purposes. + Note that flags are generally written out as yes/no values, but also true/false and on/off are understood by the application. The None value that occasionally occurs in actual project files is the text representation of the Python None value, and indicates that there is no value set. + Revisions - From Release 2.1 Beta 1: Removed the titleFormat node from settings. + From Release 2.1 Beta 1: Removed the titleFormat node from settings. - From Release 2.3 Beta 1: Removed the title node from project. + From Release 2.3 Beta 1: Removed the title node from project. + + + From Release 2.3: Added TEMPLATE item class. XML Root @@ -1445,7 +1478,7 @@ - appVersion + appVersion No @@ -1456,7 +1489,7 @@ - hexVersion + hexVersion No @@ -1467,7 +1500,7 @@ - fileVersion + fileVersion Yes @@ -1478,18 +1511,18 @@ - fileRevision + fileRevision - No + No - The revision of the file format used for non-breaking changes. This is an interger value. + The revision of the file format used for non-breaking changes. This is an interger value. - timeStamp + timeStamp No @@ -1501,8 +1534,8 @@ Example <novelWriterXML appVersion="2.0-rc1" hexVersion="0x020000c1" - fileVersion="1.5" fileRevision="1" - timeStamp="2022-11-05 17:46:51"> + fileVersion="1.5" fileRevision="1" + timeStamp="2022-11-05 17:46:51"> Project Node Tag: project The project section is a level one node under the root. It stores the primary settings for the project. The only required values are the id attribute and the name value. All other entries are set to default values during parsing if ommitted from the XML. @@ -1524,18 +1557,18 @@ - id + id - Yes + Yes - A UUID that is unique for the project and does not change during the lifetime of the project. It is used by novelWriter to keep track of temporary files and to associate cross-project settings with specific projects without relying on the project name. + A UUID that is unique for the project and does not change during the lifetime of the project. It is used by novelWriter to keep track of temporary files and to associate cross-project settings with specific projects without relying on the project name. - saveCount + saveCount No @@ -1546,7 +1579,7 @@ - autoCount + autoCount No @@ -1557,7 +1590,7 @@ - editTime + editTime No @@ -1585,23 +1618,34 @@ - name + name - Yes + Yes - The name the user has given to the project. + The name the user has given to the project. + + + + + title + + + No + + + Removed in Revision 2. - - author + + author - + No - + The name of the novel author or authors. The value is used in some places in the user interface, and can be added to manuscript builds. @@ -1612,7 +1656,7 @@ <name>Sample Project</name> <author>Jane Smith</author> </project> - + Settings Node Tag: settings The settings section is a level one node under the root. It stores the various runtime values for the project, and the settings available from the Project Settings panel. None of these settings are required, and if missing, will be set to default values. The entire settings section can thus be ommitted. @@ -1636,18 +1680,18 @@ - doBackup + doBackup - No + No - User-controlled setting for whether or not to run backup when the project is closed. + User-controlled setting for whether or not to run backup when the project is closed. - language + language No @@ -1658,7 +1702,7 @@ - spellChecking + spellChecking No @@ -1671,7 +1715,7 @@ - lastHandle + lastHandle No @@ -1682,7 +1726,7 @@ - autoReplace + autoReplace No @@ -1693,18 +1737,18 @@ - titleFormat + titleFormat No - Removed in Revision 1. + Removed in Revision 1. - status + status No @@ -1715,7 +1759,7 @@ - importance + importance No @@ -1726,16 +1770,16 @@ Example - <settings> - <doBackup>yes</doBackup> - <language>en_GB</language> - <spellChecking auto="yes">en_GB</spellChecking> - <lastHandle /> - <autoReplace /> - <status /> - <importance /> - </settings> - + <settings> + <doBackup>yes</doBackup> + <language>en_GB</language> + <spellChecking auto="yes">en_GB</spellChecking> + <lastHandle /> + <autoReplace /> + <status /> + <importance /> + </settings> + Key/Value Nodes The key/value nodes are used for lastHandle, autoReplace and titleFormat settings. The lookup key is stored as an attribute, and the value is the text of the node. Attributes @@ -1756,23 +1800,23 @@ - key + key - Yes + Yes - The lookup key. + The lookup key. Example - <lastHandle> - <entry key="editor">636b6aa9b697b</entry> - <entry key="viewer">636b6aa9b697b</entry> - <entry key="novelTree">7031beac91f75</entry> - <entry key="outline">7031beac91f75</entry> - </lastHandle> + <lastHandle> + <entry key="editor">636b6aa9b697b</entry> + <entry key="viewer">636b6aa9b697b</entry> + <entry key="novelTree">7031beac91f75</entry> + <entry key="outline">7031beac91f75</entry> + </lastHandle> Status/Importance Key/Value Nodes The status and importance settings are stored as key/value nodes with additional data attributes. The label of the status or importance setting is saved as the node text value. Attributes @@ -1793,18 +1837,18 @@ - key + key - Yes + Yes - The lookup key. For status labels, it must consist of an “s” followed by six hexadecimal numbers. For importance labels it must consist of an “i” followed by six hexadecimal numbers. Each key string must be unique. Internally, they are random numbers, but also sequential values are valid. + The lookup key. For status labels, it must consist of an “s” followed by six hexadecimal numbers. For importance labels it must consist of an “i” followed by six hexadecimal numbers. Each key string must be unique. Internally, they are random numbers, but also sequential values are valid. - count + count No @@ -1815,7 +1859,7 @@ - red + red Yes @@ -1826,7 +1870,7 @@ - green + green Yes @@ -1837,7 +1881,7 @@ - blue + blue Yes @@ -1848,23 +1892,22 @@ Example - <status> - <entry key="sf12341" count="4" - red="100" green="100" blue="100">New</entry> - <entry key="sd51c5b" count="0" - red="193" green="129" blue="0">Draft</entry> - <entry key="s78ea90" count="1" - red="58" green="180" blue="58">Finished</entry> - </status> - <importance> - <entry key="ia857f0" count="5" - red="100" green="100" blue="100">None</entry> - <entry key="icfb3a5" count="2" - red="0" green="122" blue="188">Minor</entry> - <entry key="i2d7a54" count="2" - red="21" green="0" blue="180">Major</entry> - </importance> - + <status> + <entry key="sf12341" count="4" + red="100" green="100" blue="100">New</entry> + <entry key="sd51c5b" count="0" + red="193" green="129" blue="0">Draft</entry> + <entry key="s78ea90" count="1" + red="58" green="180" blue="58">Finished</entry> + </status> + <importance> + <entry key="ia857f0" count="5" + red="100" green="100" blue="100">None</entry> + <entry key="icfb3a5" count="2" + red="0" green="122" blue="188">Minor</entry> + <entry key="i2d7a54" count="2" + red="21" green="0" blue="180">Major</entry> + </importance> Content Node Tag: content The content section is a level one node under the root. It stores all the project items of the project. The items are stored in the order in which they appear in the project tree, so altering the order will affect the project structure. The attribute with the order number is not used when processing the data. It is written to the XML for debugging purposes. @@ -1886,35 +1929,35 @@ - items + items No - The number of project items in the content section. + The number of project items in the content section. - novelWords + novelWords No - The number of words in total for all document nodes with layout DOCUMENT. The value defaults to 0, but this number forms the basis of computing writing statistics during a session, so the number should be properly set to ensure correct statistics. + The number of words in total for all document nodes with layout DOCUMENT. The value defaults to 0, but this number forms the basis of computing writing statistics during a session, so the number should be properly set to ensure correct statistics. - notesWords + notesWords No - The number of words in total for all document nodes with layout NOTE. The value defaults to 0, but this number forms the basis of computing writing statistics during a session, so the number should be properly set to ensure correct statistics. + The number of words in total for all document nodes with layout NOTE. The value defaults to 0, but this number forms the basis of computing writing statistics during a session, so the number should be properly set to ensure correct statistics. @@ -1936,32 +1979,32 @@ - item + item - No + No - A node representing a project item. + A node representing a project item. Example - <content items="27" novelWords="954" notesWords="409"> - <item handle="7031beac91f75" parent="None" root="7031beac91f75" - order="0" type="ROOT" class="NOVEL"> - <meta expanded="yes"/> - <name status="sc24b8f" import="ia857f0">Novel</name> - </item> - ... - </content> + <content items="27" novelWords="954" notesWords="409"> + <item handle="7031beac91f75" parent="None" root="7031beac91f75" + order="0" type="ROOT" class="NOVEL"> + <meta expanded="yes"/> + <name status="sc24b8f" import="ia857f0">Novel</name> + </item> + ... + </content> Item Nodes - The item nodes make up the actual project content of the project. Each node represents either a root folder, a regular folder, or a document. Each node has a type, class and layout setting that determine its category. Each item is given a handle that is a random hexadecimal string of length 13. - For the items that are document files, the handle corresponds to its expected filename. It is therefore important that they match in generated projects. Each document node is expected to correspond to a file in the contents folder of the project named “content/7031beac91f75.nwd” for the item handle “7031beac91f75”. If there is no such file, the document item is assumed to contain no text, and a file is created when the user tries to save text to it. - Each item node has a meta data node and a name node. The meta data node contains only collected information, and is thus not strictly required. However, an accurate word count and setting the correct icon in the project tree depend on these values. These values are set by the indexer class, so rebuilding the index should restore the data. - The name node contains the primary user defined settings for an item, and is required for the entry to be valid. - - Attributes + The item nodes make up the actual project content of the project. Each node represents either a root folder, a regular folder, or a document. Each node has a type, class and layout setting that determine its category. Each item is given a handle that is a random hexadecimal string of length 13. + For the items that are document files, the handle corresponds to its expected filename. It is therefore important that they match in generated projects. Each document node is expected to correspond to a file in the contents folder of the project named “content/7031beac91f75.nwd” for the item handle “7031beac91f75”. If there is no such file, the document item is assumed to contain no text, and a file is created when the user tries to save text to it. + Each item node has a meta data node and a name node. The meta data node contains only collected information, and is thus not strictly required. However, an accurate word count and setting the correct icon in the project tree depend on these values. These values are set by the indexer class, so rebuilding the index should restore the data. + The name nod + e contains the primary user defined settings for an item, and is required for the entry to be valid. + Attributes @@ -1979,79 +2022,81 @@ - handle + handle - Yes + Yes - The 13 value hexadecimal string that represents the item in the project. This is the primary identifier of a project item, and is required. It must be unique withing a project. Internally, it is generated as a random value, but it can also be sequential. + The 13 value hexadecimal string that represents the item in the project. This is the primary identifier of a project item, and is required. It must be unique withing a project. Internally, it is generated as a random value, but it can also be sequential. - parent + parent - Yes + Yes - The handle of the parent item in the tree. This value should only be None for root folders. All other items must have a parent handle set. If the parent handle is None for an item that isn’t a root folder, the item will be treated as orphaned during project loading. + The handle of the parent item in the tree. This value should only be None for root folders. All other items must have a parent handle set. If the parent handle is None for an item that isn’t a root folder, the item will be treated as orphaned during project loading. - root + root - No + No - The handle of the top of its hierarchy of parent items. That is, the root folder which it ultimately sits under. If the attribute is not set, it will be computed during loading. It is saved to the XML file for efficiency reasons. + The handle of the top of its hierarchy of parent items. That is, the root folder which it ultimately sits under. If the attribute is not set, it will be computed during loading. It is saved to the XML file for efficiency reasons. - order + order - No + No - The numerical order of the item under its parent item. This value is not used during the loading process as the physical item order in the content node is used instead. It is primarily saved to the XML for debugging purposes. + The numerical order of the item under its parent item. This value is not used during the loading process as the physical item order in the content node is used instead. It is primarily saved to the XML for debugging purposes. - type + type - Yes + Yes - The item type of the item node. Allowed values are ROOT, FOLDER and FILE. + The item type of the item node. Allowed values are ROOT, FOLDER and FILE. - class + class - Yes + Yes - The item class of the item node. There are a number of item classes available in the app, all corresponding to a specific type of root folder. Each item in a root folder should have the same class set as the root folder itself. The attribute is not strictly required for items that aren’t root folders as it will be automatically set to match during loading. Allowed values are NOVEL, PLOT, CHARACTER, WORLD, TIMELINE, OBJECT, ENTITY, CUSTOM, ARCHIVE and TRASH. + The item class of the item node. There are a number of item classes available in the app, all corresponding to a specific type of root folder. Each item in a root folder should have the same class set as the root folder itself. The attribute is not strictly required for items that aren’t root folders as it will be automatically set to match during loading. Allowed values are NOVEL, PLOT, CHARACTER, WORLD, TIMELINE, OBJECT, ENTITY, CUSTOM, ARCHIVE and TRASH. + + Added in Revision 3: TEMPLATE - layout + layout - Yes + Yes - The item layout of the item node. Allowed values are DOCUMENT and NOTE. This is the attribute that determines if a FILE type item is a Novel Document or a Project Note. + The item layout of the item node. Allowed values are DOCUMENT and NOTE. This is the attribute that determines if a FILE type item is a Novel Document or a Project Note. @@ -2073,29 +2118,29 @@ - meta + meta - No + No - A node of meta data attributes for the item. + A node of meta data attributes for the item. - name + name - Yes + Yes - A node of user settings for the item. + A node of user settings for the item. Meta Nodes - The meta data collected for the current item. This data either represents the item’s last state in the app, or consists of data collected by the indexer. It can be restored by rebuilding the index, so the data is not essential. + The meta data collected for the current item. This data either represents the item’s last state in the app, or consists of data collected by the indexer. It can be restored by rebuilding the index, so the data is not essential. Attributes @@ -2114,73 +2159,73 @@ - expanded + expanded - No + No - Whether the tree node in the project tree was expanded or collapsed during the last session. Applies to all item types, but is ignored for items without child items. + Whether the tree node in the project tree was expanded or collapsed during the last session. Applies to all item types, but is ignored for items without child items. - heading + heading - No + No - The heading level of the first heading of the text of the item. Only applies to FILE item types. Allowed values are H0, H1, H2, H3, and H4. Other values are reset to H0. + The heading level of the first heading of the text of the item. Only applies to FILE item types. Allowed values are H0, H1, H2, H3, and H4. Other values are reset to H0. - charCount + charCount - No + No - The number of characters in the text of the item. Only applies to FILE item types. + The number of characters in the text of the item. Only applies to FILE item types. - wordCount + wordCount - No + No - The number of words in the text of the item. Only applies to FILE item types. + The number of words in the text of the item. Only applies to FILE item types. - paraCount + paraCount - No + No - The number of paragraphs in the text of the item. Only applies to FILE item types. + The number of paragraphs in the text of the item. Only applies to FILE item types. - cursorPos + cursorPos - No + No - The last cursor position in the text of the item from the last editing session. Only applies to FILE item types. The value is used to restore the cursor position when the document is opened in the editor. + The last cursor position in the text of the item from the last editing session. Only applies to FILE item types. The value is used to restore the cursor position when the document is opened in the editor. - Name Nodes - The name node contains information about an item that is set by the user. Including its label, which is the text value of the node. This is the label that is displayed in the project tree. + Name Nodes + The name node contains information about an item that is set by the user. Including its label, which is the text value of the node. This is the label that is displayed in the project tree. Attributes @@ -2199,45 +2244,45 @@ - status + status - No + No - The ID of the status label that has been set for this item. Defaults to the first status item defined in the status section of the settings node. + The ID of the status label that has been set for this item. Defaults to the first status item defined in the status section of the settings node. - import + import - No + No - The ID of the importance label that has been set for this item. Defaults to the first importance item defined in the importance section of the settings node. + The ID of the importance label that has been set for this item. Defaults to the first importance item defined in the importance section of the settings node. - active + active - No + No - The active/inactive status of the document. Only applies to FILE item types. + The active/inactive status of the document. Only applies to FILE item types. Example - <item handle="53b69b83cdafc" parent="7031beac91f75" root="7031beac91f75" - order="0" type="FILE" class="NOVEL" layout="DOCUMENT"> - <meta expanded="no" heading="H1" charCount="93" wordCount="19" - paraCount="2" cursorPos="119"/> - <name status="sc24b8f" import="ia857f0" active="yes">Title Page</name> - </item> + <item handle="53b69b83cdafc" parent="7031beac91f75" root="7031beac91f75" + order="0" type="FILE" class="NOVEL" layout="DOCUMENT"> + <meta expanded="no" heading="H1" charCount="93" wordCount="19" + paraCount="2" cursorPos="119"/> + <name status="sc24b8f" import="ia857f0" active="yes">Title Page</name> + </item> \ No newline at end of file diff --git a/docs/source/fileformatspec15.pdf b/docs/source/fileformatspec15.pdf index 58b5be9d..0edf908e 100644 Binary files a/docs/source/fileformatspec15.pdf and b/docs/source/fileformatspec15.pdf differ diff --git a/novelwriter/core/projectxml.py b/novelwriter/core/projectxml.py index 029a9f6c..c99c8abf 100644 --- a/novelwriter/core/projectxml.py +++ b/novelwriter/core/projectxml.py @@ -46,7 +46,7 @@ if TYPE_CHECKING: # pragma: no cover logger = logging.getLogger(__name__) FILE_VERSION = "1.5" # The current project file format version -FILE_REVISION = "2" # The current project file format revision +FILE_REVISION = "3" # The current project file format revision HEX_VERSION = 0x0105 NUM_VERSION = { @@ -108,6 +108,7 @@ class ProjectXMLReader: Rev 1: Drops the titleFormat node from settings. 2.1 Beta 1. Rev 2: Drops the title node from project and adds the TEMPLATE class for items. 2.3 Beta 1. + Rev 3: Added TEMPLATE class. 2.3. """ def __init__(self, path: str | Path) -> None: diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx index d17412a9..b3ec17a3 100644 --- a/sample/nwProject.nwx +++ b/sample/nwProject.nwx @@ -1,6 +1,6 @@ - - + + Sample Project Jane Smith diff --git a/tests/files/nwProject-1.5.nwx b/tests/files/nwProject-1.5.nwx index cc17f909..7823c057 100644 --- a/tests/files/nwProject-1.5.nwx +++ b/tests/files/nwProject-1.5.nwx @@ -1,5 +1,5 @@ - + Sample Project Jane Smith diff --git a/tests/reference/projectXML_ReadLegacy10.nwx b/tests/reference/projectXML_ReadLegacy10.nwx index 5161eb5b..a8f9e945 100644 --- a/tests/reference/projectXML_ReadLegacy10.nwx +++ b/tests/reference/projectXML_ReadLegacy10.nwx @@ -1,5 +1,5 @@ - + Sample Project Jay Doh diff --git a/tests/reference/projectXML_ReadLegacy11.nwx b/tests/reference/projectXML_ReadLegacy11.nwx index 7624a057..c216f88a 100644 --- a/tests/reference/projectXML_ReadLegacy11.nwx +++ b/tests/reference/projectXML_ReadLegacy11.nwx @@ -1,5 +1,5 @@ - + Sample Project Jay Doh diff --git a/tests/reference/projectXML_ReadLegacy12.nwx b/tests/reference/projectXML_ReadLegacy12.nwx index 58b29061..b3cad791 100644 --- a/tests/reference/projectXML_ReadLegacy12.nwx +++ b/tests/reference/projectXML_ReadLegacy12.nwx @@ -1,5 +1,5 @@ - + Sample Project Jay Doh diff --git a/tests/reference/projectXML_ReadLegacy13.nwx b/tests/reference/projectXML_ReadLegacy13.nwx index 28e24c69..4bd25a9a 100644 --- a/tests/reference/projectXML_ReadLegacy13.nwx +++ b/tests/reference/projectXML_ReadLegacy13.nwx @@ -1,5 +1,5 @@ - + Sample Project Jay Doh diff --git a/tests/reference/projectXML_ReadLegacy14.nwx b/tests/reference/projectXML_ReadLegacy14.nwx index 26e7413c..1ca92061 100644 --- a/tests/reference/projectXML_ReadLegacy14.nwx +++ b/tests/reference/projectXML_ReadLegacy14.nwx @@ -1,5 +1,5 @@ - + Sample Project Jay Doh diff --git a/tests/test_core/test_core_projectxml.py b/tests/test_core/test_core_projectxml.py index 554da1ef..534aaed2 100644 --- a/tests/test_core/test_core_projectxml.py +++ b/tests/test_core/test_core_projectxml.py @@ -131,7 +131,7 @@ def testCoreProjectXML_ReadCurrent(monkeypatch, tstPaths, fncPath): assert xmlReader.state == XMLReadState.PARSED_OK assert xmlReader.xmlRoot == "novelWriterXML" assert xmlReader.xmlVersion == 0x0105 - assert xmlReader.xmlRevision == 2 + assert xmlReader.xmlRevision == 3 assert xmlReader.appVersion == "2.0-rc1" assert xmlReader.hexVersion == 0x020000c1