Skip to content
updates authored by Tim Bentley's avatar Tim Bentley
Welcome to the OpenLP wiki! This wiki is mostly used by the developers, but contains other information like our Frequently Asked Questions.
# Table of Contents
<!-- MarkdownTOC levels="1" autolink="true" -->
- [General](#general)
- [Advanced](#advanced)
- [Helpful Links](#helpful-links)
- [Testing](#testing)
- [Translating - Getting Started](#translating---getting-started)
- [Development](#development)
- [iOS Development](#ios-development)
- [Android Development](#android-development)
- [Packaging](#packaging)
- [Documentation](#documentation)
<!-- /MarkdownTOC -->
# General
* [Introduction and FAQ](Introduction-and-FAQ)
* [Brand Guidelines](Brand-Guidelines)
# Advanced
* [Sample Data](Sample-Data)
* [[Tips|Tips]]
* [[Synchronising Data Between Computers|Synchronising Data Between Computers]]
# Helpful Links
* [[Glossary]]
* [[Addendum]]
* [[Resources]]
# Testing
## Getting Started
* [[Getting Started|Getting started]]
* [[Linux Development Environment|Get up and running on Linux]]
* [[Mac OS X Testing Environment|Get up and running on Mac OS X]]
* [[Windows Testing Environment|Get up and running on Windows]]
* [[UAT Script|User Acceptance Test (UAT) Script]]
* [[List of Tests|List of tests]] (test recently fixed bugs/added features: [[Testing:Changelog|Changelog]])
* [Bugs found in OpenLP](https://bugs.launchpad.net/openlp)
# Translating - Getting Started
* [[Getting Started|Getting Started]]
* [[Guidelines|Guidelines]]
* [[Create Translation Files|Create Translation Files]]
* [[Translation Workflow|Translation Workflow]]
* [[Translation|Translation Scratchpad]]
* [[Getting StartedAndroid|Getting Started - Android]]
# Development
## Getting Started
* [[Getting Started|Getting started]]
* [[Linux Development Environment|Get up and running on Linux]]
* [[Mac OS X Development Environment|Get up and running on Mac OS X]]
* [[Windows Development Environment|Get up and running on Windows]]
* [[Workflow|Development Workflow]]
* [[Unit Tests|Writing Unit Tests]]
* [[Changes-2-6 |Code Features for 2.6]]
## Standards
* [[Coding Standards|Coding Standards]]
* [[String Standards|String Standards]]
* [[Form Design|Form Design]]
* [[Branching And Merging Standards|Branching And Merging Standards]]
* [[Registry|Registry]]
* [[Structure|Code Structure]]
## General Development
* [[Core API Framework|New Core API]]
* [[Plugin Developers Guide|Plugin Developers' Guide]]
* [[Threads|Using threads in OpenLP]]
* [[Profiling|Profiling OpenLP]] (to track down speed problems)
* [[Theme|Theme XML Schema]]
* [[Creating XML Using lxml.objectify|Creating XML Using lxml.objectify]]
* [http://api.openlp.io/ OpenLP 2 API Documentation]
* [[Release Procedure|Release Procedure]]
## Scratchpad
* [[Implementation of Parts and Translations|Implementation of Parts and Translations]]
* [[Song Database Content|Song Database Content]]
* [[Speed_Problems|Speed Problems]]
* [[Media Plugin Rewrite|Media Plugin Rewrite]]
* [[iOS Development|iOS Development]]
* [[Remote Sync|Remote Sync]]
* [[Paths|Paths]]
* [[Renderer 2.0|Renderer 2.0]]
## Importing Songs
* [[Song Importer Developers Guide|Song Importer Developers' Guide]]
Documentation on different song formats (an import class has now been written for each of these):
* [[SongBeamer - Song Data Format|SongBeamer]]
* [[ZionWorx - Song Data Format|ZionWorx]]
* [[EasyWorship - Song Data Format|EasyWorship]]
* [[EasySlides - Song Data Format|Easyslides]]
* [[OpenLyrics XML Format|OpenLyrics XML Format]]
## External Links
* [[Recommended introduction to Python. A Byte of Python ebook| https://python.swaroopch.com/ ]]
* [[Python documentation | http://docs.python.org/ ]]
* [[Qt5 reference] and [http://pyqt.sourceforge.net/Docs/PyQt5/ PyQt5 reference | http://doc.qt.io/qt-5/]]
* [[py2exe and SQLAlchemy | http://www.sqlalchemy.org/trac/wiki/UsageRecipes/Py2exePy2app py2app/]]
* [[Creating help files with Doxygen and QtAssistant | http://web.archive.org/web/20100613121452/http://labs.trolltech.com/blogs/2009/01/15/creating-qch-files-from-doxygen-revisited/ ]]
# iOS Development
* [[Getting Started|Getting Started]]
# Android Development
* [[Getting Started|https://gitlab.com/openlp/android/wikis/home]]
# Packaging
* [[Getting Started|Getting Started]]
* [[Basic Process|Basic Process]]
* [[Version Script|Python Version Script]]
* [[Release|Release Procedures]]
* [[Snaps|Packaging a Snap]]
* [[Debian/Ubuntu Linux|Packaging on Debian/Ubuntu Linux]]
* [[Fedora|Packaging on Fedora Linux]]
* [[openSUSE|Packaging on openSUSE]]
* [[Arch Linux|Packaging on Arch Linux]]
* [[Mac OS X|Packaging on Mac OS X]]
* [[Windows|Packaging on Windows]]
# Documentation
* [[Getting Started]]
* [[Using bzr]]
* [[Service Print]]
General Housekeeping/Public Relations
* [[OpenLP promotion]]
Welcome to the OpenLP wiki\! This wiki is mostly used by the developers,
but contains other information like our Frequently Asked Questions.
## General
### General Information
- [Introduction and FAQ](OpenLP_2_Introduction_and_FAQ "wikilink")
- [Feature Requests](Feature_Requests "wikilink")
- [Authentication\_and\_SSL](Authentication_and_SSL "wikilink")
- [Brand Guidelines](Brand_Guidelines "wikilink")
### Advanced
- [Sample Data](Sample_Data "wikilink")
- [Tips](Scratchpad:Tips "wikilink")
- [Synchronising Data Between
Computers](Scratchpad:Synchronising_Data_Between_Computers "wikilink")
### Helpful Links
- [Glossary](Glossary "wikilink")
- [Addendum](Addendum "wikilink")
- [Resources](Resources "wikilink")
### Side Projects
- [OpenLP Tweeter](OpenLP_Tweeter "wikilink")
## Testing
### Getting Started
- [Getting started](Testing:Getting_Started "wikilink")
- [Get up and running on
Linux](Development:Linux_Development_Environment "wikilink")
- [Get up and running on Mac OS
X](Testing:Mac_OS_X_Testing_Environment "wikilink")
- [Get up and running on
Windows](Testing:Windows_Testing_Environment "wikilink")
- [User Acceptance Test (UAT) Script](Testing:UAT_Script "wikilink")
- [List of tests](Testing:List_of_Tests "wikilink") (test recently
fixed bugs/added features:
[Changelog](Testing:Changelog "wikilink"))
- [Bugs found in OpenLP](https://bugs.launchpad.net/openlp)
## Translating
### Getting Started
- [Getting Started](Translation:Getting_Started "wikilink")
- [Guidelines](Translation:Guidelines "wikilink")
- [Create Translation
Files](Translation:Create_Translation_Files "wikilink")
- [Translation Workflow](Translation:Translation_Workflow "wikilink")
- [Translation Scratchpad](Scratchpad:Translation "wikilink")
- [Getting Started -
Android](Translation:Getting_StartedAndroid "wikilink")
## Development
### Getting Started
- [Getting started](Development:Getting_Started "wikilink")
- [Get up and running on
Linux](Development:Linux_Development_Environment "wikilink")
- [Get up and running on Mac OS
X](Development:Mac_OS_X_Development_Environment "wikilink")
- [Get up and running on
Windows](Development:Windows_Development_Environment "wikilink")
- [Development Workflow](Development:Workflow "wikilink")
- [Writing Unit Tests](Development:Unit_Tests "wikilink")
- [Code Features for 2.6](Development:Changes-2-6 "wikilink")
### Standards
- [Coding Standards](Development:Coding_Standards "wikilink")
- [String Standards](Development:String_Standards "wikilink")
- [Form Design](Development:Form_Design "wikilink")
- [Branching And Merging
Standards](Development:Branching_And_Merging_Standards "wikilink")
- [Registry](Development:Registry "wikilink")
- [Code Structure](Development:Structure "wikilink")
### General Development
- [New Core API](Development:Core_API_Framework "wikilink")
- [Plugin Developers'
Guide](Development:Plugin_Developers_Guide "wikilink")
- [Using threads in OpenLP](Development:Threads "wikilink")
- [Profiling OpenLP](Development:Profiling "wikilink") (to track down
speed problems)
- [Theme XML Schema](Theme "wikilink")
- [Creating XML Using
lxml.objectify](Scratchpad:Creating_XML_Using_lxml.objectify "wikilink")
- [OpenLP 2 API Documentation](http://api.openlp.io/)
- [Release Procedure](Development:Release_Procedure "wikilink")
### Setup
- [Bazaar](Bazaar "wikilink")
- [Configuring SSH Keys on
Windows](Configuring_SSH_Keys_on_Windows "wikilink")
- [Configuring SSH Keys on Linux and Mac OS
X](Configuring_SSH_Keys_on_Linux_and_Mac_OS_X "wikilink")
### Scratchpad
- [Implementation of Parts and
Translations](Scratchpad:Implementation_of_Parts_and_Translations "wikilink")
- [Song Database Content](Scratchpad:Song_Database_Content "wikilink")
- [Speed Problems](Scratchpad:Speed_Problems "wikilink")
- [Media Plugin Rewrite](Scratchpad:Media_Plugin_Rewrite "wikilink")
- [iOS Development](Scratchpad:iOS_Development "wikilink")
- [Remote Sync](Scratchpad:Remote_Sync "wikilink")
- [Paths](Scratchpad:Paths "wikilink")
- [Renderer 2.0](Scratchpad:Renderer_2.0 "wikilink")
### Importing Songs
- [Song Importer Developers'
Guide](Development:Song_Importer_Developers_Guide "wikilink")
Documentation on different song formats (an import class has now been
written for each of these):
- [SongBeamer](Development:SongBeamer_-_Song_Data_Format "wikilink")
- [ZionWorx](Development:ZionWorx_-_Song_Data_Format "wikilink")
- [EasyWorship](Development:EasyWorship_-_Song_Data_Format "wikilink")
- [Easyslides](Development:EasySlides_-_Song_Data_Format "wikilink")
- [OpenLyrics XML Format](Scratchpad:OpenLyrics_XML_Format "wikilink")
### External Links
- [A Byte of Python ebook](https://python.swaroopch.com/) Recommended
introduction to Python.
- [Python documentation](http://docs.python.org/)
- [Qt5 reference](http://doc.qt.io/qt-5/) and [PyQt5
reference](http://pyqt.sourceforge.net/Docs/PyQt5/)
- [py2app/py2exe and
SQLAlchemy](http://www.sqlalchemy.org/trac/wiki/UsageRecipes/Py2exePy2app)
- [Creating help files with Doxygen and
QtAssistant](http://web.archive.org/web/20100613121452/http://labs.trolltech.com/blogs/2009/01/15/creating-qch-files-from-doxygen-revisited/)
## iOS Development
- [Getting Started](iOS:Getting_Started "wikilink")
## Android Development
- [Getting Started](Android:Getting_Started "wikilink")
- [Roadmap](Android:Roadmap "wikilink")
- [Development Workflow](Development:Workflow "wikilink")
## Packaging
- [Getting Started](Packaging:Getting_Started "wikilink")
- [Basic Process](Packaging:Basic_Process "wikilink")
- [Python Version Script](Packaging:Version_Script "wikilink")
- [Release Procedures](Packaging:Release "wikilink")
- [Packaging a Snap](Packaging:Snaps "wikilink")
- [Packaging on Debian/Ubuntu
Linux](Packaging:Debian/Ubuntu_Linux "wikilink")
- [Packaging on Fedora Linux](Packaging:Fedora "wikilink")
- [Packaging on openSUSE](Packaging:openSUSE "wikilink")
- [Packaging on Arch Linux](Packaging:Arch_Linux "wikilink")
- [Packaging on Mac OS X](Packaging:Mac_OS_X "wikilink")
- [Packaging on Windows](Packaging:Windows "wikilink")
## Documentation
- [Documentation:Getting
Started](Documentation:Getting_Started "wikilink")
- [Documentation:Using bzr](Documentation:Using_bzr "wikilink")
- [Documentation:Service
Print](Documentation:Service_Print "wikilink")
## General Housekeeping/Public Relations
- [OpenLP promotion](OpenLP_promotion "wikilink")
## Archive
- [Older (out of date) documentation](Archive "wikilink")
## Editing this wiki
- [User's Guide](http://meta.wikimedia.org/wiki/Help:Contents)