Commit d147c74e authored by Lars Kruse's avatar Lars Kruse
Browse files

docs(matrix_chat): improve clarity

* use "GROUPRISE_SITE_NAME" instead of "grouprise instance"
* use "trimmed" translation blocks for simplified formatting
* mention matrix room `#grouprise-users:systemausfall.org`
parent 79abc0dd
Pipeline #3136 passed with stages
in 3 minutes and 54 seconds
......@@ -18,7 +18,7 @@
<ol>
<li><a href="#overview">{% trans "Overview" %}</a></li>
<li><a href="#matrix_features">{% trans "Matrix Features" %}</a></li>
<li><a href="#integration">{% trans "Integration with community website" %}</a></li>
<li><a href="#integration">{% blocktrans %}Integration with {{ GROUPRISE_SITE_NAME }}{% endblocktrans %}</a></li>
<li><a href="#usage">{% trans "Usage" %}</a></li>
<li><a href="#faq">{% trans "FAQ" %}</a></li>
</ol>
......@@ -26,23 +26,26 @@
<hr/>
<h1 id="overview">{% trans "Overview" %}</h1>
<p>{% blocktrans %}Sometimes it is useful to communicate directly and without delay in order to achieve a common goal.
Or it may be useful to direct interested people from the outside to an accessible and open communication room, where they can meet the people involved in a group or project.{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
Instant messagging (<i>chat</i>) is an efficient way of communicating directly (without delay) within a group or between interested people and group members.
{% endblocktrans %}</p>
<p>{% blocktrans %}<i>Chat</i> or <i>Instant Messaging</i> can be a useful tool under these circumstances.{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
The platform {{ GROUPRISE_SITE_NAME }} provides an integrated chat service, which can be used for internal communication as well as for communication with other users of this chat protocol (<a href="{{ matrix_url }}">Matrix</a>) worldwide.
{% endblocktrans %}</p>
<p>{% blocktrans %}A wide variety of instant messenger applications and protocols is available, e.g. Jabber, IRC, Whatsapp, Facebook Messenger, Slack, Mattermost and many more.
<i>Grouprise</i> integrates the <a href="{{ matrix_url }}">Matrix</a> protocol, since it offers a wide range of features, that turn it into a perfect fit for this platform.
These features are detailed below.{% endblocktrans %}</p>
<ul>
<li><b><a href="{{ grouprise_url }}">{% trans "grouprise" %}</a></b>: {% trans "The community website your are browsing right now is based on the grouprise software." %}</li>
<li><b><a href="{{ matrix_url }}">{% trans "Matrix" %}</a></b>: {% trans "Matrix is a decentral and federated chat communication protocol." %}</li>
</ul>
<p>{% blocktrans trimmed %}
Use the web client or a mobile app (see <a href="#usage">Usage</a>) for accessing the chat rooms.
{% endblocktrans %}</p>
<h1 id="matrix_features">{% trans "Matrix Features" %}</h1>
<p>{% blocktrans trimmed %}
A wide variety of instant messenger applications and protocols is available, e.g. Jabber, IRC, Whatsapp, Facebook Messenger, Slack, Mattermost and many more.
This platform ({{ GROUPRISE_SITE_NAME }}) integrates the <a href="{{ matrix_url }}">Matrix</a> protocol, since it offers a wide range of features, that turn it into a perfect fit.
{% endblocktrans %}</p>
<p>{% trans "Matrix offers the following features:" %}</p>
<ul>
<li><b>{% trans "trustworthy" %}</b>: {% trans 'Both the server and the client implementations are available as <a href="{{ free_software_url }}">Free Software</a>. Thus anyone interested can verify, that the software is operating in the interest of the users.' %}</li>
......@@ -52,13 +55,13 @@ These features are detailed below.{% endblocktrans %}</p>
</ul>
<h1 id="integration">{% trans "Integration with community website" %}</h1>
<h1 id="integration">{% blocktrans %}Integration with {{ GROUPRISE_SITE_NAME }}{% endblocktrans %}</h1>
<p>{% trans "The integration of the Matrix chat into a grouprise instance (this community website) offers the following features:" %}</p>
<p>{% blocktrans %}The integration of the Matrix chat into the {{ GROUPRISE_SITE_NAME }} platform offers the following features:{% endblocktrans %}</p>
<ul>
<li>{% trans "Use your grouprise user account (name and password) to log in to the Matrix homeserver. There is no need for a separate Matrix account." %}</li>
<li>{% blocktrans with matrix_client_url=matrix_client_path|full_url %}A local instance of the <a href="{{ element_url }}">Element web client</a> is provided along with the grouprise community website (<a href="{{ matrix_client_path }}">{{ matrix_client_url }}</a>).{% endblocktrans %}</li>
<li>{% trans "A public and a private Matrix room is automatically created for each grouprise group." %}</li>
<li>{% blocktrans with matrix_client_url=matrix_client_path|full_url %}A local instance of the <a href="{{ element_url }}">Element web client</a> is provided along with {{ GROUPRISE_SITE_NAME }} (<a href="{{ matrix_client_path }}">{{ matrix_client_url }}</a>).{% endblocktrans %}</li>
<li>{% blocktrans %}A public and a private Matrix room is automatically created for each {{ GROUPRISE_SITE_NAME }} group.{% endblocktrans %}</li>
<li>{% trans "All members of a grouprise group are automatically invited to the group's Matrix rooms." %}</li>
<li>{% trans "Notifications for new content (articles, events, discussions, ...) are sent to the related Matrix rooms (internal messages are announced in the private room, only)." %}</li>
</ul>
......@@ -81,7 +84,9 @@ These features are detailed below.{% endblocktrans %}</p>
<p>{% trans "There are two approaches for entering the chat rooms:" %}</p>
<ul>
<li>{% trans "Visit the page of a group and select <i>Public Chat Room</i> or <i>Private Chat Room</i>." %}</li>
<li>{% blocktrans with matrix_client_url=matrix_client_path|full_url %}Visit the URL <a href="{{ matrix_client_path }}">{{ matrix_client_url }}</a>.{% endblocktrans %}</li>
<li>{% blocktrans with matrix_client_url=matrix_client_path|full_url trimmed %}
Visit the URL <a href="{{ matrix_client_path }}">{{ matrix_client_url }}</a>.
{% endblocktrans %}</li>
</ul>
<p>{% trans "Enter your grouprise login (username and password) in the login dialog." %}</p>
......@@ -102,22 +107,40 @@ These features are detailed below.{% endblocktrans %}</p>
<h2>{% trans "Why is there a <i>public</i> and a <i>private</i> room?" %}</h2>
<p>{% blocktrans %}These pre-configured rooms for each group were prepared for your convenvience.
<p>{% blocktrans trimmed %}
These pre-configured rooms for each group were prepared for your convenvience.
The <i>public room</i> is configured to be open for random visitors.
Such rooms are visible in the public "room directory" (list of rooms hosted on the Matrix server).
A <i>private room</i> is not listed in the room directory of the server.
Interested people may only join private rooms after being invited by a current room member.{% endblocktrans %}</p>
Interested people may only join private rooms after being invited by a current room member.
{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
In addition to the two pre-configured rooms per group, your are free to create as many rooms as you like.
{% endblocktrans %}</p>
<h2>{% trans "Room members" %}</h2>
<p>{% blocktrans %}Whenever someone joins a group in the grouprise website, the corresponding matrix account of this new member automatically is invited to the public and the private Matrix room belonging to this group.{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
Whenever someone joins a group in the {{ GROUPRISE_SITE_NAME }} platform, the corresponding matrix account is automatically invited to this group's chat rooms.
{% endblocktrans %}</p>
<p>{% blocktrans %}People leaving a grouprise group are automatically removed from the group's Matrix rooms.{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
People leaving a group in the {{ GROUPRISE_SITE_NAME }} platform are automatically removed from the group's chat rooms.
{% endblocktrans %}</p>
<p>{% blocktrans %}Any external person (even people without an account on the local grouprise instance) may join public rooms or may be invited to private rooms.{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
Any external person (even people without an account on the local grouprise instance) may join public rooms or may be invited to private rooms.
{% endblocktrans %}</p>
<h2>{% trans "I want to know more!" %}</h2>
<p>{% blocktrans %}Feel free to dive into the <a href="{{ help_matrix_url }}">Matrix FAQ</a> or visit the <a href="{{ help_element_url }}">Element community room</a>, if you have further questions.{% endblocktrans %}</p>
<p>{% blocktrans trimmed %}
Feel free to dive into the <a href="{{ help_matrix_url }}">Matrix FAQ</a> or visit the <a href="{{ help_element_url }}">Element community room</a>, if you have further questions.
{% endblocktrans %}</p>
<p>{% blocktrans with room_name="@grouprise-users:systemausfall.org" trimmed %}
For questions regarding the combination of <i>grouprise</i> ({{ GROUPRISE_SITE_NAME }}) and Matrix, you are welcome to join the matrix room <code>{{ room_name }}</code>.
{% endblocktrans %}</p>
{% endblock %}
......@@ -414,8 +414,9 @@ msgstr "Überblick"
msgid "Matrix Features"
msgstr "Matrix-Funktionen"
msgid "Integration with community website"
msgstr "Integration in die Community-Webseite"
#, python-format
msgid "Integration with %(GROUPRISE_SITE_NAME)s"
msgstr "Integration in %(GROUPRISE_SITE_NAME)s"
msgid "Usage"
msgstr "Nutzung"
......@@ -424,56 +425,46 @@ msgid "FAQ"
msgstr "Häufige Fragen"
msgid ""
"Sometimes it is useful to communicate directly and without delay in order to "
"achieve a common goal.\n"
"Or it may be useful to direct interested people from the outside to an "
"accessible and open communication room, where they can meet the people "
"involved in a group or project."
"Instant messagging (<i>chat</i>) is an efficient way of communicating "
"directly (without delay) within a group or between interested people and "
"group members."
msgstr ""
"Chat (<i>Instant Messaging</i>) kann ein effektives Mittel zur direkten "
"(verzögerungsfreien) Kommunikation innerhalb einer Gruppe oder zwischen "
"Interessierten und Gruppenmitgliedern sein."
#, python-format
msgid ""
"The platform %(GROUPRISE_SITE_NAME)s provides an integrated chat service, "
"which can be used for internal communication as well as for communication "
"with other users of this chat protocol (<a href=\"%(matrix_url)s\">Matrix</"
"a>) worldwide."
msgstr ""
"Manchmal ist es hilfreich, direkt und ohne Zeitverzug mit anderen zu "
"kommunizieren, um ein gemeinsames Ziel zu erreichen.\n"
"Zudem kann es auf interessierte Außenstehende einladend wirken, direkten "
"Kontakten zu den Aktiven einer Gruppe in einem leicht zugänglichen "
"Kommunikationsraum aufnehmen zu können."
"Die Plattform %(GROUPRISE_SITE_NAME)s bietet einen integrierten Chat-Dienst, "
"der sowohl innerhalb von %(GROUPRISE_SITE_NAME)s als auch für den Austausch "
"mit <a href=\"%(matrix_url)s\">Matrix</a>-Nutzenden weltweit genutzt werden "
"kann."
msgid ""
"<i>Chat</i> or <i>Instant Messaging</i> can be a useful tool under these "
"circumstances."
"Use the web client or a mobile app (see <a href=\"#usage\">Usage</a>) for "
"accessing the chat rooms."
msgstr ""
"<i>Chats</i> oder <i>Sofortnachrichten</i> können unter diesen Umständen "
"nützliche Werkzeuge sein."
"Der Chat-Dienst ist über den Web-Client oder eine mobile App (siehe <a href="
"\"#usage\">Nutzung</a>) bedienbar."
#, python-format
msgid ""
"A wide variety of instant messenger applications and protocols is available, "
"e.g. Jabber, IRC, Whatsapp, Facebook Messenger, Slack, Mattermost and many "
"more.\n"
"<i>Grouprise</i> integrates the <a href=\"%(matrix_url)s\">Matrix</a> "
"protocol, since it offers a wide range of features, that turn it into a "
"perfect fit for this platform.\n"
"These features are detailed below."
"more. This platform (%(GROUPRISE_SITE_NAME)s) integrates the <a href="
"\"%(matrix_url)s\">Matrix</a> protocol, since it offers a wide range of "
"features, that turn it into a perfect fit."
msgstr ""
"Es gibt eine große Vielfalt von Chat-Anwendungen, wie beispielsweise Jabber, "
"IRC, Whatsapp, Facebook Messenger, Slack, Mattermost und viele mehr.\n"
"<i>Grouprise</i> integriert das <a href=\"%(matrix_url)s\">Matrix</a>-"
"Protokoll, da es vielerlei nützliche Funktionen zur Erweiterung der "
"grouprise-Plattform bietet.\n"
"Diese Funktionen werden weiter unten beschrieben."
msgid "grouprise"
msgstr "grouprise"
msgid ""
"The community website your are browsing right now is based on the grouprise "
"software."
msgstr ""
"Die Webseite, die du gerade liest, basiert auf der Software \"grouprise\"."
msgid "Matrix"
msgstr "Matrix"
msgid "Matrix is a decentral and federated chat communication protocol."
msgstr "Matrix ist ein dezentrales und föderiertes Kommunikationsprotokoll."
"IRC, Whatsapp, Facebook Messenger, Slack, Mattermost und viele mehr. Diese "
"Plattform (%(GROUPRISE_SITE_NAME)s) integriert das <a href=\"%(matrix_url)s"
"\">Matrix</a>-Protokoll, da es vielerlei nützliche Funktionen zur "
"Erweiterung der grouprise-Plattform bietet."
msgid "Matrix offers the following features:"
msgstr "Matrix bietet die folgenden Funktionen:"
......@@ -527,12 +518,13 @@ msgstr ""
"\"{{ matrix_clients_url }}\">Vielfalt von Anwendungen</a> für verschiedene "
"mobile und Desktop-Plattformen."
#, python-format
msgid ""
"The integration of the Matrix chat into a grouprise instance (this community "
"website) offers the following features:"
"The integration of the Matrix chat into the %(GROUPRISE_SITE_NAME)s platform "
"offers the following features:"
msgstr ""
"Die Integration des Matrix-Chats in eine grouprise-Instanz (diese Community-"
"Webseite) bietet die folgenden Funktionen:"
"Die Integration des Matrix-Chats in die %(GROUPRISE_SITE_NAME)s-Plattform "
"bietet die folgenden Funktionen:"
msgid ""
"Use your grouprise user account (name and password) to log in to the Matrix "
......@@ -544,19 +536,20 @@ msgstr ""
#, python-format
msgid ""
"A local instance of the <a href=\"%(element_url)s\">Element web client</a> "
"is provided along with the grouprise community website (<a href="
"is provided along with %(GROUPRISE_SITE_NAME)s (<a href="
"\"%(matrix_client_path)s\">%(matrix_client_url)s</a>)."
msgstr ""
"Eine lokale Instanz der <a href=\"%(element_url)s\">Element-Web-Anwendung</"
"a> wird zusammen mit der Community-Webseite ausgeliefert (<a href="
"a> wird zusammen mit %(GROUPRISE_SITE_NAME)s ausgeliefert (<a href="
"\"%(matrix_client_path)s\">%(matrix_client_url)s</a>)."
#, python-format
msgid ""
"A public and a private Matrix room is automatically created for each "
"grouprise group."
"%(GROUPRISE_SITE_NAME)s group."
msgstr ""
"Für jede grouprise-Gruppe wird automatisch ein öffentlicher und ein privater "
"Raum erzeugt."
"Für jede %(GROUPRISE_SITE_NAME)s-Gruppe wird automatisch ein öffentlicher "
"und ein privater Chat-Raum erzeugt."
msgid ""
"All members of a grouprise group are automatically invited to the group's "
......@@ -653,7 +646,7 @@ msgid "Select <i>Sign In</i>."
msgstr "Wähle <i>Anmelden</i>."
msgid "Enter your grouprise username or your email address."
msgstr "Gib deinen grouprise-Nutzername oder deine Emailadresse ein."
msgstr "Gib deinen grouprise-Nutzernamen oder deine Emailadresse ein."
msgid "Enter your grouprise password."
msgstr "Gib dein grouprise-Passwort ein."
......@@ -667,46 +660,52 @@ msgstr ""
msgid ""
"These pre-configured rooms for each group were prepared for your "
"convenvience.\n"
"The <i>public room</i> is configured to be open for random visitors.\n"
"Such rooms are visible in the public \"room directory\" (list of rooms "
"hosted on the Matrix server).\n"
"A <i>private room</i> is not listed in the room directory of the server.\n"
"Interested people may only join private rooms after being invited by a "
"current room member."
"convenvience. The <i>public room</i> is configured to be open for random "
"visitors. Such rooms are visible in the public \"room directory\" (list of "
"rooms hosted on the Matrix server). A <i>private room</i> is not listed in "
"the room directory of the server. Interested people may only join private "
"rooms after being invited by a current room member."
msgstr ""
"Diese vorkonfigurierten Räume für jede Gruppe wurden zur Vereinfachung "
"typischer Abläufe angelegt.\n"
"Der <i>öffentliche Raum</i> kann von zufälligen Besuchern auch ohne "
"Einladung betreten werden.\n"
"Solch ein Raum wird im öffentlich Raumverzeichnis des Servers aufgeführt.\n"
"Ein <i>interner Raum</i> ist nicht im Raumverzeichnis zu finden.\n"
"Interessierte können interne Räume nur auf Einladung betreten."
"typischer Abläufe angelegt. Der <i>öffentliche Raum</i> kann von zufälligen "
"Besuchern auch ohne Einladung betreten werden. Solch ein Raum wird im "
"öffentlichen Raumverzeichnis des Servers aufgeführt. Ein <i>interner Raum</"
"i> ist nicht im Raumverzeichnis zu finden. Interessierte können interne "
"Räume nur auf Einladung betreten."
msgid ""
"In addition to the two pre-configured rooms per group, your are free to "
"create as many rooms as you like."
msgstr ""
"Unabhängig von den beiden vorkonfigurierten Räumen pro Gruppe kannst du "
"so viele Räume anlegen, wie du möchtest."
msgid "Room members"
msgstr "Raum-Teilnehmer:innen"
#, python-format
msgid ""
"Whenever someone joins a group in the grouprise website, the corresponding "
"matrix account of this new member automatically is invited to the public and "
"the private Matrix room belonging to this group."
"Whenever someone joins a group in the %(GROUPRISE_SITE_NAME)s platform, the "
"corresponding matrix account is automatically invited to this group's chat "
"rooms."
msgstr ""
"Sobald jemand einer grouprise-Gruppe beitritt, wird der dazugehörige Matrix-"
"Account dieses neuen Mitglieds automatisch in den öffentlichen und den "
"privaten Matrix-Raum dieser Gruppe eingeladen."
"Sobald jemand einer Gruppe in der %(GROUPRISE_SITE_NAME)s-Plattform "
"beitritt, wird diese Person automatisch in die Chat-Räume dieser Gruppe "
"eingeladen."
#, python-format
msgid ""
"People leaving a grouprise group are automatically removed from the group's "
"Matrix rooms."
"People leaving a group in the %(GROUPRISE_SITE_NAME)s platform are "
"automatically removed from the group's chat rooms."
msgstr ""
"Sobald jemand eine grouprise-Gruppe verlässt, wird sein Matrix-Konto aus den "
"dazugehörigen Räumen entfernt."
"Sobald jemand eine Gruppe (%(GROUPRISE_SITE_NAME)s) verlässt, wird diese "
"Person auch aus den dazugehörigen Chat-Räumen entfernt."
msgid ""
"Any external person (even people without an account on the local grouprise "
"instance) may join public rooms or may be invited to private rooms."
msgstr ""
"Auch externe Personen (auch ohne ein Nutzerkonto der Community-Webseite) "
"Auch externe Personen (selbst ohne ein Nutzerkonto der Community-Webseite) "
"können öffentliche Räume betreten und in private Räume eingeladen werden."
msgid "I want to know more!"
......@@ -722,6 +721,16 @@ msgstr ""
"a> oder schau dich in den <a href=\"%(help_element_url)s\">Element-Räumen</"
"a> um, falls du weitere Fragen haben solltest."
#, python-format
msgid ""
"For questions regarding the combination of <i>grouprise</i> "
"(%(GROUPRISE_SITE_NAME)s) and Matrix, you are welcome to join the matrix "
"room <code>%(room_name)s</code>."
msgstr ""
"Der Matrix-Raum <code>%(room_name)s</code> ist der richtige Ort, falls du "
"Fragen zur Integration des Matrix-Chats in <i>grouprise</i> "
"(%(GROUPRISE_SITE_NAME)s) haben solltest."
msgid "Chat Settings - Matrix"
msgstr "Chat-Einstellungen (Matrix)"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment