Add 'id=<xx>' for each section in index page.

2016-06-06 23:29:23 +08:00 · 2016-06-06 23:29:23 +08:00 · 37ae4b3883
parent b66a8cd933
commit 37ae4b3883
13 changed files with 59 additions and 37 deletions
--- a/en_US/cluster/_title.md
+++ b/en_US/cluster/_title.md
@ -1 +1 @@
-Cluster
+Cluster {: #cluster }
--- a/en_US/faq/2-iredadmin-pro.restful.api.md
+++ b/en_US/faq/2-iredadmin-pro.restful.api.md
@ -7,12 +7,18 @@

 [TOC]

+### ChangeLog
+
+* Variable name `cn` has been renamed to `name`.
+* Variable names in returned JSON data has been changed to:
+  `{'_success': ..., '_msg': ...}` (was `{'success': ..., 'msg': ...}`).
+
 ## Summary

 iRedAdmin-Pro RESTful API will return message in JSON format.

-* If operation succeed, iRedAdmin-Pro returns JSON data: `{'success': true}`.
-* If operation failed, iRedAdmin-Pro returns JSON data: `{'success': false, 'msg': '<error_reason>'}`.
+* If operation succeed, iRedAdmin-Pro returns JSON data: `{'_success': true}`.
+* If operation failed, iRedAdmin-Pro returns JSON data: `{'_success': false, '_msg': '<error_reason>'}`.

 ## Requirements

@ -56,10 +62,6 @@ Notes:

 <button type="button" class="toggle_all">Expand/Collapse All API Parameters</button>

-### ChangeLog
-
-* Variable name `cn` has been renamed to `name`.
-
 ### Domain {: .toggle }

 <!--
@ -97,11 +99,14 @@ Notes:
    `quota` | Mailbox quota for whole domain, in MB. | `quota=2048`
    `language` | Default preferred language for newly created mail user | `language=en_US`
    `transport` | Transport program | `transport=dovecot`
-    `backupmx` | Mark domain as Backup MX | `backupmx=yes`
    `defaultQuota` | Default per-user mailbox quota for newly created user | `defaultQuota=1024`
    `maxUserQuota` | Max mailbox quota of a mail user | `maxUserQuota=2048`
    `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20`
    `numberOfAliases` | Max number of mail alias accounts | `numberOfAliases=30`
+    `senderBcc` | Per-domain sender bcc address | `senderBcc=user@domain.com`
+    `recipientBcc` | Per-domain recipient bcc address | `recipientBcc=user@domain.com`
+    `backupmx` | Mark domain as Backup MX. Must be used with parameter `primarymx`. Conflicts with `transport`. | `backupmx=yes` (or `no`)
+    `primarymx` | IP address of primary MX. Must be used with parameter `backupmx`. Conflicts with `transport`. | `primarymx=202.96.134.133`

    </div>

--- a/en_US/faq/_title.md
+++ b/en_US/faq/_title.md
@ -1 +1 @@
-Frequently Asked Questions
+Frequently Asked Questions {: #faq }
--- a/en_US/howto/_title.md
+++ b/en_US/howto/_title.md
@ -1 +1 @@
-How to
+How to {: #howto }
--- a/en_US/installation/_title.md
+++ b/en_US/installation/_title.md
@ -1 +1 @@
-Install iRedMail
+Install iRedMail {: #install }
--- a/en_US/integrations/_title.md
+++ b/en_US/integrations/_title.md
@ -1 +1 @@
-Third-party integrations
+Third-party integrations {: #integration }
--- a/en_US/migrations/_title.md
+++ b/en_US/migrations/_title.md
@ -1 +1 @@
-Migrations
+Migrations {: #migration }
--- a/en_US/mua/_title.md
+++ b/en_US/mua/_title.md
@ -1 +1 @@
-Configure mail client applications
+Configure mail client applications {: #mua }
--- a/en_US/overview/_title.md
+++ b/en_US/overview/_title.md
@ -1 +1 @@
-Overview
+Overview {: #overview }
--- a/en_US/troubleshooting/_title.md
+++ b/en_US/troubleshooting/_title.md
@ -1 +1 @@
-Troubleshooting and Debug
+Troubleshooting and Debug {: #troubleshooting }
--- a/en_US/upgrade/_title.md
+++ b/en_US/upgrade/_title.md
@ -1 +1 @@
-Release notes and upgrade tutorials
+Release notes and upgrade tutorials {: #upgrade }
--- a/html/index.html
+++ b/html/index.html
@ -21,7 +21,7 @@
 <li><a href="./used.components.html">Major open source softwares used in iRedMail, and big picture of mail flow</a></li>
 <li><a href="./network.ports.html">Which network ports are open by iRedMail</a></li>
 </ul>
-<h3 id="install-iredmail">Install iRedMail</h3>
+<h3 id="install">Install iRedMail</h3>
 <ul>
 <li>
 <p>Install iRedMail on:</p>
@ -49,7 +49,7 @@
 <p><a href="./performance.tuning.html">Performance tuning for a busy server</a></p>
 </li>
 </ul>
-<h3 id="configure-mail-client-applications">Configure mail client applications</h3>
+<h3 id="mua">Configure mail client applications</h3>
 <div class="admonition note">
 <p class="admonition-title">Quick MUA Settings</p>
 <ul>
@ -68,19 +68,19 @@
 <li><a href="sogo.macosx.contacts.html">Mac OS X: Add contact service (CardDAV) in Contacts.app</a></li>
 <li><a href="sogo.macosx.icalendar.html">Mac OS X: Add calendar (CalDAV) and task (Reminders) service in iCalendar.app</a></li>
 </ul>
-<h3 id="release-notes-and-upgrade-tutorials">Release notes and upgrade tutorials</h3>
+<h3 id="upgrade">Release notes and upgrade tutorials</h3>
 <ul>
 <li><a href="iredmail.releases.html">iRedMail release notes and upgrade tutorials</a></li>
 <li><a href="iredadmin-pro.releases.html">iRedAdmin-Pro (web-based admin panel) release notes and upgrade tutorials</a></li>
 <li><a href="iredapd.releases.html">iRedAPD (Postfix Access Policy Daemon) release notes and upgrade tutorials</a></li>
 </ul>
-<h3 id="migrations">Migrations</h3>
+<h3 id="migration">Migrations</h3>
 <ul>
 <li><a href="migrate.to.new.iredmail.server.html">Migrate old iRedMail server to the latest stable release</a></li>
 <li><a href="password.hashes.html">Password hashes</a></li>
 <li><a href="cluebringer.to.iredapd.html">Migrate from Cluebringer to iRedAPD</a></li>
 </ul>
-<h3 id="how-to">How to</h3>
+<h3 id="howto">How to</h3>
 <ul>
 <li><a href="allow.certain.users.to.send.email.as.different.user.html">Allow certain users to send email as another user</a></li>
 <li><a href="change.mail.attachment.size.html">Change mail attachment size</a></li>
@ -140,7 +140,7 @@
 <ul>
 <li><a href="http://www.iredmail.org/forum/topic8169-iredmail-support-antispam-via-dovecot-and-spamassassin.html">Anti-spam with Dovecot antispam plugin and SpamAssassin</a>, contributed by Dexus.</li>
 </ul>
-<h3 id="third-party-integrations">Third-party integrations</h3>
+<h3 id="integration">Third-party integrations</h3>
 <p>Below tutorials are maintained by iRedMail project.</p>
 <ul>
 <li>
@ -169,7 +169,7 @@
 <li><a href="./haproxy.keepalived.glusterfs.html">Build an iRedMail fail-over Cluster with KeepAlived, HAProxy, GlusterFS, OpenLDAP, Mariadb</a>, contributed by </li>
 <li><a href="http://pastebin.com/JcYeQBrX">An Ultra-HA, full Mult-Master E-mail cluster with iRedMail, MariaDB, and IPVS</a>, contributed by Joshua Boniface.</li>
 </ul>
-<h3 id="troubleshooting-and-debug">Troubleshooting and Debug</h3>
+<h3 id="troubleshooting">Troubleshooting and Debug</h3>
 <ul>
 <li><a href="debug.amavisd.html">Turn on debug mode in Amavisd and SpamAssassin</a></li>
 <li><a href="debug.dovecot.html">Turn on debug mode in Dovecot</a></li>
@ -178,7 +178,7 @@
 <li><a href="debug.openldap.html">Turn on debug mode in OpenLDAP</a></li>
 <li><a href="debug.roundcubemail.html">Turn on debug mode in Roundcube webmail</a></li>
 </ul>
-<h3 id="frequently-asked-questions">Frequently Asked Questions</h3>
+<h3 id="faq">Frequently Asked Questions</h3>
 <ul>
 <li><a href="errors.html">Errors you may see while maintaining iRedMail server</a></li>
 <li><a href="why.append.timestamp.in.maildir.path.html">Why append timestamp in maildir path</a></li>
--- a/html/iredadmin-pro.restful.api.html
+++ b/html/iredadmin-pro.restful.api.html
@ -24,12 +24,12 @@
 <div class="toc">
 <ul>
 <li><a href="#iredadmin-pro-restful-api">iRedAdmin-Pro: RESTful API</a><ul>
+<li><a href="#changelog">ChangeLog</a></li>
 <li><a href="#summary">Summary</a></li>
 <li><a href="#requirements">Requirements</a></li>
 <li><a href="#enable-restful-api">Enable RESTful API</a></li>
 <li><a href="#sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</a></li>
 <li><a href="#apis">APIs</a><ul>
-<li><a href="#changelog">ChangeLog</a></li>
 <li><a href="#domain">Domain</a></li>
 <li><a href="#user">User</a></li>
 <li><a href="#mailing-list">Mailing List</a></li>
@ -45,11 +45,17 @@
 </li>
 </ul>
 </div>
+<h3 id="changelog">ChangeLog</h3>
+<ul>
+<li>Variable name <code>cn</code> has been renamed to <code>name</code>.</li>
+<li>Variable names in returned JSON data has been changed to:
+  <code>{'_success': ..., '_msg': ...}</code> (was <code>{'success': ..., 'msg': ...}</code>).</li>
+</ul>
 <h2 id="summary">Summary</h2>
 <p>iRedAdmin-Pro RESTful API will return message in JSON format.</p>
 <ul>
-<li>If operation succeed, iRedAdmin-Pro returns JSON data: <code>{'success': true}</code>.</li>
-<li>If operation failed, iRedAdmin-Pro returns JSON data: <code>{'success': false, 'msg': '&lt;error_reason&gt;'}</code>.</li>
+<li>If operation succeed, iRedAdmin-Pro returns JSON data: <code>{'_success': true}</code>.</li>
+<li>If operation failed, iRedAdmin-Pro returns JSON data: <code>{'_success': false, '_msg': '&lt;error_reason&gt;'}</code>.</li>
 </ul>
 <h2 id="requirements">Requirements</h2>
 <ul>
@ -85,10 +91,6 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
 <li>replace <code>&lt;mail&gt;</code> in URL by the real email address.</li>
 </ul>
 <p><button type="button" class="toggle_all">Expand/Collapse All API Parameters</button></p>
-<h3 id="changelog">ChangeLog</h3>
-<ul>
-<li>Variable name <code>cn</code> has been renamed to <code>name</code>.</li>
-</ul>
 <h3 class="toggle" id="domain">Domain</h3>
 <!--
 !!! api "`GET`{: .get } `/api/domain/<domain>`{: .url } `Get profile of an existing domain`{: .comment }"
@ -209,11 +211,6 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
 <td><code>transport=dovecot</code></td>
 </tr>
 <tr>
-<td><code>backupmx</code></td>
-<td>Mark domain as Backup MX</td>
-<td><code>backupmx=yes</code></td>
-</tr>
-<tr>
 <td><code>defaultQuota</code></td>
 <td>Default per-user mailbox quota for newly created user</td>
 <td><code>defaultQuota=1024</code></td>
@ -233,6 +230,26 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
 <td>Max number of mail alias accounts</td>
 <td><code>numberOfAliases=30</code></td>
 </tr>
+<tr>
+<td><code>senderBcc</code></td>
+<td>Per-domain sender bcc address</td>
+<td><code>senderBcc=user@domain.com</code></td>
+</tr>
+<tr>
+<td><code>recipientBcc</code></td>
+<td>Per-domain recipient bcc address</td>
+<td><code>recipientBcc=user@domain.com</code></td>
+</tr>
+<tr>
+<td><code>backupmx</code></td>
+<td>Mark domain as Backup MX. Must be used with parameter <code>primarymx</code>. Conflicts with <code>transport</code>.</td>
+<td><code>backupmx=yes</code> (or <code>no</code>)</td>
+</tr>
+<tr>
+<td><code>primarymx</code></td>
+<td>IP address of primary MX. Must be used with parameter <code>backupmx</code>. Conflicts with <code>transport</code>.</td>
+<td><code>primarymx=202.96.134.133</code></td>
+</tr>
 </tbody>
 </table>
 </div>