Skip to content

Commit ecff40d

Browse files
authored
Add file format specification (#1249)
2 parents 18c3e98 + d13e253 commit ecff40d

File tree

6 files changed

+2115
-2
lines changed

6 files changed

+2115
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ i18n/*.qph
2222
/novelwriter/assets/manual.pdf
2323
*.qch
2424
*.qhc
25+
.~lock.*
2526

2627
# Python Temp
2728
__pycache__

docs/FileFormatSpec-1.5.fodt

Lines changed: 2096 additions & 0 deletions
Large diffs are not rendered by default.
295 KB
Binary file not shown.
-32.3 KB
Binary file not shown.
-23 KB
Binary file not shown.

docs/source/usage_projectformat.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,43 @@
44
Project Format Changes
55
**********************
66

7+
.. _File Format Spec 1.5: _static/fileformatspec15.pdf
8+
.. _documentation: https://novelwriter.readthedocs.io
9+
710
Most of the changes to the file formats over the history of novelWriter have no impact on the
811
user-side of things. The project files are generally updated automatically. However, some of the
912
changes require minor actions from the user.
1013

11-
The key changes in the formats are listed below, as well as the user actions required where
14+
The key changes in the formats are listed below, as well as the user actions required, where
1215
applicable.
1316

17+
.. only:: not html
18+
19+
A full project file format specification is available in the online documentation_.
20+
1421
.. caution::
1522

1623
When you update a project from one format version to the next, the project can no longer be
1724
opened by a version of novelWriter prior to the version where the new file format was
1825
introduced. You will get a notification about any updates to your project file format and will
1926
have the option to decline the upgrade.
2027

28+
.. only:: html
29+
30+
**For Developers**
31+
32+
A full description of the current file format is available in the `File Format Spec 1.5`_
33+
document, available as a PDF. This document is intended for contributors to novelWriter, those
34+
building project conversion tools, either to or from tne novelWriter format, and for those who
35+
wish to make their own templating system.
36+
2137

2238
.. _a_prjfmt_1_5:
2339

2440
Format 1.5 Changes
2541
==================
2642

27-
This project format was introduced in novelWriter version 2.0.
43+
This project format was introduced in novelWriter version 2.0 RC 2.
2844

2945
This is a modification of the 1.4 format. It makes the XML more consistent in that meta data have
3046
been moved to the section nodes, and key/value settings now have a consistent format. Logical flags

0 commit comments

Comments
 (0)