Skip to content

Commit

Permalink
Merge pull request #272 from ikedas/sympa-6.2 by ikedas
Browse files Browse the repository at this point in the history
Let help content location independent
  • Loading branch information
ikedas authored Apr 21, 2018
2 parents fb306b1 + 1eca5ab commit 08c0427
Show file tree
Hide file tree
Showing 42 changed files with 11,457 additions and 7,719 deletions.
10 changes: 5 additions & 5 deletions default/web_tt2/help.tt2
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@

<p>[%|helploc%]In this documentation, you will find:[%END%]</p>
<ul>
<li>[%|helploc(path_cgi)%]a <a href="%1/help/introduction">general introduction</a> to mailing lists;[%END%]</li>
<li>[%|helploc(path_cgi)%]a <a href="%1/help/user">user guide</a> about the use of Sympa;[%END%]</li>
<li>[%|helploc(path_cgi)%]an <a href="%1/help/admin">administrator guide</a> about the use of Sympa.[%END%]</li>
<li>[%|helploc%]a <a href="introduction">general introduction</a> to mailing lists;[%END%]</li>
<li>[%|helploc%]a <a href="user">user guide</a> about the use of Sympa;[%END%]</li>
<li>[%|helploc%]an <a href="admin">administrator guide</a> about the use of Sympa.[%END%]</li>
</ul>

<p>[%|helploc(path_cgi)%]If you want to perform a particular task, take a look at the list of all <a href="%1/help/introduction#features">available features</a> in the mailing list management software Sympa.[%END%]<br />
[%|helploc(path_cgi)%]If you experience any problem, please refer to the <a href="%1/help/faquser">users <acronym title="Frequently asked questions">FAQ</acronym></a> or to the <a href="%1/help/faqadmin">administrators <acronym title="Frequently asked questions">FAQ</acronym></a>.[%END%]</p>
<p>[%|helploc%]If you want to perform a particular task, take a look at the list of all <a href="introduction#features">available features</a> in the mailing list management software Sympa.[%END%]<br />
[%|helploc%]If you experience any problem, please refer to the <a href="faquser">users <acronym title="Frequently asked questions">FAQ</acronym></a> or to the <a href="faqadmin">administrators <acronym title="Frequently asked questions">FAQ</acronym></a>.[%END%]</p>

[% END %]

Expand Down
28 changes: 14 additions & 14 deletions default/web_tt2/help_admin.tt2
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
<li><strong>[%|helploc%]moderator;[%END%]</strong></li>
<li><strong>[%|helploc%]subscriber.[%END%]</strong></li>
</ul>
<p>[%|helploc(path_cgi)%]Refer to the <a href="%1/help/introduction#roles">description of each role</a> to know more about this.[%END%]</p>
<p>[%|helploc%]Refer to the <a href="introduction#roles">description of each role</a> to know more about this.[%END%]</p>

<h3><a name="create_list"></a>[%|helploc%]Requesting the creation of a mailing list[%END%]</h3>
<p>[%|helploc%]The <strong>list creation request</strong> can be <strong>subject to conditions</strong>. Even though you meet those conditions, the <strong>list creation</strong> will nevertheless be <strong>subject to approval by the listmasters</strong>.[%END%]</p>
<p>[%|helploc%]To request the creation of a mailing list, do as follows:[%END%]</p>
<ol>
<li>[%|helploc(path_cgi)%]Go to the <strong><a href="%1/home">list environment homepage</a></strong> and <a href="%1/help/user#sympa_auth"><strong>log on</strong></a>.[%END%]</li>
<li>[%|helploc%]Go to the <strong><a href="../home">list environment homepage</a></strong> and <a href="user#sympa_auth"><strong>log on</strong></a>.[%END%]</li>
<li>[%|helploc%]In the top menu, <strong>click on the 'Create list' link</strong>.[%END%]<br/>
<span class="retraitita">[%|helploc%]If this link does not display, it means that you do not have the privileges required to create a list.[%END%]</span></li>
<li>[%|helploc('',domain)%]Give your list a <strong>name</strong> (only enter the name without the '@' and the domain name; example: <em class="example">languages_spanish</em> and not <em class="example">languages_spanish@%2</em>).[%END%]<br />
Expand Down Expand Up @@ -48,7 +48,7 @@

