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

Remove project format spec docs (#2305)

Browse Source
This commit is contained in:
Veronica Berglyd Olsen
2025-04-20 13:40:16 +02:00
committed by GitHub
parent d0ee4cfbeb 17b3793b3b
commit f64c3bfeb2
5 changed files with 3 additions and 2362 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/FileFormatSpec-1.5.fodt
-2339
View File
File diff suppressed because it is too large Load Diff
docs/source/fileformatspec15.pdf
BIN
View File
Binary file not shown.
docs/source/index.rst
+1
View File
@@ -41,6 +41,7 @@ See :ref:`a_started` for more details.
:hidden: :hidden:
Main Page <self> Main Page <self>
More Documents <https://novelwriter.io/about/docs.html>
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
docs/source/more_projectformat.rst
+1 -13
View File
@@ -14,9 +14,7 @@ changes require minor actions from the user.
The key changes in the formats are listed in this chapter, as well as the user actions required, The key changes in the formats are listed in this chapter, as well as the user actions required,
where applicable. where applicable.
.. only:: not html A full project file format specification is available under "More Documents".
A full project file format specification is available in the online documentation_.
.. caution:: .. caution::
When you update a project from one format version to the next, the project can no longer be When you update a project from one format version to the next, the project can no longer be
@@ -24,16 +22,6 @@ where applicable.
introduced. You will get a notification about any updates to your project file format and will introduced. You will get a notification about any updates to your project file format and will
have the option to decline the upgrade. have the option to decline the upgrade.
.. only:: html
**For Developers**
A full description of the current file format is available in the
:download:`File Format Spec 1.5 <fileformatspec15.pdf>`
document, available as a PDF. This document is intended for contributors to novelWriter, those
building project conversion tools, either to or from the novelWriter format, and for those who
wish to make their own templating system.
.. _a_prjfmt_1_5: .. _a_prjfmt_1_5:
docs/source/tech_storage.rst
+1 -10
View File
@@ -4,8 +4,6 @@
How Data is Stored How Data is Stored
****************** ******************
.. _documentation: https://docs.novelwriter.io/
This chapter contains details of how novelWriter stores and handles the project data. This chapter contains details of how novelWriter stores and handles the project data.
@@ -36,14 +34,7 @@ The project XML file is indent-formatted, and is suitable for diff tools and ver
most of the file will stay static, although a timestamp is set in the meta section on line 2, and most of the file will stay static, although a timestamp is set in the meta section on line 2, and
various meta data entries incremented, on each save. various meta data entries incremented, on each save.
.. only:: not html A full project file format specification is available under "More Documents".
A full project file format specification is available in the online documentation_.
.. only:: html
A full description of the current file format is available in the
:download:`File Format Spec 1.5 <fileformatspec15.pdf>` document, available as a PDF.
Project Documents Project Documents