Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Server UI Changes #677

Closed
wants to merge 41 commits into from
Closed
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
bddd3a3
Merge release into next-release
github-actions[bot] Dec 31, 2021
b54937f
Merge release into next-release
github-actions[bot] Dec 31, 2021
64a94dc
Merge release into next-release
github-actions[bot] Dec 31, 2021
9ae7cf4
Merge release into next-release
github-actions[bot] Dec 31, 2021
95a798c
Merge release into next-release
github-actions[bot] Jan 2, 2022
c957ff8
Move to use GH user-images (#671)
gilgongo Jan 5, 2022
ead8e12
AUTO: Updated .po files
github-actions[bot] Jan 5, 2022
b3d344f
Initial changes for Server Types section
gilgongo Jan 9, 2022
c602274
Comment
gilgongo Jan 9, 2022
33ff1e3
Wider changes
gilgongo Jan 9, 2022
fdde035
More modifictions and additions.
gilgongo Jan 9, 2022
df4dfca
Revisions
gilgongo Jan 9, 2022
61ffa90
Revisions
gilgongo Jan 9, 2022
bfa7f3d
Revisions
gilgongo Jan 9, 2022
70fdb26
Add reference to port forwarding
gilgongo Jan 9, 2022
499127f
Remove "URL"
gilgongo Jan 9, 2022
a87871a
Revisions
gilgongo Jan 9, 2022
be40e19
Revisions
gilgongo Jan 9, 2022
ec0ad74
Revisions
gilgongo Jan 9, 2022
48d6075
Revisions
gilgongo Jan 9, 2022
19b14dc
Update wiki/en/Running-a-Server.md
gilgongo Jan 9, 2022
e58aa56
Merge release into next-release
github-actions[bot] Jan 10, 2022
ab14025
Merge release into next-release
github-actions[bot] Jan 10, 2022
97911d3
Merge branch 'jamulussoftware:release' into server-ui
gilgongo Jan 12, 2022
a6dbda1
Add server tray icon
gilgongo Jan 12, 2022
9754c15
Remove low-quality item
gilgongo Jan 12, 2022
ebb9764
Connect window
gilgongo Jan 12, 2022
07c0722
Merge release into next-release
github-actions[bot] Jan 12, 2022
b7be044
Merge release into next-release
github-actions[bot] Jan 12, 2022
a2ba7f2
Merge branch 'jamulussoftware:release' into server-ui
gilgongo Jan 16, 2022
f8850eb
Seprate Custom Directory guide
gilgongo Jan 16, 2022
253b386
Consistent case
gilgongo Jan 16, 2022
5e9f660
Fix typo
gilgongo Jan 16, 2022
4547b19
Add link to #server-types
gilgongo Jan 16, 2022
466ed41
Update Software-Manual.md
gilgongo Jan 16, 2022
b3c36c4
Merge release into next-release
github-actions[bot] Jan 16, 2022
369eec9
Re-write usage description
gilgongo Jan 16, 2022
9598bbd
Merge release into next-release
github-actions[bot] Jan 19, 2022
bd6e98c
Merge branch 'jamulussoftware:release' into server-ui
gilgongo Jan 22, 2022
5ef9555
Merge branch 'next-release' into server-ui
gilgongo Jan 22, 2022
5bc98b9
Merge branch 'jamulussoftware:release' into server-ui
gilgongo Feb 6, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 "Wenn du Jamulus öffnest, siehst du ein Fenster, welches so aussieht:"

#. 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 @@ -151,10 +156,15 @@ msgstr "Lasse zuerst die anderen Teilnehmer wissen, wer du bist. Klick auf “An

#. 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 @@ -193,10 +203,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 @@ -227,10 +242,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
10 changes: 5 additions & 5 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
22 changes: 11 additions & 11 deletions _translator-files/po/de/Software-Manual.po
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ msgstr ""
#, no-wrap
msgid ""
"<figure>\n"
"\t<img src=\"{{site.url}}/assets/img/en-screenshots/main-screen-medium.png\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of the Jamulus main window\">\n"
"\t<img src=\"{% include img/en-screenshots/main-screen-medium.inc %}\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of the Jamulus main window\">\n"
"\t<figcaption>Your local mix when connected to a Server</figcaption>\n"
"</figure>\n"
msgstr ""
Expand All @@ -110,7 +110,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Software-Manual.md:36
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/led-green.png\" style=\"float:left; margin-right:10px;\" loading=\"lazy\" alt=\"Image of a green LED symbol\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/led-green.inc %}\" style=\"float:left; margin-right:10px;\" loading=\"lazy\" alt=\"Image of a green LED symbol\"></figure>"
msgstr ""

#. type: Plain text
Expand All @@ -121,7 +121,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Software-Manual.md:40
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/led-yellow.png\" style=\"float:left; margin-right:10px;\" loading=\"lazy\" alt=\"Image of a yellow LED symbol\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/led-yellow.inc %}\" style=\"float:left; margin-right:10px;\" loading=\"lazy\" alt=\"Image of a yellow LED symbol\"></figure>"
msgstr ""

#. type: Plain text
Expand All @@ -132,7 +132,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Software-Manual.md:44
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/led-red.png\" style=\"float:left; margin-right:10px; clear: both;\" loading=\"lazy\" alt=\"Image of a green red symbol\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/led-red.inc %}\" style=\"float:left; margin-right:10px; clear: both;\" loading=\"lazy\" alt=\"Image of a green red symbol\"></figure>"
msgstr ""

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

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

#. type: Plain text
Expand All @@ -244,7 +244,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Software-Manual.md:94
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/mixer-channles.png\" style=\"float:left; margin-right:10px; margin-bottom:20px; border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of a pair of server mixer controls\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/mixer-channels.inc %}\" style=\"float:left; margin-right:10px; margin-bottom:20px; border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of a pair of server mixer controls\"></figure>"
msgstr ""

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

#. type: Plain text
#: ../wiki/en/Software-Manual.md:132
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/settings-profile.png\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of a profile window\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/settings-profile.inc %}\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of a profile window\"></figure>"
msgstr ""

