https://github.com/peter88213/manuskript-exporter

A Python application for Manuskript data export from outsides.
https://github.com/peter88213/manuskript-exporter

Last synced: 8 days ago
JSON representation

A Python application for Manuskript data export from outsides.

• Host: GitHub
• URL: https://github.com/peter88213/manuskript-exporter
• Owner: peter88213
• License: mit
• Created: 2023-12-23T17:55:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-15T20:23:05.000Z (about 1 year ago)
• Last Synced: 2024-02-15T21:32:27.574Z (about 1 year ago)
• Language: Python
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# manuskript-exporter

A Python application for [Manuskript](https://www.theologeek.ch/manuskript/) data export from outsides.

![Screenshot](https://raw.githubusercontent.com/peter88213/manuskript-exporter/main/docs/screenshots/screenshot01.png)

## Features

- Creates a document containing the story world descriptions. 

  The heading levels reflect the hierarchy in *Manuskript*. 

- Creates a document containing the character data.

  The first level headings show the characters' names. 

  The character information is structured on the second level.

- Creates a document containing all chapters and scenes.

- Creates synopses on all levels (up to 6) of the Manuskript *Outline*:

    - Full chapter summaries in a document per chapter level.

    - Short chapter summaries in a document per chapter level.

    - Full scene summaries.

    - Short scene summaries.

    - Scene titles.

- You can select the output format (md, odt, docx, html). 

## Requirements

- A [Python](https://www.python.org/) installation (version 3.6 or newer).

- [mskmd.py](https://github.com/peter88213/manuskript_md) in the same directory as *manuskript-exporter.pyw*.

- A [pandoc](https://pandoc.org/) installation.

- [pypandoc](https://github.com/JessicaTegner/pypandoc) installed via *PyPi*.

### Note for Linux users

Please make sure that your Python3 installation has the *tkinter* module. 

On Ubuntu, for example, it is not available out of the box and must be installed via a 

separate package named **python3-tk**. 

## Download

Save the file [mskexporter.pyw](https://raw.githubusercontent.com/peter88213/manuskript-exporter/main/mskexporter/mskexporter.pyw).

## Usage

The file *mskmd.py* must be placed besides *manuskript-exporter.pyw*. 

1. Open your *Manuskript* project with **File > Open** or **Ctrl-O**. Select the *.msk* file.

2. Select the output document type.

3. Create the documents selecting the type with the **Convert** menu. 

## License

Published under the [MIT License](https://opensource.org/licenses/mit-license.php)