Skip to content

Commit

Permalink
Update English page to version 2.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
reckel-jm committed Aug 14, 2023
1 parent 36ef18a commit 4576a46
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 20 deletions.
23 changes: 9 additions & 14 deletions content/_index.en.md
Expand Up @@ -9,24 +9,19 @@ chapter: true

Welcome to this webpage!

Cantara Song is a song presentation software which can be used for presenting songs in churches, small groups or karaoke parties. It supports various input formats and can create beautiful presentation slides or copies the lyrics into the clipboard so that they can easily shared via chat messengers like Telegram or WhatsApp.
Cantara Song is a song presentation software which can be used for presenting songs in churches, small groups or karaoke parties. It supports various input formats and can create beautiful presentation slides or export the presentation to various output formats so that they can be used for various purposes.

{{< carousel items="1" height="500" unit="px" duration="7000" >}}

Cantara has the following advantages:

* **Super-fast and lightweight**: Cantara is less then 10 MB of size and uses the components available on the local operation system as far as possible. It contains no bloatware. It can be run on an old computer, a raspberry-pi and many more.
* **Very easy to use**: Creating the presentation slides for an event only takes a few seconds. The usage is very intuitive and user-friendly.
* **Good integration with other presentation software**: Cantara integrates easily with other presentation software like LibreOffice Impress, MS Powerpoint or PdfPC. It can be included in a complex workflow like a church service or even an online streaming event via OBS.
* **Very easy to use**: Accepts the most common input format (CCLI songselect lyrics file) and creats the presentation slides for an event in only a few seconds. The usage is very intuitive and user-friendly.
* **Good integration with other presentation software**: Cantara can export presentations to PPTX format and therefore integrates easily with other presentation software like LibreOffice Impress or MS Powerpoint. It can be included in a complex workflow like a church service or even an online streaming event via OBS. In addition, you can export the lyrics to text formats and share them in messenger groups, as a HTML page etc.
* **Multi-Screen-Support**: Multi Screen is supported out of the box.
* **Customizable Design**: The colors and fonts can be configured in the settings. In addition, you can set up a background picture and adjust it's brightness/transparency.
* **Customizable Design and good outlook**: The colors and fonts can be configured in the settings. In addition, you can set up a background picture and adjust it's brightness/transparency. The presentations look beautiful and are easy to read.
* **Multi language support**: Cantara can present and export song presentations in two different languges at the same time. In addition, it has been translated itself into [a few languages](contribute/translate#current-state) by the community.
* **Free and Open Source**: No license fees, no dependence on certain companies–Cantara is licensed under the [GPL3](https://www.gnu.org/licenses/gpl-3.0.html) and can be used everywhere and as you want.
* **Used all over the world and continuously developed**: Although Cantara is still a quite young project, people from many countries are using it. In the future, more functions are going to be implemented.

The current version is 2.4.1. [You can easily download and install it for Linux, Windows and Mac OS](tutorial/install-cantara). Cantara is written with the programming language Pascal/Lazarus, therefore it is platform-independent and can be compiled to almost every device. You can also compile Cantara by yourself. [Find more information here](tutorial/install-cantara/#generic-compilation).
* **Used all over the world and continuously developed**: Although Cantara is still a quite young project, people from many countries are using it. It has been translated to several langauges. In the future, more functions are going to be implemented.

![Cantara Running Presentation with Background](/images/cantara1.png?width=900)
![Cantara Full Screen](/images/cantara2.png?width=900)
![Cantara Other Layout](/images/cantara3.png?width=900)
![Cantara Other Layout Full Screen](/images/cantara4.png?width=900)
![Cantara Overview](/images/cantara-overview.jpg?width=900)
![Cantara Multiscreen](/images/cantara-multiscreen.jpg?width=900)
![Cantara Song](/images/cantara-song.jpg?width=900)
The current version is 2.5.0. [You can easily download and install it for Linux, Windows and Mac OS](tutorial/install-cantara). Cantara is written with the programming language Pascal/Lazarus, therefore it is platform-independent and can be compiled to almost every device. You can also compile Cantara by yourself. [Find more information here](tutorial/install-cantara/#generic-compilation).
8 changes: 5 additions & 3 deletions content/tutorial/How Cantara Works.en.md
Expand Up @@ -18,11 +18,13 @@ Later I have been able to lead the [best student group in the world](https://www

{{<mermaid align="left">}}
graph LR;
A[Song Rep] -->|Collecting Songs| B(Song List)
A[Input File] -->|Collecting Songs| B(Song List)
B --> C(Song Selection)
C --> D{Generate Presentation Data}
D --> E[Run Presentation]
D --> F[Copy Lyrics to Clipboard]
D --> E[Run Presentation Directly]
D --> F[Export Lyrics in Markup Format]
D --> G[Export Presentation as PPTX]
D --> H[Export Presentation as Pictures]
{{< /mermaid >}}

Cantara takes the songs from *one particular folder* on the file system which is called the *song repository* (or briefly song repo). Every song is a simple text file which can be edited with a text editor of your choice. Cantara will recognize the song title from the name of the file (without the extension). So, for example. If you have a file like:
Expand Down
27 changes: 26 additions & 1 deletion content/tutorial/How to use it.en.md
Expand Up @@ -42,9 +42,34 @@ During the presentation mode, you can control the presentation slides via severa
If you are running other programs like Libreoffice Impress or MS PowerPoint in presentation mode at the same time, you can easily switch between the presenters with Alt+Tab. When the presentation mode in Cantara gets started, it will cover the second screen and be in foreground. To move Cantara to the background, press Alt+Tab to navigate to the program you want to show up.
{{% /notice %}}

## Export Presentation

Cantara offers several ways for exporting presentations so that they can be reused in an other program or for an other purpose. All the export options are available in the *export menu* of the main window. Generally, there are two types of exports:

1. **Export the presentation slides**: This will export the presentation slides exactly as they are displayed inside Cantara. At the moment there are two export options for this type:
1. **Power Point Presentation** (.pptx-file): This will export the slide presentation as a pptx file so that it can be used in a presentation program (Microsoft Powerpoint, Libreoffice Impress, Softmaker Presentation etc.). For the generation of the slides, the JavaScript library [PptxGenJs](https://gitbrent.github.io/PptxGenJS/) (MIT license) will be used inside the local web browser as a renderer.
2. **Pictures/Images**: This will export a JPEG file for every slide and save it into a folder of choice.
2. **Export the Lyrics as Markup**: It will export the lyrics of the songs in their right order in a specified markup format but without any presentation settings (slide breaks, background picture, colors, etc.). This can be used (but is not limited) for:
- Exporting the songs as a WhatsApp/Telegram message so that it can be shared a long groups/channels for the congregation/people to sing along
- Exporting the songs as a HTML webpage so they can be published on a webpage
- Exporting just the titles of the song so they can be reported to CCLI.

The structure of the markup can be specified through a LaTeX style markup language. Go to *Export -> Markup Text* To open the Markup Export window.

![](/images/cantara-markup-export.png)

The template language supports the following commands/environments. All of them are *optional*:

- ```\header { ... }```: The header part of the document which will be shown at the top of the document. No song specific content can be displayed here as this part is outside of the song loop.
- ```\footer { ... }```: The footer part of the document which will be shown at the bottom of the document. No song specific content can be displayed here as this part is outside of the song loop.
- ```\newline```: Inserts a system default line break
- ```\betweensongs { ... }```: Defines what should be displayed between two songs (but not before the first song and after the last song). The default value is set to two line breaks (a new paragraph: ```\betweensongs { \newline \newline }```)
- ```\lineending```: Specifies the line ending inside the song loop (default value is ```\newline```)
- ```\songloop { ... }``` The content which will be displayed **for each song** (repeated for each song). Inside this environment, song tags (see [Meta Data](/tutorial/meta-data)) can be accessed via ```\tagname``` – for example ```\title``` for the ```title``` tag and ```\author``` for the ```author``` tag. The lyrics itself a loaded via the ```\lyrics``` command.

## Save and Load Song Selections

You can save and load song selections into Cantara to share it within the organization or for preparing an event. While doing so, you have two options:

1. The **songtex**-format contains the song names **and** the song file with its content. That means, if you export the songselection to a songtex-file, the receiver don't need to have the songs in his song repository. While importing the songtex-file, Cantara checks whether the file already exists in the repository, and, if not, adds it.
2. The legacy export/import function imports only the titles, that means, the receiver needs to have the songs in his song repository.
2. The legacy export/import function imports only the titles, that means, the receiver needs to have the songs in his song repository.
5 changes: 3 additions & 2 deletions content/tutorial/_index.en.md
Expand Up @@ -8,10 +8,11 @@ chapter = true
# Tutorial

The following pages will give you a detailed instruction to Cantara and how the software works.
For most users, Cantara should work well out of the box. However, if there are problems or issues which can't be solved, feel also free to go to the [Github repository](https://github.com/reckel-jm/cantara) and ask for additional help.
For most users, Cantara should work well out of the box.
However, if there are problems or issues which can't be solved, feel also free to go to the [Github repository](https://github.com/reckel-jm/cantara) and ask for additional help.

{{% notice info %}}
Please note that this tutorial is for version 2.4.0 and later. Prior versions won't support all the features which are described in this section.
Please note that this tutorial is for version 2.5.0 and later. Prior versions won't support all the features which are described in this section.
{{% /notice %}}

While reading the following pages, you will be able to learn how Cantara works, how you can download it, where you can get song lyrics from and how you can use the program.
Expand Down

0 comments on commit 4576a46

Please sign in to comment.