This commit is contained in:
Zhang Huangbin 2016-04-22 13:13:31 +08:00
parent e1b2a2f11c
commit 046428a46c
32 changed files with 54 additions and 107 deletions

View File

@ -1,23 +1,27 @@
# How to write documents with Markdown
* Organize articles in directories, each directory is a chapter.
* Order of chapters is hard-coded in file `convert.sh`, so that we can avoid
complex/unnecessary way to order them.
* Order of chapters is hard-coded in file `convert.sh` (parameter
`all_chapter_dirs`), so that we can avoid complex/unnecessary way to order them.
* Chapter title is defined in file `_title.md` under chapter folder.
* Chapter summary is defined in file `_summary.md` under chapter folder.
* Additional links stored in file `_links.md` will be appended to chapter.
```
- chapter_name_1/
|- _title.md: Chapter title. REQUIRED
|- _links.md: Additional links, will be appended to chapter. OPTIONAL
|- _summary.md: Summary text of this chapter, will be displayed under
chapter title. OPTIONAL
|- what_is_iredmail.md
|- why_choose_iredmail.md
- chapter_name_2/
- chapter_name_3/
...
|- <language>/
|- _lang.md: Full name of the language. REQUIRED. e.g. `English` for `en_US`.
|- chapter_name_1/
|- _title.md: Chapter title. REQUIRED
|- _links.md: Additional links, will be appended to chapter. OPTIONAL
|- _summary.md: Summary text of this chapter, will be displayed under
chapter title. OPTIONAL
|- what_is_iredmail.md
|- why_choose_iredmail.md
|- chapter_name_2/
|- ...
|- chapter_name_3/
|- ...
|- ...
- html/css/markdown.css
- html/images/
```

View File

