wiki

Welcome to the OpenLP wiki! This wiki is mostly used by the developers, but contains other information like our Frequently Asked Questions.

• General
• Development
• Testing
• Translating
• External Links
• Custom Stage Views
• iOS Development
• Packaging
• Documentation
• General Housekeeping/Public Relations

General

General Information

• Introduction and FAQ
• Brand Guidelines
• Data Privacy

Advanced

• Sample Data
• Tips
• Synchronising Data Between Computers

Helpful Links

• Glossary
• Addendum
• Resources

Development

Getting Started

• Getting started
• Get up and running on Linux
• Get up and running on Mac OS X
• Get up and running on Windows
• Development Workflow
• Writing Unit Tests

Standards

• Coding Standards
• String Standards
• Form Design
• Branching And Merging Standards
• Registry
• State
• Code Structure
• Icon Development

General Development

• New Core API
• Plugin Developers' Guide
• Using threads in OpenLP
• Profiling OpenLP (to track down speed problems)
• Theme XML Schema
• Creating XML Using lxml.objectify
• OpenLP 2 API Documentation
• Release Procedure

Setup

• Git
• Configuring SSH Keys on Windows
• Configuring SSH Keys on Linux and Mac OS X
• Hatch

Testing

Getting Started

• Getting started
• Get up and running on Linux
• Get up and running on Mac OS X
• Get up and running on Windows
• User Acceptance Test (UAT) Script
• List of tests (test recently fixed bugs/added features: Changelog)
• Bugs found in OpenLP

Translating

Getting Started

• Getting Started
• Guidelines
• Create Translation Files
• Translation Workflow
• Translation Scratchpad
• [Getting Started -

Scratchpad

• Implementation of Parts and Translations
• Song Database Content
• Speed Problems
• Remote Sync
• Paths

Importing Songs

• Song Importer Developers' Guide

Documentation on different song formats (an import class has now been written for each of these):

• SongBeamer
• ZionWorx
• EasyWorship
• Easyslides
• OpenLyrics XML Format
• Singing the Faith

External Links

• A Byte of Python ebook Recommended introduction to Python.
• Python documentation
• Qt5 reference and PyQt5 reference
• py2app/py2exe and SQLAlchemy
• Creating help files with Doxygen and QtAssistant

Custom Stage Views

• Getting Started

iOS Development

• Getting Started

Packaging

• Getting Started
• Basic Process
• Python Version Script
• Release Procedures
• Packaging a Snap
• Packaging on Debian/Ubuntu Linux
• Packaging on Fedora Linux
• Packaging on openSUSE
• Packaging on Arch Linux
• Packaging on Mac OS X
• Packaging on Windows
• Packaging a Flatpak
• Virus False Positives

Documentation

• Documentation Getting Started
• Documentation Using git
• Documentation Service Print
• Documentation HTTP API
• Documentation WebSockets

General Housekeeping/Public Relations

• OpenLP promotion