novelyst

NOTE: This application will not be continued. It is replaced by novelibre.

novelyst is an organizer tool for writing novels with LibreOffice or OpenOffice Writer. It is written in Python and should run on several operating systems.

For more information, see the project homepage with description and download instructions.

Feedback? Ideas? Feature requests?

You can go to the "discussions" forum and start a thread.

Contributing

How to provide translations

First, you need to know your language code according to ISO 639-1.

For English, this is, for example, en, for German, it is de.

NOTE: The procedure described below is greatly simplified if you create a language pack based on the novelyst_xx template and use the tools provided for this purpose.

Create a message catalog

A "message catalog" is a dictionary for novelyst's messages and menu entries.

For creating a message catalog, you download a template with all English messages from here.

Rename messages.pot to <your language code>.po, then give some specific information in the header data by modifying the following lines:

"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: LANGUAGE\n"

NOTE: Be sure to use a text editor that writes utf-8 encoded text. Otherwise, it may not work with non-ASCII characters used in your language.

The <your language code>.po dictionary is organized as a set of message ID (msgid) - message string (msgstr) pairs, where msgid means the English term, and msgstr means the translated term. This is an example for such a pair where the message string is still missing:

msgid "Cannot overwrite file"
msgstr ""

Now you enter all missing message strings.

If a message ID contains placeholders like {}, be sure to put them also into the message string.
If a message ID starts with !, the message string must also start with !.

Before you distribute your translations, you can convert and install the message catalog for testing.

Convert the message catalog to binary format

The application needs the message catalog in binary format. This is easily achieved using the msgfmt.py converter script. You find it in your Python installation, in the Tools/i18n subdirectory. If not, you can download the code from here

Name the binary file pywriter.mo.

Install your translation for testing

Add a subdirectory tree to novelyst/locale, and place pywriter.mo there, like this:

<your home directory>
└── .pywriter/
    └── novelyst/
        └── locale/
            └─ <language code>/
               └─ LC_MESSAGES/
                  └─ pywriter.mo

Then start novelyst and see whether your translation works.

NOTE: At startup, novelyst tries to load a message dictionary that fits to the system language. If it doesn't find a matching language code in the locale directory, it uses English as default language.

HINT: novelyst comes with German translations. Look at the de directory tree, if you need an example.

Contribute your translations

If novelyst works fine with your translations, you can consider contributing it.

An easy way may be to put a posting in the novelyst forum, appending your <your language code>.po file.

Development

novelyst depends on the pywriter library which must be present in your file system. It is organized as an Eclipse PyDev project. The official release branch on GitHub is main.

Mandatory directory structure for building the application

.
├── PyWriter/
│   └── src/
│       ├── pywriter/
│       ├── inliner.py
│       ├── pgettext.py
│       ├── translations.py
│       └── msgfmt.py
└── novelyst/
    ├── src/
    ├── test/
    └── tools/ 
        ├── build.xml
        ├── build_novelyst.py
        ├── make_pot.py
        └── translate_de.py

Conventions

See https://github.com/peter88213/PyWriter/blob/main/docs/conventions.md

Development tools

Python version 3.10.
Eclipse IDE with PyDev and EGit.
Apache Ant is used for building the application.

Documentation tools

Gaphor for creating UML diagrams

Plugin development

If you want to develop a novelyst plugin, you may want to start with a repository on GitHub using novelyst_plugin as a template repository. After setting up your new repository named e.g. novelyst_yourPluginName, just do a global search, and replace novelyst_plugin with novelyst_yourPluginName.

Credits

The icons are made using the free Pusab font by Ryoichi Tsunekawa, Flat-it.

License

This is Open Source software, and novelyst is licensed under GPLv3. See the GNU General Public License website for more details, or consult the LICENSE file.

The modules in the widgets package are licenced under the MIT License.

peter88213 / novelyst

readme