CodeMirror/manuskript
1
0
Fork 0
mirror of https://github.com/olivierkes/manuskript.git synced 2024-04-25 08:42:03 +12:00
Code Issues Projects Releases Wiki Activity
Page: Home
Pages
Adding a Spellcheck Language Dictionary to Manuskript Bundle manuskript for OS X with Platypus Configuration Settings Storage Locations Contributing guidelines for developers Creating manuskript binary for Android and IOS Documentation Snippets Fullscreen Mode Home How To Directory How to Add Images to a Project How to Display Remote Pictures How to Enable Dark Theme How to Export with Manuskript and Post Process with Calibre How to format your project with book and research notes in separate root level folders How to keep track of important items How to run manuskript globally, from anywhere How to start a new project Import and Export capabilities Keyboard Shortcuts Notes for linux packagers: removable files Overview of Manuskript Menu Overview of Manuskript Panes Overview of Manuskript Right Sidebar Overview of Manuskript Settings Package Manuskript for Linux with PyInstaller Package Manuskript for Linux with Stdeb Package Manuskript for Linux with dpkg Package Manuskript for Linux with rpm Package Manuskript for Windows with PyInstaller Package Manuskript for Windows with wine Package manuskript for OS X Roadmap Run Manuskript from Source Code on Linux Run Manuskript from Source Code on Windows Run manuskript on OS X Steps To Create An Official Manuskript Release Submitting an issue on Github Technical Support Translate Manuskript [Packaging] Generate Windows binaries with pyInstaller (HowTo)
116 Home
AlanDunaway edited this page 2022-09-22 14:54:00 -03:00
Table of Contents

Installing

Install Binary (Easier)

  • Manuskript Download
  • TIP: Install pandoc for more export document formats such as ePub, OpenDocument (LibreOffice), and DocX (MS Word).

Install Source Code (More Work, Runs on More OS Platforms)

Using

How To...

Overview

Features

Known Issues

Qt 5.5.1

  • Compile/export will silently overwrite existing file (PR #613)

Qt 5.11.x to 5.12.x

  • Import will cause Manuskript to crash (PR #612)

The procedure entry point OPENSSL_sk_new_reserve could not be located...

  • This is caused by an incompatibility between PyQt and Python. (Source.)
    • Starting at PyQt 5.12.4, it is built against OpenSSL 1.1.1; prior to that, it was built against OpenSSL 1.1.0.
    • Python 3.7.4+ is built against OpenSSL 1.1.1, but earlier Python versions were built against OpenSSL 1.1.0.
  • To fix this, make sure your version of Python and PyQt rely on the same version of OpenSSL.

PyEnchant Spell Check

Mission Statement

The goal of Manuskript is to ease the task of writing large projects by providing facilities to stay organized and track details, while also keeping distractions to a minimum. Functionality is to be provided by Free Software only.

To maximize flexibility an open and plain text file format is used enabling collaboration with third-party tools.

Contributing

Developing

  • Manuskript is written in Python3 and PyQt5
  • All code changes and Pull Requests should be based on the develop branch.
  • The minimum target screen resolution is 1024x600 (was popular with small laptops / netbooks)
  • We strive to conform to Qt guidelines. E.g.: User Interface Text Guidelines
  • Tip: Add --console as last option on command line to use IPython Jupyter QT Console as a debugging aid.
  • DRAFT
    We try to ensure that Manuskript will run on currently supported Operating Systems with Qt integration. This includes several GNU/Linux distributions, in addition to recent versions of proprietary Windows and macOS X.
    OSes we often use in our testing include: Debian, Fedora, Ubuntu, and Windows.
    No promise of support is provided. See also GNU General Public License.
  • Roadmap contains some potential future plans.

Translating

Packaging (for release package file)

Releasing Official Version