#. type: Plain text
Expand All @@ -344,7 +344,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Software-Manual.md:136
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/profile-tooltip.png\" style=\"width:30%;\" loading=\"lazy\" alt=\"Image of a tooltip showing profile information\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/profile-tooltip.inc %}\" style=\"width:30%;\" loading=\"lazy\" alt=\"Image of a tooltip showing profile information\"></figure>"
msgstr ""

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

#. type: Plain text
#: ../wiki/en/Software-Manual.md:148
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/settings-network.png\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of audio/network settings window\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/settings-network.inc %}\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of audio/network settings window\"></figure>"
msgstr ""

#. type: Plain text
Expand All @@ -394,7 +394,7 @@ msgstr ""

#. type: Plain text
#: ../wiki/en/Software-Manual.md:157
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/channel-mapping.png\" style=\"float:left; margin-right:10px; margin-bottom:20px;\" loading=\"lazy\" alt=\"Image of Input and output channel mapping\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/channel-mapping.inc %}\" style=\"float:left; margin-right:10px; margin-bottom:20px;\" loading=\"lazy\" alt=\"Image of Input and output channel mapping\"></figure>"
msgstr ""

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

#. type: Plain text
#: ../wiki/en/Software-Manual.md:234
msgid "<figure><img src=\"{{site.url}}/assets/img/en-screenshots/settings-advanced.png\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of advanced settings window\"></figure>"
msgid "<figure><img src=\"{% include img/en-screenshots/settings-advanced.inc %}\" style=\"border: 5px solid grey;\" loading=\"lazy\" alt=\"Image of advanced settings window\"></figure>"
msgstr ""

#. type: Plain text
Expand Down
8 changes: 4 additions & 4 deletions _translator-files/po/es/FAQ.po
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
msgid ""
msgstr ""
"Project-Id-Version: \n"
"PO-Revision-Date: 2021-12-21 10:41+0100\n"
"PO-Revision-Date: 2022-01-03 16:12+0000\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: es\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Generator: Poedit 2.3\n"
"X-Generator: Poedit 3.0\n"

#. type: YAML Front Matter: lang
#: ../wiki/en/FAQ.md:1
Expand Down Expand Up @@ -167,8 +167,8 @@ msgstr "¿Cómo funciona Jamulus (en general)?"

#. 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\">"
msgstr "<img src=\"{{site.url}}/assets/img/es-screenshots/diagram-overview.png\" loading=\"lazy\" alt=\"Diagrama mostrando cómo funciona Jamulus\">"
msgid "<img src=\"{% include img/en-screenshots/diagram-overview.inc %}\" loading=\"lazy\" alt=\"Diagram showing how Jamulus works\">"
msgstr "<img src=\"{% include img/es-screenshots/diagram-overview.inc %}\" loading=\"lazy\" alt=\"Diagrama mostrando cómo funciona Jamulus\">"

#. type: Plain text
#: ../wiki/en/FAQ.md:61
Expand Down
Loading