<p>[%|helploc%]To manage a list you own, do as follows:[%END%]</p>
<ol>
<li>[%|helploc(path_cgi)%]Go to the <strong>list environment homepage</strong> and <strong><a href="%1/help/user#sympa_auth">log on</a></strong>.[%END%]<br />
<li>[%|helploc%]Go to the <strong>list environment homepage</strong> and <strong><a href="user#sympa_auth">log on</a></strong>.[%END%]<br />
<p class="retraitita">[%|helploc%]If you are subscribed to the list with several addresses, use the address with which you requested the list creation.[%END%]</p></li>
<li>[%|helploc%]<strong>Go to the information page of the list</strong> you want to manage.[%END%]</li>
<li>[%|helploc%]In the left menu, <strong>click on the 'Admin' link</strong>.[%END%]</li>
Expand All @@ -57,7 +57,7 @@
<p>[%|helploc%]To browse the sections of the administration module, click on the links below the 'Admin' link, in the left menu.[%END%]</p>
<p>[%|helploc%]Those different sections allow you to:[%END%]</p>
<ul>
<li>[%|helploc(path_cgi)%]<a href="%1/help/listconfig">configure the list</a>;[%END%]</li>
<li>[%|helploc%]<a href="listconfig">configure the list</a>;[%END%]</li>
<li>[%|helploc%]<a href="#customize">customize files related to the list</a>;[%END%]</li>
<li>[%|helploc%]<a href="#manage_members">manage subscribers</a>;[%END%]</li>
<li>[%|helploc%]<a href="#manage_archives">manage the message archive of the list</a>;[%END%]</li>
Expand All @@ -70,12 +70,12 @@
<p>[%|helploc%]The options available in the 'Moderate' submenu allow you to:[%END%]
<ul>
<li>[%|helploc%]<a href="#moderate">moderate messages</a> sent to the list;[%END%]</li>
<li>[%|helploc(path_cgi)%]<a href="%1/help/shared">moderate documents</a> available in the shared document web space;[%END%]</li>
<li>[%|helploc%]<a href="shared">moderate documents</a> available in the shared document web space;[%END%]</li>
<li>[%|helploc%]<a href="#manage_members">moderate pending subscriptions</a>.[%END%]</li>
</ul>

<h4><a name="edit_list"></a>[%|helploc%]Configuring the list[%END%]</h4>
<p>[%|helploc(path_cgi)%]To learn how to configure the list, please refer to the <a href="%1/help/listconfig"><strong>documentation about list configuration</strong></a>.[%END%]</p>
<p>[%|helploc%]To learn how to configure the list, please refer to the <a href="listconfig"><strong>documentation about list configuration</strong></a>.[%END%]</p>

<h4><a name="customize"></a>[%|helploc%]Customizing the list[%END%]</h4>
<p>[%|helploc%]From this page, you can <strong>edit a number of files relating to your list</strong>, among which:[%END%]</p>
Expand Down Expand Up @@ -107,11 +107,11 @@
<h4><a name="manage_shared"></a>[%|helploc%]Managing the shared document web space[%END%]</h4>
<p>[%|helploc%]By default, lists have no shared document web space. Thus, you need to create it. To do that, go to the <strong>list administration module</strong> and click on the '<strong>Create shared</strong>' link.[%END%]</p>

<p>[%|helploc(path_cgi)%]To allow subscribers to publish documents in the shared document web space, you need to <strong>change default rights</strong>: in the list administration module, click on '<strong>Edit list config</strong>' and then on '<strong>Privileges</strong>'. At the bottom of the page, there is a drop-down list entitled '<a href="%1/help/listconfig#docsrights"><strong>Who can edit</strong></a>'; choose the '<strong>Restricted to subscribers (private)</strong>' option.[%END%]</p>
<p class="retraitita">[%|helploc(path_cgi)%]Be careful: if you created folders before changing those rights, the folders will still be unwritable. If you want to make them writable, you will have to <a href="%1/help/shared#acces">change access rights</a> for each folder.[%END%]</p>
<p>[%|helploc(path_cgi)%]You might also want to <a href="%1/help/listconfig#docsrights">set up <strong>quotas</strong></a> for the shared document web space on the 'Privileges' page of the 'Edit list config' section.[%END%]</p>
<p>[%|helploc%]To allow subscribers to publish documents in the shared document web space, you need to <strong>change default rights</strong>: in the list administration module, click on '<strong>Edit list config</strong>' and then on '<strong>Privileges</strong>'. At the bottom of the page, there is a drop-down list entitled '<a href="listconfig#docsrights"><strong>Who can edit</strong></a>'; choose the '<strong>Restricted to subscribers (private)</strong>' option.[%END%]</p>
<p class="retraitita">[%|helploc%]Be careful: if you created folders before changing those rights, the folders will still be unwritable. If you want to make them writable, you will have to <a href="shared#acces">change access rights</a> for each folder.[%END%]</p>
<p>[%|helploc%]You might also want to <a href="listconfig#docsrights">set up <strong>quotas</strong></a> for the shared document web space on the 'Privileges' page of the 'Edit list config' section.[%END%]</p>

