openlp
/
documentation
mirror of https://gitlab.com/openlp/documentation.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Use the documentation Docker image and build a PDF 

- Use the documentation Docker image
- Build PDF
- Link to image from manual front page
- Fix display tags table
- Remove unsupported characters in display tags table
This commit is contained in:
Raoul Snyman 2019-10-03 20:01:03 +00:00 committed by Tomas Groth
parent 372817fbaa
commit 49458181a5
3 changed files with 47 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.gitlab-ci.yml
View File

@ -1,8 +1,4 @@
image: alpine image: openlp/documentation
before_script:
- apk --no-cache add make py3-setuptools python3-dev
- python3 -m pip install sphinx sphinx_rtd_theme
pages: pages:
stage: deploy stage: deploy
@ -10,6 +6,10 @@ pages:
- cd manual - cd manual
- make html - make html
- mv build/html/ ../public/ - mv build/html/ ../public/
- make latex
- cd build/latex
- make all-pdf
- mv OpenLP.pdf ../../../public/
artifacts: artifacts:
paths: paths:
- public - public
@ -22,6 +22,10 @@ test:
- cd manual - cd manual
- make html - make html
- mv build/html/ ../test/ - mv build/html/ ../test/
- make latex
- cd build/latex
- make all-pdf
- mv OpenLP.pdf ../../../test/
artifacts: artifacts:
paths: paths:
- test - test

54
manual/source/display_tags.rst
View File

@ -144,30 +144,30 @@ each left justified.
.. table:: .. table::
:widths: grid :widths: grid
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Description | Tag | Start HTML | End HTML | | Description | Tag | Start HTML | End HTML |
+================+=====+=============================================================================================================================+================+ +=================+=======+=============================================================================================================================+================+
| Align Left | al | ``<div align="left">`` | ``</div>`` | | Align Left | al | ``<div align="left">`` | ``</div>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Align Center | ac | ``<div align="center">`` | ``</div>`` | | Align Center | ac | ``<div align="center">`` | ``</div>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Align Right | ar | ``<div align="right">`` | ``</div>`` | | Align Right | ar | ``<div align="right">`` | ``</div>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Font size ˄ | fu | ``<big>`` | ``</big>`` | | Big font size | fu | ``<big>`` | ``</big>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Font size ˅ | fd | ``<small>`` | ``</small>`` | | Small font size | fd | ``<small>`` | ``</small>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Font size 20pt | f20 | ``<span style="font-size: 20pt">`` | ``</span>`` + | Font size 20pt | f20 | ``<span style="font-size: 20pt">`` | ``</span>`` +
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Arial |arial| ``<span style="font-family:arial;">`` | ``</span>`` | | Arial | arial | ``<span style="font-family:arial;">`` | ``</span>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Times New |times| ``<span style="font-family:times new roman;">`` | ``</span>`` | | Times New | times | ``<span style="font-family:times new roman;">`` | ``</span>`` |
| Roman | | | | | Roman | | | |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Paragraph with | phg | ``<div style=" padding-left: 2em;text-indent: -0.5em; adding-left: 2em; padding-bottom:0.1em; margin:4em; float: left; ">`` | ``</div>`` | | Paragraph with | phg | ``<div style=" padding-left: 2em;text-indent: -0.5em; adding-left: 2em; padding-bottom:0.1em; margin:4em; float: left; ">`` | ``</div>`` |
| hanging test | | | | | hanging test | | | |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Column left | cl | ``<div style="position:absolute; margin-left:0%>`` | ``</div>`` | | Column left | cl | ``<div style="position:absolute; margin-left:0%>`` | ``</div>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+
| Column right | cr | ``<div style="position:absolute; margin-left:50%>`` | ``</div>`` | | Column right | cr | ``<div style="position:absolute; margin-left:50%>`` | ``</div>`` |
+----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+

11
manual/source/index.rst
View File

@ -5,6 +5,16 @@ The OpenLP User Manual is here to help you learn how to use OpenLP. From install
using OpenLP on a regular basis, all the information you need to know is in here. And if you see some of it is missing, using OpenLP on a regular basis, all the information you need to know is in here. And if you see some of it is missing,
please `help us add it`_. please `help us add it`_.
Download This Manual
--------------------
You can download this manual as a PDF from here: https://manual.openlp.org/OpenLP.pdf
To open the downloaded manual, you'll need a PDF reader. On macOS and Linux your computer should already have a PDF
reader. On Windows you'll need to install `SumatraPDF`_.
If you're reading the downloaded manual, you can get the online version at https://manual.openlp.org
Getting Started With OpenLP Getting Started With OpenLP
--------------------------- ---------------------------
@ -60,3 +70,4 @@ Questions and Troubleshooting
troubleshooting troubleshooting
.. _help us add it: https://openlp.org/contribute .. _help us add it: https://openlp.org/contribute
.. _SumatraPDF: https://www.sumatrapdfreader.org/