Skip to content

Commit

Permalink
RELEASE: Update website for r3.8.2Next release (#686)
Browse files Browse the repository at this point in the history
  • Loading branch information
gilgongo authored Feb 20, 2022
1 parent a062877 commit ef9ba92
Show file tree
Hide file tree
Showing 270 changed files with 1,397 additions and 963 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,20 @@ We use [GitHub markdown](https://guides.github.com/features/mastering-markdown/)

Note that we use British English spelling and grammar conventions.

## Adding pictures
## Adding screenshots

Use the `{{site.url}}` variable to call an existing image in the corresponding directory for that language. This ensures the correct URL is used:
In order to keep the size of the respository under control when images change over time, we do not store screenshots locally. Instead we use Jekyll's `include` function to call a file containing an external URL to the image itself:

`<img src="{{site.url}}/assets/img/en-screenshots/mixer-channles.png"`
`<img src="{% include img/en-screenshots/main-screen-default.inc %}" `

If you want to add a new image, use .png format if possible, and if it’s not a screenshot, ask about where you should store it. Localised images must go in a directory for that language (see the example for English, above).

To get the URL for the `.inc` file, open a Github issue (in any repository) and add your image to it. Github will generate a URL for it like this:

`![your-image-name](https://user-images.githubusercontent.com/45617 … .png)`

Put that URL (only the part within the brackets) into the `.inc` file, saving that in the appropriate directory to be used as above for `<img src=`. Note that because Github generates unique "anonymous" URLs for every image, the `include` method allows us easily to manage the same image used in multiple places if necessary.

### Style and tone

Please have a look at our [style and tone guide](https://jamulus.io/contribute/Style-and-Tone).
Expand Down
1 change: 1 addition & 0 deletions _includes/img
2 changes: 1 addition & 1 deletion _translator-files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Proceed as follows:
- Navigate to `_translator-files/po/LANG/`. Translate the content of the .po files in your editor of choice (Poedit, OmegaT...).
- Change the `lang: en` parameter in the files containing it at the beginning of the file to your language code (it, fr, de, etc.) and make sure the `permalink: [parameter]` (e.g. /wiki/Client-Troubleshooting) stays the same.
- At times there are links to other docs or specific paragraphs in other parts of the website: `[translate this](don't translate this#translate-this-but-don't-use-capitals)`. Make sure the last part uses the exact same words as the relevant paragraph title.
- Some documents contain links to screenshots. Make sure you change the language code in them to your own. You can create screenshots for your language in `/assets/img/[LANG]-screenshots` - just replace them (if they exist already in English) or create them using the English ones as a guide.
- Some documents contain links to screenshots. Make sure you change the language code in them to your own. You can create screenshots for your language in `/assets/img/[LANG]-screenshots` - note that we do not store these image locally but instead use include files calling an external URL to them. Please see README.md on the website repository for further information. Also note that screenshots that do not need to be localised are symlinked to the English version from each `[LANG]-screenshots` directory.
- There are documents containing portions of text that do not require translation, e.g. scripts, links, etc., and which may constitute a full segment in your editor. In these cases, please do not leave the translation field empty, but insert the source text into the translation field. In OmegaT go to Options > Editor and enable "Allow translation to be equal to source". If you have chosen "Leave the segment empty" in Options > Editor, the `Ctrl+Shift+R` shortcut will insert it. In Poedit, `Ctrl+B` will copy it over.
- Submit a Pull Request to the `next-release` branch with the translated .po files.
- Pull requests for translations should have a title which looks like this: `Update [lang] web translation for [release number]`
Expand Down
2 changes: 1 addition & 1 deletion _translator-files/po/de/FAQ.po
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/FAQ.md:58
msgid "<img src=\"{{site.url}}/assets/img/en-screenshots/diagram-overview.png\" loading=\"lazy\" alt=\"Diagram showing how Jamulus works\">"
msgid "<img src=\"{% include img/en-screenshots/diagram-overview.inc %}\" loading=\"lazy\" alt=\"Diagram showing how Jamulus works\">"
msgstr ""

#. type: Plain text
Expand Down
36 changes: 28 additions & 8 deletions _translator-files/po/de/Getting-Started.po
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,15 @@ msgstr "Sobald du Jamulus öffnest, siehst du folgendes Fenster:"

#. type: Plain text
#: ../wiki/en/Getting-Started.md:42
#, no-wrap
#, fuzzy, no-wrap
#| msgid ""
#| "<figure>\n"
#| " <img src=\"{{site.url}}/assets/img/en-screenshots/main-screen-default.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
#| " <figcaption>The main window before you connect to a server</figcaption>\n"
#| "</figure>\n"
msgid ""
"<figure>\n"
" <img src=\"{{site.url}}/assets/img/en-screenshots/main-screen-default.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <img src=\"{% include img/en-screenshots/main-screen-default.inc %}\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <figcaption>The main window before you connect to a server</figcaption>\n"
"</figure>\n"
msgstr ""
Expand All @@ -149,10 +154,15 @@ msgstr "Lasse zuerst die anderen Teilnehmer wissen, wer du bist. Klick dazu auf

#. type: Plain text
#: ../wiki/en/Getting-Started.md:52
#, no-wrap
#, fuzzy, no-wrap
#| msgid ""
#| "<figure>\n"
#| " <img src=\"{{site.url}}/assets/img/en-screenshots/settings-profile.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
#| " <figcaption>Let people know who you are</figcaption>\n"
#| "</figure>\n"
msgid ""
"<figure>\n"
" <img src=\"{{site.url}}/assets/img/en-screenshots/settings-profile.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <img src=\"{% include img/en-screenshots/settings-profile.inc %}\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <figcaption>Let people know who you are</figcaption>\n"
"</figure>\n"
msgstr ""
Expand Down Expand Up @@ -189,10 +199,15 @@ msgstr "Nun klicke auf “Verbinden” im Jamulus-Hauptfenster, um einem Server

#. type: Plain text
#: ../wiki/en/Getting-Started.md:68
#, no-wrap
#, fuzzy, no-wrap
#| msgid ""
#| "<figure>\n"
#| " <img src=\"{{site.url}}/assets/img/en-screenshots/connection-setup-window.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
#| " <figcaption>Connect to a server</figcaption>\n"
#| "</figure>\n"
msgid ""
"<figure>\n"
" <img src=\"{{site.url}}/assets/img/en-screenshots/connection-setup-window.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <img src=\"{% include img/en-screenshots/connection-setup-window.inc %}\" loading=\"lazy\" alt=\"Screenshot of the connection window\" style=\"border: 5px solid grey;\">\n"
" <figcaption>Connect to a server</figcaption>\n"
"</figure>\n"
msgstr ""
Expand Down Expand Up @@ -223,10 +238,15 @@ msgstr "Wenn die Audioeinstellungen fertig sind, kannst du loslegen. Nachdem du

#. type: Plain text
#: ../wiki/en/Getting-Started.md:81
#, no-wrap
#, fuzzy, no-wrap
#| msgid ""
#| "<figure>\n"
#| " <img src=\"{{site.url}}/assets/img/en-screenshots/main-screen-medium.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
#| " <figcaption>The main window when you are connected to a sever</figcaption>\n"
#| "</figure>\n"
msgid ""
"<figure>\n"
" <img src=\"{{site.url}}/assets/img/en-screenshots/main-screen-medium.png\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <img src=\"{% include img/en-screenshots/main-screen-medium.inc %}\" loading=\"lazy\" alt=\"Screenshot\" style=\"border: 5px solid grey;\">\n"
" <figcaption>The main window when you are connected to a sever</figcaption>\n"
"</figure>\n"
msgstr ""
Expand Down
2 changes: 1 addition & 1 deletion _translator-files/po/de/Include-Client-Commands.po
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ msgstr ""
#. type: Plain text
#: ../wiki/en/Include-Client-Commands.md:6
#, no-wrap
msgid "`--ctrlmidich` MIDI controller channel to listen on, control number offset and consecutive CC numbers (channels). Format: `channel[;f*][;p*][;s*][;m*]` See [Tips & Tricks](Tips-Tricks-More#using-ctrlmidich-for-midi-controllers) \n"
msgid "`--ctrlmidich` MIDI controller channel to listen on, control number offset and consecutive CC numbers (channels) and Mute Myself CC number. Format: `channel[;f*][;p*][;s*][;m*][;o]` See [Tips & Tricks](Tips-Tricks-More#using-ctrlmidich-for-midi-controllers) \n"
msgstr ""

#. type: Plain text
Expand Down
84 changes: 52 additions & 32 deletions _translator-files/po/de/Running-a-Server.po
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ msgstr ""
#, no-wrap
msgid ""
"<figure>\n"
"\t<img src=\"{{site.url}}/assets/img/en-screenshots/diagram-public-server.png\" loading=\"lazy\" alt=\"Diagram of connections between clients within a Jamulus Public Server\">\n"
"\t<img src=\"{% include img/en-screenshots/diagram-public-server.inc %}\" loading=\"lazy\" alt=\"Diagram of connections between clients within a Jamulus Public Server\">\n"
"<figcaption>How Public Servers work</figcaption>\n"
"</figure>\n"
msgstr ""
Expand All @@ -208,7 +208,7 @@ msgstr ""
#, no-wrap
msgid ""
"<figure>\n"
"\t<img src=\"{{site.url}}/assets/img/en-screenshots/diagram-private-server.png\" loading=\"lazy\" alt=\"Diagram of connections between clients within a Jamulus Private Server\">\n"
"\t<img src=\"{% include img/en-screenshots/diagram-private-server.inc %}\" loading=\"lazy\" alt=\"Diagram of connections between clients within a Jamulus Private Server\">\n"
"\t<figcaption>How Private Servers work</figcaption>\n"
"</figure>\n"
msgstr ""
Expand Down Expand Up @@ -328,7 +328,7 @@ msgstr ""
msgid ""
"There is one upstream (musician sending to the server) and one downstream (server sending back the mix to the musician)\n"
"<figure>\n"
"\t<img src=\"{{site.url}}/assets/img/en-screenshots/bandwidth-diagram.png\" loading=\"lazy\" alt=\"A diagram of Jamulus network bandwidths from different audio qualities ranging from low to high\">\n"
"\t<img src=\"{% include img/en-screenshots/bandwidth-diagram.inc %}\" loading=\"lazy\" alt=\"A diagram of Jamulus network bandwidths from different audio qualities ranging from low to high\">\n"
"<figcaption>Calculate bandwidth use </figcaption>\n"
"</figure>\n"
msgstr ""
Expand Down Expand Up @@ -368,7 +368,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:152
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/server-window-setup.png\" style=\"width:80%; border:5px solid grey;\" loading=\"lazy\" alt=\"Image of the Jamulus server setup window\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/server-window-setup.inc %}\" style=\"width:80%; border:5px solid grey;\" loading=\"lazy\" alt=\"Image of the Jamulus server setup window\"></figure>"
msgstr ""

#. type: Plain text
Expand Down Expand Up @@ -423,7 +423,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:177
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/server-window-options.png\" style=\"width:80%; border:5px solid grey;\" loading=\"lazy\" alt=\"Image of Jamulus server window options\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/server-window-options.inc %}\" style=\"width:80%; border:5px solid grey;\" loading=\"lazy\" alt=\"Image of Jamulus server window options\"></figure>"
msgstr ""

#. type: Plain text
Expand Down Expand Up @@ -473,100 +473,120 @@ msgstr ""
msgid "**Windows users** - If you want the server to start automatically on system start, enable the corresponding check box.\n"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:198
msgid "### Server status icon"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:200
msgid "# Running a Private Server"
msgid "When the Server is running, the operating system will show an icon in the system tray or status area to represent whether the Server is active:"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:202
msgid "It is highly recommended to test your server in **public mode first** so as to narrow down any subsequent problems in private mode."
msgid "<figure><img src=\"{% include img/en-screenshots/server-inactive.inc %}\" style=\"float:left; margin-right:10px;\" loading=\"lazy\" alt=\"Image of the Jamulus Server icon\"></figure> The Server is empty"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:204
msgid "<figure><img src=\"{% include img/en-screenshots/server-active.inc %}\" style=\"float:left; margin-right:10px;\" loading=\"lazy\" alt=\"Image of the Jamulus Server icon\"></figure> The Server is occupied"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:208
msgid "# Running a Private Server"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:210
msgid "It is highly recommended to test your server in **public mode first** so as to narrow down any subsequent problems in private mode."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:212
msgid "### Port forwarding"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:206
#: ../wiki/en/Running-a-Server.md:214
msgid "Normally, people from outside your home network cannot see things inside it. So if you want to operate a Jamulus server at home, you need to open a hole in your router to let Jamulus clients connect to it."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:208
#: ../wiki/en/Running-a-Server.md:216
#, no-wrap
msgid "**The default port for the current version of Jamulus is UDP (not TCP) port 22124.**\n"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:210
#: ../wiki/en/Running-a-Server.md:218
msgid "The exact setup of port forwarding differs for every router. For help see [portforward.com](https://portforward.com)."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:212
#: ../wiki/en/Running-a-Server.md:220
msgid "Once you have your router set up, you can get your external (WAN) IP address e.g. by [using Google](https://www.google.com/search?q=what+is+my+ip). Give this address to your friends so they can connect to your server (_but see also the note on dynamic DNS below_). You yourself have to connect to your own computer instead, since your computer runs the server. Therefore **only you** need to connect to `127.0.0.1`."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:214
#: ../wiki/en/Running-a-Server.md:222
msgid "## Dynamic DNS and why you will probably need it"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:216
#: ../wiki/en/Running-a-Server.md:224
msgid "Most domestic Internet connections will change their IP address after a period (hours, days or weeks). To make it easier for people to connect to you, you may therefore also want set up a dynamic DNS address. You can do this on [the machine](https://www.online-tech-tips.com/computer-tips/ddns-dynamic-dns-service/) that you are running the Jamulus server on, or preferably your router [may support it](https://www.noip.com/support/knowledgebase/how-to-configure-ddns-in-router/)."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:218
#: ../wiki/en/Running-a-Server.md:226
msgid "Note also that your home router may also change the IP address of the machine that you are running your server on. In which case you may need either to give that machine a static IP in the router's DHCP configuration, or simply port forward to all the addresses in your LAN."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:220
#: ../wiki/en/Running-a-Server.md:228
msgid "# Running a headless Linux server"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:222
#: ../wiki/en/Running-a-Server.md:230
#, no-wrap
msgid "Those wishing to run a server on a Linux cloud or other third party hosting platform should [read this guide](Server-Linux). \n"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:224
#: ../wiki/en/Running-a-Server.md:232
msgid "# Backing up the server"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:226
#: ../wiki/en/Running-a-Server.md:234
msgid "_Note that headless servers do not use `.ini` files. All configuration is given as command line options._"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:228
#: ../wiki/en/Running-a-Server.md:236
msgid "{% include_relative Include-Backing-Up.md %}"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:230
#: ../wiki/en/Running-a-Server.md:238
msgid "# Command line options"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:232
#: ../wiki/en/Running-a-Server.md:240
msgid "Most common functions in Jamulus can be set using the GUI, but these and others can also be set using options given in a terminal window. Exactly how you do this will depend on your operating system."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:234
#: ../wiki/en/Running-a-Server.md:242
msgid "For example on Windows, to use a specific settings file, right-click on the Jamulus shortcut and choose \"Properties\" > Target. Add the necessary arguments to Jamulus.exe:"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:238
#: ../wiki/en/Running-a-Server.md:246
#, no-wrap
msgid ""
"```shell\n"
Expand All @@ -575,12 +595,12 @@ msgid ""
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:240
#: ../wiki/en/Running-a-Server.md:248
msgid "For macOS, start a Terminal window and run Jamulus with the desired options like this:"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:244
#: ../wiki/en/Running-a-Server.md:252
#, no-wrap
msgid ""
"```shell\n"
Expand All @@ -589,37 +609,37 @@ msgid ""
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:246
#: ../wiki/en/Running-a-Server.md:254
#, no-wrap
msgid "**Note**: Command line options will set the server's defaults at startup. You can override them with their corresponding GUI controls while the server is running.\n"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:248
#: ../wiki/en/Running-a-Server.md:256
msgid "{% include_relative Include-Server-Commands.md %}"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:250
#: ../wiki/en/Running-a-Server.md:258
msgid "{% include_relative Include-Shared-Commands.md %}"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:252
#: ../wiki/en/Running-a-Server.md:260
msgid "{% include_relative Include-QOS-Windows.md %}"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:255
#: ../wiki/en/Running-a-Server.md:263
msgid "# Troubleshooting"
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:257
#: ../wiki/en/Running-a-Server.md:265
msgid "Various problems can arise when setting up servers, and we generally ecourage people to use other people's (public) servers at first to isolate any issues that may in fact be due to client configuration."
msgstr ""

#. type: Plain text
#: ../wiki/en/Running-a-Server.md:258
#: ../wiki/en/Running-a-Server.md:266
msgid "If you are having problems, [see this guide](Server-Troubleshooting)."
msgstr ""
Loading

0 comments on commit ef9ba92

Please sign in to comment.