@ -183,7 +183,6 @@ for lang in ${all_languages}; do
cp -f ${article_file} ${tmp_md_orig}
set -x
# Generate new markdown file
# Get title line
_title_line="$(head -1 ${tmp_md_orig})"
@ -193,14 +192,18 @@ for lang in ${all_languages}; do
echo -e "${title_line}\n\n" > ${tmp_md}
echo -e '!!! note "This tutorial is available in other languages"\n\n' >> ${tmp_md}
_md_l='\t'
for l in ${translations}; do
tmp_article_html_file="$(echo ${article_html_file_orig/%.md/-${l}.html})"
echo -e " * [$(cat ${ROOTDIR}/${l}/_lang.md)](./${tmp_article_html_file})\n" >> ${tmp_md}
if [ X"${l}" == X'en_US' ]; then
tmp_article_html_file="$(echo ${article_html_file_orig/%.md/.html})"
else
tmp_article_html_file="$(echo ${article_html_file_orig/%.md/-${l}.html})"
fi
_md_l="${_md_l} [$(cat ${ROOTDIR}/${l}/_lang.md)](./${tmp_article_html_file}) "
done
echo -e '\n' >> ${tmp_md}
echo -e "${_md_l}\n" >> ${tmp_md}
cat ${tmp_md_orig} >> ${tmp_md}
set +x
md_src="${tmp_md}"
rm -f ${tmp_md_orig}

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./allow.member.to.send.email.as.mail.list-en_US.html">English</a></li>
</ul>
<p><a href="./allow.member.to.send.email.as.mail.list.html">English</a> </p>
</div>
<h1 id="_1">允许列表成员以列表邮件地址作为发件人发送邮件</h1>
<p>要允许列表成员以列表邮件地址作为发件人发送邮件,请按照以下步骤操作:</p>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./allow.member.to.send.email.as.mail.list-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./allow.member.to.send.email.as.mail.list-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="allow-member-to-send-email-as-mailing-list-or-mail-alias">Allow member to send email as mailing list or mail alias</h1>
<p>To allow member of mailing list (or mail alias) account to send email as this

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./allow.user.to.send.email.without.authentication-en_US.html">English</a></li>
</ul>
<p><a href="./allow.user.to.send.email.without.authentication.html">English</a> </p>
</div>
<h1 id="_1">允许用户无需身份验证发送邮件</h1>
<p>创建文本文件 <code>/etc/postfix/accepted_unauth_senders</code>,列出无需身份验证就可以

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./allow.user.to.send.email.without.authentication-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./allow.user.to.send.email.without.authentication-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="allow-user-to-send-email-without-smtp-authentication">Allow user to send email without smtp authentication</h1>
<p>Create a plain text file: <code>/etc/postfix/accepted_unauth_senders</code>, list all

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./change.mail.attachment.size-en_US.html">English</a></li>
</ul>
<p><a href="./change.mail.attachment.size.html">English</a> </p>
</div>
<h1 id="_1">修改邮件附件大小</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./change.mail.attachment.size-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./change.mail.attachment.size-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="change-mail-attachment-size">Change mail attachment size</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./change.server.hostname-en_US.html">English</a></li>
</ul>
<p><a href="./change.server.hostname.html">English</a> </p>
</div>
<h1 id="_1">修改服务器主机名</h1>
<p>要在安装 iRedMail 后修改服务器的主机名,请将以下文件中的旧主机名改为新主机名:</p>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./change.server.hostname-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./change.server.hostname-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="change-server-hostname">Change server hostname</h1>
<p>To change server hostname after iRedMail installation, please update below

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./debug.amavisd-en_US.html">English</a></li>
</ul>
<p><a href="./debug.amavisd.html">English</a> </p>
</div>
<h1 id="amavisd-spamassassin">调试 Amavisd 和 SpamAssassin</h1>
<p>找到<a href="./file.locations.html#amavisd">Amavisd 配置文件</a>,修改 <code>$log_level</code> 参数,

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./debug.amavisd-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./debug.amavisd-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="turn-on-debug-mode-in-amavisd-and-spamassassin">Turn on debug mode in Amavisd and SpamAssassin</h1>
<p>In <a href="./file.locations.html#amavisd">Amavisd config file</a>, change <code>$log_level</code>,

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./debug.dovecot-en_US.html">English</a></li>
</ul>
<p><a href="./debug.dovecot.html">English</a> </p>
</div>
<h1 id="dovecot">开启 Dovecot 调试模式</h1>
<blockquote>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./debug.dovecot-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./debug.dovecot-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="turn-on-debug-mode-in-dovecot">Turn on debug mode in Dovecot</h1>
<blockquote>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./disable.spam.virus.scanning.for.outgoing.mails-en_US.html">English</a></li>
</ul>
<p><a href="./disable.spam.virus.scanning.for.outgoing.mails.html">English</a> </p>
</div>
<h1 id="_1">对外发邮件禁用垃圾扫描、病毒扫描</h1>
<p>要对外发邮件禁用垃圾扫描、病毒扫描功能,可以在 Amavisd 配置文件

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./disable.spam.virus.scanning.for.outgoing.mails-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./disable.spam.virus.scanning.for.outgoing.mails-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="disable-spam-virus-scanning-for-outgoing-mails">Disable spam virus scanning for outgoing mails</h1>
<p>To disable spam/virus scanning for outgoing mails, you can add bypass settings

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./ignore.trash.folder.in.quota-en_US.html">English</a></li>
</ul>
<p><a href="./ignore.trash.folder.in.quota.html">English</a> </p>
</div>
<h1 id="_1">在邮箱配额中忽略垃圾箱目录</h1>
<p>在 Dovecot 中,针对单个用户的邮箱配额限制定义在下列文件之一:</p>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./ignore.trash.folder.in.quota-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./ignore.trash.folder.in.quota-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="ignore-trash-folder-in-mailbox-quota">Ignore Trash folder in mailbox quota</h1>
<p>Per-user mailbox quota rule is defined in Dovecot, in one of below files:</p>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./install.iredmail.on.rhel-en_US.html">English</a></li>
</ul>
<p><a href="./install.iredmail.on.rhel.html">English</a> </p>
</div>
<h1 id="red-hat-enterprise-linux-centos-iredmail">在 Red Hat Enterprise Linux 或 CentOS 系统上安装 iRedMail</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./install.iredmail.on.rhel-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./install.iredmail.on.rhel-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="install-iredmail-on-red-hat-enterprise-linux-centos">Install iRedMail on Red Hat Enterprise Linux, CentOS</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./mailbox.sharing-en_US.html">English</a></li>
</ul>
<p><a href="./mailbox.sharing.html">English</a> </p>
</div>
<h1 id="imap">共享邮箱(将 IMAP 目录共享给其他用户)</h1>
<blockquote>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./mailbox.sharing-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./mailbox.sharing-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="mailbox-sharing-sharing-imap-folder-with-other-users">Mailbox sharing (Sharing IMAP folder with other users)</h1>
<div class="admonition note">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./no.x-spam.headers-en_US.html">English</a></li>
</ul>
<p><a href="./no.x-spam.headers.html">English</a> </p>
</div>
<h1 id="amavisd-spamassassin-x-spam-">Amavisd + SpamAssassin 无效,邮件头无 X-Spam-* 信息插入</h1>
<p>在 Amavisd 的配置文件 <code>/etc/amavisd/amavisd.conf</code> 中有如下默认设置:</p>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./no.x-spam.headers-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./no.x-spam.headers-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="amavisd-spamassassin-not-working-no-mail-header-x-spam-inserted">Amavisd + SpamAssassin not working? no mail header (X-Spam-*) inserted</h1>
<p>Amavisd has below setting in its config file <code>/etc/amavisd/amavisd.conf</code> by default:</p>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./password.hashes-en_US.html">English</a></li>
</ul>
<p><a href="./password.hashes.html">English</a> </p>
</div>
<h1 id="_1">密码</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./password.hashes-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./password.hashes-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="password-hashes">Password hashes</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./performance.tuning-en_US.html">English</a></li>
</ul>
<p><a href="./performance.tuning.html">English</a> </p>
</div>
<h1 id="_1">性能优化</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./performance.tuning-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./performance.tuning-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="performance-tuning">Performance tuning</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./reset.user.password-en_US.html">English</a></li>
</ul>
<p><a href="./reset.user.password.html">English</a> </p>
</div>
<h1 id="_1">重置用户密码</h1>
<blockquote>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./reset.user.password-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./reset.user.password-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="reset-user-password">Reset user password</h1>
<blockquote>

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./use.a.bought.ssl.certificate-en_US.html">English</a></li>
</ul>
<p><a href="./use.a.bought.ssl.certificate.html">English</a> </p>
</div>
<h1 id="ssl">使用购买的 SSL 证书</h1>
<div class="toc">

View File

@ -16,9 +16,7 @@
</a>
&nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><div class="admonition note">
<p class="admonition-title">This tutorial is available in other languages</p>
<ul>
<li><a href="./use.a.bought.ssl.certificate-zh_CN.html">简体中文</a></li>
</ul>
<p><a href="./use.a.bought.ssl.certificate-zh_CN.html">简体中文</a> </p>
</div>
<h1 id="use-a-bought-ssl-certificate">Use a bought SSL certificate</h1>
<div class="toc">