<p>[%|helploc(path_cgi)%]To <strong>know everything about the management of the shared document web space</strong> (how to organize it, change access rights, name documents, etc.), refer to the '<a href="%1/help/shared">Using the shared document web space</a>' section of the User guide.[%END%]</p>
<p>[%|helploc%]To <strong>know everything about the management of the shared document web space</strong> (how to organize it, change access rights, name documents, etc.), refer to the '<a href="shared">Using the shared document web space</a>' section of the User guide.[%END%]</p>
<p>[%|helploc%]To <strong>deny access to the shared document web space</strong>, click on '<strong>Delete shared</strong>' in the 'Admin' submenu. Then you will still have the possibility to <strong>reopen it</strong> by clicking on '<strong>Restore shared</strong>'. Deleting and restoring the shared document web space has <strong>no impact on the documents it contains</strong>.[%END%]</p>

<h4><a name="manage_members"></a>[%|helploc%]Managing subscribers[%END%]</h4>
Expand Down Expand Up @@ -148,7 +148,7 @@
<li>[%|helploc%]a <strong>link to the information page</strong> of the list;[%END%]</li>
<li>[%|helploc%]a <strong>clickable address in order to allow subscribers to unsubscribe</strong> from the list.[%END%]</li>
</ul>
<p class="retraitita">[%|helploc(path_cgi)%]You can also configure an automatic subscription reminder through the '<a href="%1/help/listconfig#other">Miscellaneous</a>' page of the 'Edit list config' section.[%END%]</p>
<p class="retraitita">[%|helploc%]You can also configure an automatic subscription reminder through the '<a href="listconfig#other">Miscellaneous</a>' page of the 'Edit list config' section.[%END%]</p>


<p>[%|helploc%]To <strong>unsubscribe subscribers</strong> from this page, select them by ticking the boxes in front of their names and click on the '<strong>Delete selected email addresses</strong>' button.[%END%]</p>
Expand All @@ -166,7 +166,7 @@
<li>[%|helploc%]the number or errors;[%END%]</li>
<li>[%|helploc%]the period during which errors occurred.[%END%]</li>
</ul>
<p>[%|helploc(path_cgi)%]You can <strong>check the latest error</strong> or <strong>reset errors</strong>. If you reset errors, the subscriber's <a href="%1/help/listconfig#bouncers">score</a> will be reset to zero.[%END%]</p>
<p>[%|helploc%]You can <strong>check the latest error</strong> or <strong>reset errors</strong>. If you reset errors, the subscriber's <a href="listconfig#bouncers">score</a> will be reset to zero.[%END%]</p>

<p>[%|helploc%]To manage bouncing addresses more easily, go to the '<a href="#manage_bounces">Bounces</a>' page of the list administration module.[%END%]</p>

Expand Down Expand Up @@ -198,8 +198,8 @@

<p>[%|helploc%]If you wish to customize the rejection message that is sent to a message author, you can do so via the '<strong>Manage rejection messages</strong>' button. The message management page will let define a set of rejection messages and define the default one.[%END%]</p>

<p>[%|helploc(path_cgi)%]<strong>Reminder</strong>: you can <a href="%1/help/listconfig#description">add or remove moderators</a> through the list administration module. To do that, from the list information page, click on '<strong>Admin</strong>', on '<strong>Edit list config</strong>', and then on '<strong>List definition</strong>'.[%END%]</p>
<p>[%|helploc(path_cgi)%]It is also possible to <strong>process messages after their distribution on the list</strong>; this can be useful when a list is not moderated. If you want to <strong>delete a message</strong>, <a href="%1/help/arc#arcsearch">search for it in the online message archive</a> and click on the '<strong>Tag this mail for deletion</strong>' button in the upper right corner of the message. A confirmation message displays; click on 'OK'. The message will be deleted after a few seconds. <strong>Be careful: this operation is irreversible!!! If you delete a message, you will not be able to retrieve it.</strong>[%END%]</p>
<p>[%|helploc%]<strong>Reminder</strong>: you can <a href="listconfig#description">add or remove moderators</a> through the list administration module. To do that, from the list information page, click on '<strong>Admin</strong>', on '<strong>Edit list config</strong>', and then on '<strong>List definition</strong>'.[%END%]</p>
<p>[%|helploc%]It is also possible to <strong>process messages after their distribution on the list</strong>; this can be useful when a list is not moderated. If you want to <strong>delete a message</strong>, <a href="arc#arcsearch">search for it in the online message archive</a> and click on the '<strong>Tag this mail for deletion</strong>' button in the upper right corner of the message. A confirmation message displays; click on 'OK'. The message will be deleted after a few seconds. <strong>Be careful: this operation is irreversible!!! If you delete a message, you will not be able to retrieve it.</strong>[%END%]</p>


