https://github.com/peter88213/novelyst_editor
novelyst multi-scene editor plugin
https://github.com/peter88213/novelyst_editor
Last synced: 8 days ago
JSON representation
novelyst multi-scene editor plugin
- Host: GitHub
- URL: https://github.com/peter88213/novelyst_editor
- Owner: peter88213
- License: gpl-3.0
- Created: 2022-05-25T21:55:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T18:11:13.000Z (over 1 year ago)
- Last Synced: 2024-01-09T15:12:52.059Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 1.41 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# novelyst_editor
A simple [novelyst](https://peter88213.github.io/novelyst/) multi-scene editor plugin based on the *tkinter.Text* widget.
Edit multiple scenes, if the project is not locked.
For more information, see the [project homepage](https://peter88213.github.io/novelyst_editor) with description and download instructions.
## Feedback? Ideas? Feature requests?
You can go to the [novelyst "discussions" forum](https://github.com/peter88213/novelyst/discussions) 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](https://github.com/peter88213/novelyst_xx) template and use the tools provided for this purpose.
### Create a message catalog
A "message catalog" is a dictionary for the plugin's messages and menu entries.
For creating a message catalog, you download a template with all English messages from [here](https://github.com/peter88213/novelyst_editor/blob/main/i18n/messages.pot).
Rename `messages.pot` to `.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 \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 `.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 plugin 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](https://github.com/python/cpython/blob/main/Tools/i18n/msgfmt.py)
Name the binary file **novelyst_editor.mo**.
### Install your translation for testing
Add a subdirectory tree to **novelyst/locale**, and place *novelyst_editor.mo* there, like this:
```
└── .pywriter/
└── novelyst/
└── locale/
└─ /
└─ LC_MESSAGES/
└─ novelyst_editor.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_editor* 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](https://github.com/peter88213/novelyst/discussions), appending your `.po` file.
## Development
- The plugin uses the [tkinter text widget](https://tkdocs.com/tutorial/text.html).
- To enhance the editor's capabilities, modify the **TextBox** class.
- An example for an enhanced text box can be found in the [novelyst_rich_editor](https://github.com/peter88213/novelyst_rich_editor) plugin.
### Conventions
See https://github.com/peter88213/PyWriter/blob/main/docs/conventions.md
## Development tools
- [Python](https://python.org) version 3.10.
- [Eclipse IDE](https://eclipse.org) with [PyDev](https://pydev.org) and *EGit*.
- *Apache Ant* is used for building the application.
## Credits
- The icons are made using the free *Pusab* font by Ryoichi Tsunekawa, [Flat-it](http://flat-it.com/).
## License
This is Open Source software, and the *novelyst_editor* plugin is licensed under GPLv3. See the
[GNU General Public License website](https://www.gnu.org/licenses/gpl-3.0.en.html) for more
details, or consult the [LICENSE](https://github.com/peter88213/novelyst_editor/blob/main/LICENSE) file.