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