Improved documentation

jamulussoftware · Oct 22, 2020 · b54ec61 · b54ec61
1 parent 548a3e6
commit b54ec61
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 19 deletions.
diff --git a/404.html b/404.html
@@ -12,7 +12,7 @@
   {% include headtags.html %}
 </head>
 
-<body>
+<body class="thissiteisgone">
   <header class="fx-row fx-row-between-xs fx-text-center">
     <div class="fx-col fx-text-center">
         <img alt="{{ site.data.general.nav.altJamulusIcon }}" width="40" height="40" src="{{ 'assets/img/jamulus-icon-2020.svg'| relative_url }}" />

diff --git a/README.md b/README.md
@@ -8,4 +8,4 @@ Built with Jekyll and Fox-CSS
 
 ## Contribute and translation
 
-Do you want to contribute to the Jamulus Wiki/Website? Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file and the [contributing wiki entry](https://jamulus.io/wiki/Contribution).
+Do you want to contribute to the Jamulus Wiki/Website? Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file and the [contributing wiki entry](https://jamulus.io/wiki/Contribution). Almost every folder includes a README.md file which explains its contents.
diff --git a/_data/README.md b/_data/README.md
@@ -1,11 +1,11 @@
-#_data folder
+# _data folder
 Includes jekyll data.
 
 currently used to translate the navigation in the wiki. See en/wiki/navigation.yml for structure.
 
 ## Translate new language
 
 * Copy folder en/ to yourlanguagecode/
-* Create translated yml files.
-* yourlanguagecode/wiki holds all data of the navigation
-* yourlanguagecode/general.yml holds data which is used around the page (currently only alt texts for the footer images)
+* Translate all files
+* yourlanguagecode/navigation.yml holds all data of the navigation
+* yourlanguagecode/general.yml holds data which is used all around the page
diff --git a/_includes/footer.html b/_includes/footer.html
@@ -21,10 +21,10 @@
   </div>
 </footer>
 <script>
-  var bl = window.navigator.language || window.navigator.userLanguage;
-  var dl = document.documentElement.lang;
-  var sl = "[{% for lng in site.languages %}'{{ lng }}',{% endfor %}]";
-  if (bl != dl && sl.includes(bl)) {
+  var ja = window.navigator.language || window.navigator.userLanguage;
+  var mu = document.documentElement.lang;
+  var lus = "[{% for lng in site.languages %}'{{ lng }}',{% endfor %}]";
+  if (ja != mu && lus.includes(ja)) {
     document.getElementById('langselect').classList.add('chlang');
     document.getElementById('suglang').style.display = "block";
   }

diff --git a/_layouts/README.md b/_layouts/README.md
@@ -1,7 +1,9 @@
-#_layouts
+# _layouts
 Holds layout (template) files.
 
 wiki.html main template for the wiki
+mainhomepage.html template for the homepage
+wikioverview.html template for the wiki overview site
 
-# Translate new language
+## Translate new language
 * You don't need to touch this folder.
diff --git a/assets/README.md b/assets/README.md
@@ -0,0 +1,5 @@
+# assets
+This folder contains images, css files and JavaScript files. If you want to change the style of this page you need to do your changes here. Otherwise this folder is not for you. Do not add images unrelated to the layout of the page here. Please use the GitHub provided upload feature instead.
+
+# Translate new language
+* You don't need to touch this folder.
diff --git a/wiki/README.md b/wiki/README.md
@@ -4,7 +4,9 @@ This folder holds all translated wiki pages sorted by language (en=English, es=S
 
 ## Translate
 
--   Copy the file you want to translate from e.g. en/ into the folder for your language code (es, de, ...).s
+-   Copy the file you want to translate from e.g. en/ into the folder for your language code (es, de, ...).
 -   set the lang: parameter to your language code in the front matter (between at the top of the file `---`) and make sure the permalink: parameter is the same.
-    ## Translate new language
+
+    ### Translate new language
+
     Copy e.g. the en/ folder, translate the content to your language, set the lang: attribute in the front matter of every file to lang: yourlanguagecode and move it into this folder. Don't touch the permalink since it links other pages in other languages to your language. You do **not** need to translate (and copy) every file since polyglot, the translation plugin, automatically includes a default language fallback for pages. However, you do need to create page translations in \_data/ (where the wiki navigation lives) and in \_includes. See the READEM.md files for short descriptions.
diff --git a/wiki/de/de-Getting-Started.md b/wiki/de/de-Getting-Started.md
@@ -11,9 +11,9 @@ permalink: "/wiki/Getting-Started"
 
 1. **Einen Computer** (*Windows 10*, *MacOS X* El Capitan (v10.11) oder neuer, *Linux*)
 1. **Eine kabelgebundene Internetverbindung** (LAN, *kein WLAN*. Sonst gibt es Tonprobleme). Keine LAN Buchse mehr? Versuche einen USB zu LAN Adapter! Die meisten Internetverbindungen sind ausreichend. Empfohlen mindestens 10MBit/s Download und 1MBit/s Upload ([vollständige Details hier](Quality,-delay-and-network-bandwidth)).
-1. **Kabelgebundene Kopfhörer - keine Lautsprecher** um Echo/Rückkopplungen zu vermeiden. Die Zeitverzögerung von Bluetooth-Kopfhörern ist normalerweise zu hoch. Deshalb solltest du einen kabelgebundenen Kopfhörer nutzen. Besonders beim Singen oder Spielen akustischer Instrumente sind Kopfhörer auch eine gute Hilfe um sicherzustellen, dass du mit anderen im Takt bleibst (siehe [diesen Hinweis](Getting-Started#schwierigkeiten-probleme-kannst-du-den-rhythmus-nicht-einhalten)).
+1. **Kabelgebundene Kopfhörer – keine Lautsprecher** um Echo/Rückkopplungen zu vermeiden. Die Zeitverzögerung von Bluetooth-Kopfhörern ist normalerweise zu hoch. Deshalb solltest du einen kabelgebundenen Kopfhörer nutzen. Besonders beim Singen oder Spielen akustischer Instrumente sind Kopfhörer auch eine gute Hilfe um sicherzustellen, dass du mit anderen im Takt bleibst (siehe [diesen Hinweis](Getting-Started#schwierigkeiten-probleme-kannst-du-den-rhythmus-nicht-einhalten)).
 
-### Empfohlen: ein Audio-Interface!
+### Empfohlen: ein Audiointerface!
 
 Obwohl du auch das eingebaute Mikrofon und damit die Soundkarte deines Computers nutzen kannst, ist die Qualität und Latenz von externen Soundkarten (Interfaces) normalerweise besser. Ein Audiointerface ist eine Box, an die du dein(e) Instrument(e) anschließen kannst. Normalerweise verbindet man ein Interface per USB mit deinem PC. Du kannst natürlich auch ein externes USB-Mikrofon probieren. Mehr Details findest du im [Hardware-Setup](Hardware-Setup).
 
@@ -58,4 +58,4 @@ Weitere Informationen darüber, wie du vermeiden kannst, auf dich selbst zu hör
 **Millionen von Menschen benutzen Jamulus um mit anderen Menschen auf der ganzen Welt in Echtzeit zu spielen, zu singen und Musik zu unterrichten. Das funktioniert ganz einfach:**
 
 ![Overview](https://user-images.githubusercontent.com/4561747/79309764-bd387280-7ef2-11ea-9d81-1e81302525e6.png)
-_Jamulus arbeitet nach dem Client-Server-Prinzip. Das Audiosignal von allen Teilnehmern wird an einen Server geschickt, dort gemischt und verarbeitet. Danach wird das Audio an jeden Client gesendet. Wenn ein Server öffentlich gemacht und auf einem zentralen Server registriert wird, werden seine Informationen an alle Clients gesendet._
+_Jamulus arbeitet nach dem Client-Server-Prinzip. Das Audiosignal von allen Musikern wird an einen Server geschickt, dort gemischt und verarbeitet. Danach wird das Audio an jeden Client gesendet. Wenn ein Server öffentlich gemacht und auf einem zentralen Server registriert wird, werden seine Informationen an alle Clients gesendet._
diff --git a/wiki/de/de-Installation-for-Macintosh.md b/wiki/de/de-Installation-for-Macintosh.md
@@ -20,9 +20,9 @@ Du kannst Jamulus auch selbst [kompilieren](Compiling), wenn du das willst.
 
 **Wenn du Jamulus zum ersten Mal öffnen willst, wirst du wahrscheinlich eine Meldung, dass Jamulus nicht geöffnet werden kann sehen, da der Entwickler unbekannt sei.**
 
-Um Jamulus trotzdem öffnen zu können, navigiere mit dem Finder in den Programme (Applications) Ordner, doppelklicke auf Jamulus, warte die Meldung ab, klicke dann mit der rechten Maustaste (oder Strg-Klick) auf Jamulus und wähle dann "Öffnen" oben im Menü aus.
+Um Jamulus trotzdem öffnen zu können, navigiere mit dem Finder in den Programme (Applications) Ordner, doppelklicke auf Jamulus, warte die Meldung ab, klicke dann mit der rechten Maustaste (oder Strg-Klick) auf Jamulus und wähle dann „Öffnen“ oben im Menü aus.
 
-Jetzt siehst du eine leicht veränderte Version der gleichen Nachricht, die es jetzt durch einen Klick auf "Öffnen" erlaubt, Jamulus zu öffnen. Diese Warnung wird nur einmal angezeigt - Sonst kann Jamulus ganz normal über das z.B. über das Launchpad geöffnet werden.
+Jetzt siehst du eine leicht veränderte Version der gleichen Nachricht, die es jetzt durch einen Klick auf „Öffnen“ erlaubt, Jamulus zu öffnen. Diese Warnung wird nur einmal angezeigt - Sonst kann Jamulus ganz normal über das z.B. über das Launchpad geöffnet werden.
 Für weitere Informationen siehe [diese Apple Support-Seite](https://support.apple.com/de-de/guide/mac-help/mh40616/mac).
 
 **Du kannst für weitere Infos auch diese [Anleitung](http://web.archive.org/web/20200406181452/https://www.facebook.com/notes/jamulus-online-musicianssingers-jamming/idiots-guide-to-jamulus-app/510044532903831/) von [Simon Tomlinson](https://www.facebook.com/simon.james.tomlinson?eid=ARBQoY3KcZAtS3pGdLJuqvQTeRSOo4gHdQZT7nNzOt1oPMGgZ4_3GERe-rOyH5PxsSHVYYXjWwcqd71a) (oder [direkt von Facebook](https://www.facebook.com/notes/jamulus-online-musicianssingers-jamming/idiots-guide-to-jamulus-app/510044532903831/)) anschauen.**
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ Built with Jekyll and Fox-CSS

		## Contribute and translation

		Do you want to contribute to the Jamulus Wiki/Website? Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file and the [contributing wiki entry](https://jamulus.io/wiki/Contribution).
		Do you want to contribute to the Jamulus Wiki/Website? Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file and the [contributing wiki entry](https://jamulus.io/wiki/Contribution). Almost every folder includes a README.md file which explains its contents.