|
|
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
|
|
|
-------------------
|
|
|
* [[OpenLP 2 Introduction and FAQ|Introduction and FAQ]]
|
|
|
<!-- MarkdownTOC levels="1" autolink="true" -->
|
|
|
|
|
|
- [General](#general)
|
|
|
- [Advanced](#advanced)
|
|
|
- [Helpful Links](#helpful-links)
|
|
|
- [Testing](#testing)
|
|
|
- [Translating](#translating)
|
|
|
- [Development](#development)
|
|
|
- [iOS Development](#ios-development)
|
|
|
- [Android Development](#android-development)
|
|
|
- [Packaging](#packaging)
|
|
|
- [Documentation](#documentation)
|
|
|
|
|
|
<!-- /MarkdownTOC -->
|
|
|
|
|
|
# General
|
|
|
## General Information
|
|
|
* [[OpenLP Introduction and FAQ|Introduction and FAQ]]
|
|
|
* [[Feature Requests]]
|
|
|
* [[Authentication_and_SSL]]
|
|
|
* [[Brand Guidelines]]
|
|
|
|
|
|
Advanced
|
|
|
=======
|
|
|
# Advanced
|
|
|
* [[Sample Data]]
|
|
|
* [[Scratchpad:Tips|Tips]]
|
|
|
* [[Scratchpad:Synchronising Data Between Computers|Synchronising Data Between Computers]]
|
|
|
* [[Tips|Tips]]
|
|
|
* [[Synchronising Data Between Computers|Synchronising Data Between Computers]]
|
|
|
|
|
|
Helpful Links
|
|
|
=============
|
|
|
* [[Glossary]]
|
|
|
# Helpful Links
|
|
|
* [Glossary]
|
|
|
* [[Addendum]]
|
|
|
* [[Resources]]
|
|
|
|
|
|
Side Projects
|
|
|
=============
|
|
|
* [[OpenLP Tweeter]]
|
|
|
|
|
|
Testing
|
|
|
=======
|
|
|
Getting Started
|
|
|
---------------
|
|
|
# Testing
|
|
|
## Getting Started
|
|
|
* [[Testing:Getting Started|Getting started]]
|
|
|
* [[Development:Linux Development Environment|Get up and running on Linux]]
|
|
|
* [[Linux Development Environment|Get up and running on Linux]]
|
|
|
* [[Testing:Mac OS X Testing Environment|Get up and running on Mac OS X]]
|
|
|
* [[Testing:Windows Testing Environment|Get up and running on Windows]]
|
|
|
* [[Testing:UAT Script|User Acceptance Test (UAT) Script]]
|
|
|
* [[Testing:List of Tests|List of tests]] (test recently fixed bugs/added features: [[Testing:Changelog|Changelog]])
|
|
|
* [https://bugs.launchpad.net/openlp Bugs found in OpenLP]
|
|
|
|
|
|
Translating
|
|
|
===========
|
|
|
Getting Started
|
|
|
---------------
|
|
|
* [[Translation:Getting Started|Getting Started]]
|
|
|
* [[Translation:Guidelines|Guidelines]]
|
|
|
* [[Translation:Create Translation Files|Create Translation Files]]
|
|
|
* [[Translation:Translation Workflow|Translation Workflow]]
|
|
|
* [[Scratchpad:Translation|Translation Scratchpad]]
|
|
|
* [[Translation:Getting StartedAndroid|Getting Started - Android]]
|
|
|
|
|
|
Development
|
|
|
===========
|
|
|
Getting Started
|
|
|
---------------
|
|
|
* [[Development:Getting Started|Getting started]]
|
|
|
* [[Development:Linux Development Environment|Get up and running on Linux]]
|
|
|
* [[Development:Mac OS X Development Environment|Get up and running on Mac OS X]]
|
|
|
* [[Development:Windows Development Environment|Get up and running on Windows]]
|
|
|
* [[Development:Workflow|Development Workflow]]
|
|
|
* [[Development:Unit Tests|Writing Unit Tests]]
|
|
|
* [[Development:Changes-2-6 |Code Features for 2.6]]
|
|
|
|
|
|
Standards
|
|
|
=========
|
|
|
* [[Development:Coding Standards|Coding Standards]]
|
|
|
* [[Development:String Standards|String Standards]]
|
|
|
* [[Development:Form Design|Form Design]]
|
|
|
* [[Development:Branching And Merging Standards|Branching And Merging Standards]]
|
|
|
* [[Development:Registry|Registry]]
|
|
|
* [[Development:Structure|Code Structure]]
|
|
|
|
|
|
General Development
|
|
|
===================
|
|
|
* [[Development:Core API Framework|New Core API]]
|
|
|
* [[Development:Plugin Developers Guide|Plugin Developers' Guide]]
|
|
|
* [[Development:Threads|Using threads in OpenLP]]
|
|
|
* [[Development:Profiling|Profiling OpenLP]] (to track down speed problems)
|
|
|
# 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]]
|
|
|
* [[Scratchpad:Creating XML Using lxml.objectify|Creating XML Using lxml.objectify]]
|
|
|
* [[Creating XML Using lxml.objectify|Creating XML Using lxml.objectify]]
|
|
|
* [http://api.openlp.io/ OpenLP 2 API Documentation]
|
|
|
* [[Development:Release Procedure|Release Procedure]]
|
|
|
|
|
|
Setup
|
|
|
=====
|
|
|
* [[Bazaar]]
|
|
|
* [[Configuring SSH Keys on Windows]]
|
|
|
* [[Configuring SSH Keys on Linux and Mac OS X]]
|
|
|
|
|
|
Scratchpad
|
|
|
==========
|
|
|
* [[Scratchpad:Implementation of Parts and Translations|Implementation of Parts and Translations]]
|
|
|
* [[Scratchpad:Song Database Content|Song Database Content]]
|
|
|
* [[Scratchpad:Speed_Problems|Speed Problems]]
|
|
|
* [[Scratchpad:Media Plugin Rewrite|Media Plugin Rewrite]]
|
|
|
* [[Scratchpad:iOS Development|iOS Development]]
|
|
|
* [[Scratchpad:Remote Sync|Remote Sync]]
|
|
|
* [[Scratchpad:Paths|Paths]]
|
|
|
* [[Scratchpad:Renderer 2.0|Renderer 2.0]]
|
|
|
|
|
|
Importing Songs
|
|
|
===============
|
|
|
* [[Development:Song Importer Developers Guide|Song Importer Developers' Guide]]
|
|
|
* [[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):
|
|
|
|
|
|
* [[Development:SongBeamer - Song Data Format|SongBeamer]]
|
|
|
* [[Development:ZionWorx - Song Data Format|ZionWorx]]
|
|
|
* [[Development:EasyWorship - Song Data Format|EasyWorship]]
|
|
|
* [[Development:EasySlides - Song Data Format|Easyslides]]
|
|
|
* [[Scratchpad:OpenLyrics XML Format|OpenLyrics XML Format]]
|
|
|
* [[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
|
|
|
## External Links
|
|
|
* [https://python.swaroopch.com/ A Byte of Python ebook] Recommended introduction to Python.
|
|
|
* [http://docs.python.org/ Python documentation]
|
|
|
* [http://doc.qt.io/qt-5/ Qt5 reference] and [http://pyqt.sourceforge.net/Docs/PyQt5/ PyQt5 reference]
|
|
|
* [http://www.sqlalchemy.org/trac/wiki/UsageRecipes/Py2exePy2app py2app/py2exe and SQLAlchemy]
|
|
|
* [http://web.archive.org/web/20100613121452/http://labs.trolltech.com/blogs/2009/01/15/creating-qch-files-from-doxygen-revisited/ Creating help files with Doxygen and QtAssistant]
|
|
|
|
|
|
iOS Development
|
|
|
# iOS Development
|
|
|
* [[iOS:Getting Started|Getting Started]]
|
|
|
|
|
|
Android Development
|
|
|
# Android Development
|
|
|
* [[Android:Getting Started|Getting Started]]
|
|
|
* [[Android:Roadmap|Roadmap]]
|
|
|
* [[Development:Workflow|Development Workflow]]
|
|
|
|
|
|
Packaging
|
|
|
---------
|
|
|
* [[Packaging:Getting Started|Getting Started]]
|
|
|
* [[Packaging:Basic Process|Basic Process]]
|
|
|
* [[Packaging:Version Script|Python Version Script]]
|
|
|
* [[Packaging:Release|Release Procedures]]
|
|
|
* [[Packaging:Snaps|Packaging a Snap]]
|
|
|
* [[Packaging:Debian/Ubuntu Linux|Packaging on Debian/Ubuntu Linux]]
|
|
|
* [[Packaging:Fedora|Packaging on Fedora Linux]]
|
|
|
* [[Packaging:openSUSE|Packaging on openSUSE]]
|
|
|
* [[Packaging:Arch Linux|Packaging on Arch Linux]]
|
|
|
* [[Packaging:Mac OS X|Packaging on Mac OS X]]
|
|
|
* [[Packaging:Windows|Packaging on Windows]]
|
|
|
|
|
|
Documentation
|
|
|
* [[Documentation:Getting Started]]
|
|
|
* [[Documentation:Using bzr]]
|
|
|
* [[Documentation:Service Print]]
|
|
|
* [[Workflow|Development Workflow]]
|
|
|
|
|
|
# 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]] |