Skip to content

Commit

Permalink
Added requirements.
Browse files Browse the repository at this point in the history
  • Loading branch information
peter88213 committed Dec 16, 2024
1 parent 6381832 commit 7ef5849
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/requirements/requirements_overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
=====================
requirements overview
=====================

Vision
------

*novelibre* helps novelists to plan extensive novels and to keep track of them
during creation and revision.

Theme
-----

*novelibre* is an add-on to OpenOffice or LibreOffice that helps to break down
large novels into parts, chapters and sections, all of which are provided with
additional information called metadata.
The metadata remain permanently associated with the chapters and sections
in the ODT manuscript throughout the work on the novel.
*novelibre* makes information about the story world accessible and and relates
characters, locations, and items to the sections.
*novelibre* can hold information about plot lines and plot points that are
assigned to the sections.

Features
--------

Application
~~~~~~~~~~~

- *novelibre* works off-line.
- *novelibre* provides a graphical user interface.
- *novelibre* can launch OpenOffice or LibreOffice, which must be set as the
default applications for the ODT and ODS file format.
- *novelibre* can launch the system web browser to display HTML reports.
- *novelibre* can launch the system web browser to open the online user manual.

Project storage
~~~~~~~~~~~~~~~

- *novelibre* stores its data off-line in the local file system.
- *novelibre* stores its data in an XML-based file format.
- *novelibre* backs up the previous project version when saving the project.


Story structure
~~~~~~~~~~~~~~~

- *novelibre* shows the story structure in an editable project tree.
- Optionally, *novelibre* can import a story structure from an Office document.
- Optionally, the user can add chapters and sections while editing the manuscript.


Office dokuments to work on
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- *novelibre* exports ODF documents that can be reimported to update the project.


Final manuscript
~~~~~~~~~~~~~~~~

- *novelibre* exports a neatly formatted ODT manuscript to which different templates
can easily be applied.


25 changes: 25 additions & 0 deletions docs/requirements/user_stories.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
============
User stories
============

Application
-----------

- Launch the application.
- Exit the application.


Project storage
---------------

- Open an existing project in order to work on.
- Save the current project in order to apply changes.
- Close the application in order to finish the session.
- Close the project without saving in order to discard changes.
- Restore the last saved version in order to undo unsaved changes.
- Restore the latest backup version, if any, in order to undo saved changes.
- Save the current project under another file name in order to create a copy.
- Open the directory that contains the current project in order
to have direct acccess to the project documents.
- Add a style sheet to the project file in order to view the project
with a web browser.

0 comments on commit 7ef5849

Please # to comment.