<h4><a name="manage_archives"></a>[%|helploc%]Managing the message archive[%END%]</h4>
Expand Down
6 changes: 3 additions & 3 deletions default/web_tt2/help_arc.tt2
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<p>[%|helploc%]<strong>To read the list archive online</strong>, do as follows:[%END%]</p>
<ol>
<li>[%|helploc(path_cgi)%]Go to the list environment <strong><a href="%1/home">homepage</a></strong> and <strong>log on</strong>.[%END%]</li>
<li>[%|helploc%]Go to the list environment <strong><a href="../home">homepage</a></strong> and <strong>log on</strong>.[%END%]</li>
<li>[%|helploc%]<strong>Go to the information page of the list</strong> of which you want to read the archive.[%END%]</li>
<li>[%|helploc%]<strong>In the left menu, click on the 'Archive' link</strong>.[%END%]</li>
<li>[%|helploc%]The message index of the current month displays.[%END%]</li>
Expand Down Expand Up @@ -74,7 +74,7 @@ signoff * -->
<p><span class="remarque">[%|helploc%]Before starting to use the simple search mode, you should know that <a href="#advancedsearch">advanced search</a> is much more flexible than simple search and will suit your needs better if you do not know precisely what you are looking for.[%END%]</span></p>
<p>[%|helploc%]To perform a simple search, do as follows:[%END%]</p>
<ol>
<li>[%|helploc(path_cgi)%]Go to the list environment <strong><a href="%1/home">homepage</a></strong> and <strong>log on</strong>.[%END%]</li>
<li>[%|helploc%]Go to the list environment <strong><a href="../home">homepage</a></strong> and <strong>log on</strong>.[%END%]</li>
<li>[%|helploc%]<strong>Go to the information page of the list</strong> of your interest.[%END%]<br />
<span class="retraitita">[%|helploc%]It is impossible to perform a search in the archive of several lists at once. If you want to do it nevertheless, you will need to repeat the search for each list.[%END%]</span></li>
<li>[%|helploc%]In the left menu, <strong>click on the 'Archive' link</strong>. A message index page displays.[%END%]<br />
Expand All @@ -90,7 +90,7 @@ signoff * -->
<h5><a name="advancedsearch"></a>[%|helploc%]Performing a search with the advanced search mode[%END%]</h5>
<p>[%|helploc%]As the advanced search mode is much more powerful and flexible than the simple search mode, it is much easier to use. To perform an advanced search, do as follows:[%END%]</p>
<ol>
<li>[%|helploc(path_cgi)%]Go to the list environment <strong><a href="%1/home">homepage</a></strong> and <strong>log on</strong>.[%END%]</li>
<li>[%|helploc%]Go to the list environment <strong><a href="../home">homepage</a></strong> and <strong>log on</strong>.[%END%]</li>
<li>[%|helploc%]<strong>Go to the information page of the list</strong> of your interest.[%END%]<br />
<span class="retraitita">[%|helploc%]It is impossible to perform a search in the archive of several lists at once. If you want to do it nevertheless, you will need to repeat the search for each list.[%END%]</span></li>
<li>[%|helploc%]In the left menu, <strong>click on the 'Archive' link</strong>. A message index page displays.[%END%]<br />
Expand Down
4 changes: 2 additions & 2 deletions default/web_tt2/help_faq.tt2
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<div class="block">
<h2><i class="fa fa-question-circle"></i> [%|helploc%]User and admin FAQ[%END%]</h2>

<p>[%|helploc(path_cgi)%]If you want to perform a particular task, take a look at the list of all <a href="%1/help/introduction#features">available features</a> in the mailing list management software Sympa.[%END%]<br />
[%|helploc(path_cgi)%]If you experience any problem, please refer to the <a href="%1/help/faquser">users <acronym title="Frequently asked questions">FAQ</acronym></a> or to the <a href="%1/help/faqadmin">administrators <acronym title="Frequently asked questions">FAQ</acronym></a>.[%END%]</p>
<p>[%|helploc%]If you want to perform a particular task, take a look at the list of all <a href="introduction#features">available features</a> in the mailing list management software Sympa.[%END%]<br />
[%|helploc%]If you experience any problem, please refer to the <a href="faquser">users <acronym title="Frequently asked questions">FAQ</acronym></a> or to the <a href="faqadmin">administrators <acronym title="Frequently asked questions">FAQ</acronym></a>.[%END%]</p>

</div>

Expand Down
Loading

0 comments on commit 08c0427

Please sign in to comment.