Hello, This is a tentative patchset for orgweb zh_CN translation. However, some questions remain before I can finalize the translation, see below. Note that they are not of any particular order -- just the order in which they appeared in my mind when I composed this message.
- General * How do I change the heading for the footnote section? In particular, can I set it in a file- or dir-local variable, or in the setup.org file? This is needed for _fully_ translating /quickstart.org. * Is translating /elpa.org worth it? I presume not, because part of it describes the use of the now-deprecated Org Elpa repository. * I noticed that /resources/postamble.html is unused in all languages. Should it be deleted? * I have added additional notes regarding zero-width spaces, because CJK languages rarely use spaces whereas markups need them. I presume this is an acceptable addition. + This addition would also be helpful for when _eventually_ the Japanese version is updated or some other CJK language is added. * I left the changes in a series of commits, each handling one file -- please let me know if I should squash them into fewer commits. Alternatively, let me know if I should push this to some online Git repo. * Please let me know if there are any guidelines for commit messages which I should follow. * I think the "#+description:" portion of each *.org file can be just moved into setup.org? That way we don't duplicate it twenty times. * There are hyperlinks which link to sites unreachable from mainland China. I have marked them as "external sites" (外网) for now, but I wonder if I should look for equivalent sites accessible from within mainland China. * When translating /index.org, I noticed that, within the first section, the spacing between the icons and their texts (e.g., the rocket icon and its accompanying text "quickstart") in /zh_CN/index.org are smaller than that of /index.org. I don't know if it is because I unintentionally changed something that caused this. * Should I mark English links as "English", and if so, how aggressively should I mark them? Or do you think it is too distracting for readers? I ask because there are some links in /ja that are marked as "English". - Chinese speakers * Please check for consistency on all major terminologies. The translation was done during a long timespan, and I may have unintentionally chosen different words for the same term on different days. * Please suggest alternative translations for various portions if you see fit. There were some portions where I _struggled_ to come up with sound translations.
>From c3ae2c1963933ca363da6b9d01757d14463d7a9a Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 01/12] * **/resources/preamble.html --- resources/preamble.html | 4 +++- zh_CN/resources/preamble.html | 23 +++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 zh_CN/resources/preamble.html diff --git a/resources/preamble.html b/resources/preamble.html index a64832f..c3836f3 100644 --- a/resources/preamble.html +++ b/resources/preamble.html @@ -7,7 +7,9 @@ <span id="translate"> [ <a title="English version" href="/index.html">en</a> - <a title="Version française" href="/fr/index.html">fr</a> - - <a title="Japanese version" href="/ja/index.html">ja</a> ] + - <a title="Japanese version" href="/ja/index.html">ja</a> + - <a title="简体中文版本" href="/zh_CN/index.html">简</a> + ] </span> <a href="index.html"> <p class="logo"><img src="/resources/img/org-mode-unicorn.svg" alt="Org-Mode Logo"/> Org Mode</p></a> diff --git a/zh_CN/resources/preamble.html b/zh_CN/resources/preamble.html new file mode 100644 index 0000000..5e9e3e5 --- /dev/null +++ b/zh_CN/resources/preamble.html @@ -0,0 +1,23 @@ +<!-- <script type="text/javascript" async src="/resources/js/org.js"></script> --> + +<nav id="main"> + <label for="hamburger">☰</label> + <input type="checkbox" id="hamburger"/> + + <span id="translate"> + [ <a title="English version" href="/index.html">en</a> + - <a title="Version française" href="/fr/index.html">fr</a> + - <a title="Japanese version" href="/ja/index.html">ja</a> + - <a title="简体中文版本" href="/zh_CN/index.html">简</a> + ] + </span> + <a href="."> + <p class="logo"><img src="../resources/img/org-mode-unicorn.svg" alt="Org 主模式图标"/>Org 主模式</p></a> + <a href="features.html">功能</a> + <a title="获取详细的最新更新内容" href="Changes.html">更新内容</a> + <a title="查看即将到来的更新、帮助请求、已确认的bug、已提交的补丁" href="https://updates.orgmode.org">项目状态</a> + <a title="查看如何安装 Org" href="../org.html#Installation">安装</a> + <a title="查看所有手册" href="manuals.html">手册</a> + <a title="Worg 是社区为 Org 编写的文档" href="../worg">Worg</a> + <a title="查看如何为 Org 提交贡献 Start here if you want to contribute to Org" href="../worg/org-contribute.html">贡献</a> +</nav> -- 2.40.0
>From f6aa08604a825badfa76e8f35f0e39cbe13c8fa8 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 02/12] * zh_CN/resources/* symlinks --- zh_CN/resources/fonts | 1 + zh_CN/resources/img | 1 + zh_CN/resources/js | 1 + zh_CN/resources/normal-outline-3.html | 1 + zh_CN/resources/oembed-info.json | 1 + zh_CN/resources/style | 1 + 6 files changed, 6 insertions(+) create mode 120000 zh_CN/resources/fonts create mode 120000 zh_CN/resources/img create mode 120000 zh_CN/resources/js create mode 120000 zh_CN/resources/normal-outline-3.html create mode 120000 zh_CN/resources/oembed-info.json create mode 120000 zh_CN/resources/style diff --git a/zh_CN/resources/fonts b/zh_CN/resources/fonts new file mode 120000 index 0000000..db461b9 --- /dev/null +++ b/zh_CN/resources/fonts @@ -0,0 +1 @@ +../../resources/fonts \ No newline at end of file diff --git a/zh_CN/resources/img b/zh_CN/resources/img new file mode 120000 index 0000000..a3dbcb6 --- /dev/null +++ b/zh_CN/resources/img @@ -0,0 +1 @@ +../../resources/img \ No newline at end of file diff --git a/zh_CN/resources/js b/zh_CN/resources/js new file mode 120000 index 0000000..abe6c55 --- /dev/null +++ b/zh_CN/resources/js @@ -0,0 +1 @@ +../../resources/js \ No newline at end of file diff --git a/zh_CN/resources/normal-outline-3.html b/zh_CN/resources/normal-outline-3.html new file mode 120000 index 0000000..2c53e57 --- /dev/null +++ b/zh_CN/resources/normal-outline-3.html @@ -0,0 +1 @@ +../../resources/normal-outline-3.html \ No newline at end of file diff --git a/zh_CN/resources/oembed-info.json b/zh_CN/resources/oembed-info.json new file mode 120000 index 0000000..650c2c9 --- /dev/null +++ b/zh_CN/resources/oembed-info.json @@ -0,0 +1 @@ +../../resources/oembed-info.json \ No newline at end of file diff --git a/zh_CN/resources/style b/zh_CN/resources/style new file mode 120000 index 0000000..d2c0a04 --- /dev/null +++ b/zh_CN/resources/style @@ -0,0 +1 @@ +../../resources/style \ No newline at end of file -- 2.40.0
>From 14afb2d0a38f31eac557bd4388b0f4c2891adba3 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 03/12] * zh_CN/org-demo.html --- zh_CN/org-demo.html | 1 + 1 file changed, 1 insertion(+) create mode 120000 zh_CN/org-demo.html diff --git a/zh_CN/org-demo.html b/zh_CN/org-demo.html new file mode 120000 index 0000000..8d180cf --- /dev/null +++ b/zh_CN/org-demo.html @@ -0,0 +1 @@ +../org-demo.html \ No newline at end of file -- 2.40.0
>From 42b8432b2165a37fc2ab8d3f1701d4d1f1bcb341 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 04/12] * zh_CN/setup.org --- zh_CN/setup.org | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 zh_CN/setup.org diff --git a/zh_CN/setup.org b/zh_CN/setup.org new file mode 100644 index 0000000..c6f016e --- /dev/null +++ b/zh_CN/setup.org @@ -0,0 +1,32 @@ +#+language: zh_CN +#+description: Org 主模式:在 Emacs 上记笔记、作计划、写文档 +#+startup: hidestars +#+options: H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t *:t TeX:t author:nil <:t LaTeX:t +#+property: header-args :eval no-export +#+html_head: <meta name="theme-color" content="#77aa99"> +#+html_head: <meta property="og:title" content="Org Mode"> +#+html_head: <meta property="og:type" content="website"> +#+html_head: <meta property="og:url" content="https://orgmode.org"> +#+html_head: <meta property="og:image" content="https://orgmode.org/resources/img/social-card.png"> +#+html_head: <meta property="og:image:alt" content="Org-mode. Complex so you don't have to be. A versatile organisationay system with immense capabilities."> +#+html_head: <meta property="og:image:type" content="image/svg"> +#+html_head: <meta property="og:image:width" content="1280"> +#+html_head: <meta property="og:image:height" content="640"> +#+html_head: <meta property="og:description" content="Org-mode. Complex so you don't have to be. A versatile organisational system with immense capabilities."> +#+html_head: <meta property="twitter:card" content="summary_large_image"> +#+html_head: <meta property="twitter:url" content="https://orgmode.org"> +#+html_head: <meta property="twitter:title" content="Org Mode"> +#+html_head: <meta property="twitter:description" content="Org: an Emacs Mode for Notes, Planning, Authoring and more!"> +#+html_head: <meta property="twitter:image" content="https://orgmode.org/resources/img/social-card.png"> +#+html_head: <meta property="twitter:image:alt" content="Org-mode. Complex so you don't have to be. A versatile organisationay system with immense capabilities."> +#+html_head: <link rel="alternate" type="application/json+oembed" href="resources/oembed-info.json" title="Org oEmbed Profile" /> +#+html_head: <meta name="flattr:id" content="8d9x0o"> +#+html_head: <link rel="apple-touch-icon" sizes="180x180" href="/resources/img/favicons/apple-touch-icon.png"> +#+html_head: <link rel="icon" type="image/png" sizes="32x32" href="/resources/img/favicons/favicon-32x32.png"> +#+html_head: <link rel="icon" type="image/png" sizes="16x16" href="/resources/img/favicons/favicon-16x16.png"> +#+html_head: <link rel="manifest" href="/resources/img/favicons/site.webmanifest"> +#+html_head: <link rel="mask-icon" href="/resources/img/favicons/safari-pinned-tab.svg" color="#77aa99"> +#+html_head: <link rel="shortcut icon" href="/resources/img/favicons/favicon.ico"> +#+html_head: <meta name="msapplication-TileColor" content="#77aa99"> +#+html_head: <meta name="msapplication-config" content="/resources/img/favicons/browserconfig.xml"> +#+html_head: <link rel="stylesheet" href="/resources/style/org.min.css" type="text/css" /> -- 2.40.0
>From 7b71ecb12c846f10fa7064dfd8d349ca75367474 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 05/12] * zh_CN/index.org --- zh_CN/index.org | 170 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 zh_CN/index.org diff --git a/zh_CN/index.org b/zh_CN/index.org new file mode 100644 index 0000000..ff2d423 --- /dev/null +++ b/zh_CN/index.org @@ -0,0 +1,170 @@ +#+title: Emacs 的 Org 主模式 +#+setupfile: setup.org +#+html_head: <link rel="stylesheet" href="resources/style/index.min.css" type="text/css" /> +#+html_head: <link rel="preload" href="resources/img/org-mode-unicorn.svg" as="image" type="image/svg+xml"> +#+include: "resources/preamble.html" export html + +#+html_head: <link rel="stylesheet" href="resources/style/org-demo.min.css" type="text/css" /> +#+include: "resources/normal-outline-3.html" export html + +#+begin_export html +<div class="banner hero" itemscope itemtype="https://schema.org/SoftwareApplication"> + <img src="resources/img/org-mode-unicorn.svg" + alt="Org unicorn logo" itemprop="image"/> + <div> + <h2> + <span itemprop="name">Org Mode</span> + <p class="subtitle">纯文本的生活</p> + </h2> + <p> + 一个 <a href="https://www.gnu.org/software/emacs/" style="color: inherit; font-weight: bold; font-style: italic;" + title="An extensible, customizable, free/libre text editor">GNU Emacs</a> + 的纯文本主模式。Org Mode 有多种用法:用户可用它来快捷且高效地<span itemprop="applicationCategory">记笔记、编写文档、计算笔记本、文学编程、维护待办事项、计划项目等等。</p> + <p><a title="从 GNU ELPA 下载" href="https://elpa.gnu.org/packages/org.html"><img src="https://elpa.gnu.org/packages/org.svg" alt="从 GNU ELPA 下载" /></a> + <a title="如何报告问题" href="/manual/Feedback.html"><img src="resources/img/badge-report-bug.svg" alt="如何报告问题" /></a> + <a title="给 Org Mode 邮件列表发送邮件" href="mailto:emacs-orgmode@gnu.org"><img src="resources/img/badge-feedback.svg" alt="给 Org Mode 邮件列表发送邮件" /></a> + <a title="使用 Git 克隆代码仓库" href="https://git.savannah.gnu.org/cgit/emacs/org-mode.git"><img src="resources/img/badge-source-code.svg" alt="使用 Git 克隆代码仓库" /></a> + <a title="sr.ht 项目主页" href="https://sr.ht/~bzg/org"><img src="resources/img/badge-srht-project.svg" alt="sr.ht 项目主页"/></a></p> + <p class="bubble"> + 在 <a href="https://liberapay.com/org-mode" title="感谢捐款" + style="font-weight: bold; display: inline-block"> + <img class="inline" src="resources/img/external/librepay.svg" alt="Liberapay logo"/> + Liberapay</a> 上支持 Org </p> + <meta itemprop="operatingSystem" content="Linux, MacOS, Windows"> + <meta itemprop="softwareVersion" content="9.3.8"> + <meta itemprop="datePublished" content="2020-08-07"> + <meta itemprop="url" content="."> <!-- TODO: what is the use of this? --> + </div> +</div> +<div class="banner slim grey faded inline"> + <p style="width:90vw; color:#515151"> 作者:<a + target="new" href="https://staff.science.uva.nl/~dominik/" + style="font-weight:500; color:inherit">Carsten Dominik</a>(<a + target="new" href="/manual/History-and-Acknowledgments.html" style="color:#6e6e6e" + >2003</a>);维护者:<a target="new" href="https://bzg.fr/en/" style="font-weight:500; color:inherit" + >Bastien Guerry</a>;开发者:<a href="/org.html#History-and-Acknowledgments" style="color:#6e6e6e">大量贡献者</a>。</p> +</div> +#+end_export + +* 主要亮点 + :PROPERTIES: + :HTML_CONTAINER_CLASS: columns no-heading + :END: + +** 功能 + @@html:<a href="features.html">@@ + #+attr_html: :alt 三颗星星 :title 无尽可能 + [[file:resources/img/stars.svg]] + + @@html:</a>@@ + +** 安装 + @@html:<a href="../org.html#Installation">@@ + #+attr_html: :alt 下箭头 :title 你还在等什么? + [[file:resources/img/install.svg]] + + @@html:</a>@@ + +** 快速开始 + @@html:<a href="quickstart.html">@@ + #+attr_html: :alt 火箭 :title 立即开始,你会爱上它。 + [[file:resources/img/quickstart.svg]] + + @@html:</a>@@ + +** 贡献 + @@html:<a href="../worg/org-contribute.html">@@ + #+attr_html: :alt Git branch 图标 :title 多多益善。 + [[file:resources/img/contribute.svg]] + + @@html:</a>@@ + +* Elaboration + demo image :ignore: + +#+attr_html: :style margin-top:2rem; + +Org 是一个非常灵活的有结构的纯文本文件格式,由几种简单而又多用的结构组成。因此,Org 即足够[[https://karl-voit.at/2017/09/23/orgmode-as-markup-only/][简单]],又足够[[http://howardism.org/Technical/Emacs/literate-devops.html][强大]]。 + +请在以下这个例子里一窥 Org 具有的强大功能。点击段落标题与链接可以智能折叠与展开相应内容。 + +#+include: org-demo.html export html + +* 更多资料 + :PROPERTIES: + :CUSTOM_ID: reading + :END: + +除开[[file:quickstart.org][快速开始]]与[[file:../manual/][手册]]之外,Org 还有一个[[file:../guide/][指南]]和大量由社区编写的文档:[[file:../worg/][Worg]]。 + +几乎所有的 Org 用户都有自己关于 Org 的故事 - 有些人甚至撰写了关于 Org 对于其实现[[https://en.wikipedia.org/wiki/Reproducibility#Reproducible_research][可重复性研究(英语;外网)]]价值的[[file:../worg/org-papers.html][科学论文]]。还有些人开发了一系列第三方工具用来在 Emacs 以外的环境里使用 Org ,例如在移动设备上。 + +* 更多 Org + :PROPERTIES: + :CUSTOM_ID: more + :END: + +Org 文件的 MIME 类型为 =text/org=,使用 ~.org~ 后缀名。大部分操作系统不知道应该使用 Emacs 来打开 ~.org~ 文件,但通常可以轻松修改其对应设置来达到此目的。 + +Org 在 Emacs Lisp 上的默认实现目前为止拥有最丰富的功能。不过,目前仍有很多其它的[[file:tools.org][工具]]能与 Org 进行交互。 + +#+begin_center +#+attr_html: :class btn +[[file:tools.org][能与 Org 交互的工具]] +#+end_center + +* [[file:../worg/][Worg]],Org /世界/ + :PROPERTIES: + :CUSTOM_ID: worg + :END: + +Org 的用法五花八门,因此我们无法把它们轻松地纪录下来,更别提把它们在一个网页里展示出来。因此,我们创造了[[file:../worg/][Worg]]作为社区百科,为纪录、分享用户们使用 Org 的各方面信息提供了空间。 + +举个例子,[[file:../worg/][Worg]]包含了: + +- [[file:../worg/org-faq.html][常见问题]] +- [[file:../worg/org-hacks.html][Org 妙招]] +- [[file:../worg/org-tutorials/index.html][各种教程]] +- [[file:../worg/doc.html][所有挂勾、命令与选项的文档]] +- [[file:../worg/org-in-the-wild.html][野生的 Org]] +- /……以及更多/ + +[[file:../worg/][Worg]]是一个装有 Org 文件的 Git 代码仓库,发步为 HTML 网页,[[file:../worg/worg-about.html#contribute-to-worg][欢迎贡献]]。 + +#+BEGIN_SRC shell +~$ git clone https://git.sr.ht/~bzg/worg +#+END_SRC + +* 加入邮件列表 + :PROPERTIES: + :CUSTOM_ID: mailing-list + :END: + +Org 邮件列表是一个能与整个 Org 社区交流的地方。你可以[[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][订阅此列表]],也可以在[[https://list.orgmode.org][list.orgmode.org]]或者[[https://lists.gnu.org/archive/html/emacs-orgmode/][此 mailman 网页]]浏览往期邮件。_请注意,此列表需要使用英语交流。_ + +即使你不是此列表的订阅者,你仍可以向[[mailto:emacs-orgmode@gnu.org][emacs-orgmode@gnu.org]]发送邮件,我们会把你加入白名单。 + +更多关于邮件列表的信息请见[[file:../worg/org-mailing-list.html][此网页(英语)]]。此外,Org 还有其它的[[file:../worg/org-web-social.html][社交平台(英语)]]。 + +你也可以使用 IRC 在[[https://libera.chat/][Libera.Chat]]的 ~#org-mode~ 频道上与其它 Org 爱好者交流。_请注意,此频道需要使用英语交流。_ + +Org 的完整贡献者列表在 /Worg/ 里[[file:../worg/contributors.html][可见(英语)]]。你也可以查看手册的[[/org.html#History-and-Acknowledgments][鸣谢(英语)]]。 + +* Doom,Spacemacs,Scimax以及热门配置 + :PROPERTIES: + :CUSTOM_ID: configs + :END: + +[[https://github.com/hlissner/doom-emacs][Doom]],[[https://www.spacemacs.org/][Spacemacs]],以及[[https://github.com/jkitchin/scimax][Scimax]]这几个 Emacs 入门工具包包含了一系列经过精细管理过的组件与配置,目标是给常用的 Org(以及 Emacs 本身)用法带来优化。它们包含了 =org-mode= 与其它模式的集成(例如 =evil-mode=)。这里是它们目前使用的组件列表:[[https://github.com/hlissner/doom-emacs/blob/develop/modules/lang/org/packages.el][Doom]]、[[https://github.com/syl20bnr/spacemacs/blob/master/layers/%2Bemacs/org/packages.el][Spacemacs]]。/Scimax/ 与 Org 紧密集成,所以 /Scimax/ 用户应先参考它的[[https://github.com/jkitchin/scimax/blob/master/scimax.org#org-mode][手册(英语)]]。/Doom/ 使用的 Org 版本接近与开发版 ~HEAD~,而 /Spacemacs/ 与 /Scimax/ 使用的则是 Org 在 GNU ELPA 上发步的版本。 + +各种入门工具包通常大量修改了 Emacs 的默认用户设置。如果你更偏向于原版 Emacs,可以参考包含配置了 Org 及其关联组件的热门配置,例如 [[https://github.com/purcell/emacs.d/blob/master/lisp/init-org.el][Purcell 的 emacs.d]]。 + +* 其它文本编辑器 + :PROPERTIES: + :CUSTOM_ID: editors + :END: + +尽管用户只能在 Emacs 上享受完整的 Org [[file:features.org][功能(英语)]],但是 Org 文件的基本功能已经在一系列其它编辑器上被实现出来,详见以下列表: + +- *Vim* : [[https://github.com/kristijanhusak/orgmode.nvim][orgmode.nvim]]、[[https://github.com/jceb/vim-orgmode][vim-orgmode]]、 [[https://github.com/axvr/org.vim][org.vim]] +- *Atom* : [[https://atom.io/packages/org-mode][org-mode]] +- *VS Codium* : [[https://github.com/vscode-org-mode/vscode-org-mode][vscode-org-mode]] -- 2.40.0
>From 27d48cf3eb64687780a6ea34bfce205ba2541972 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 06/12] * symlink zh_CN/Changes.org Translating this is not worth the effort. Too large. --- zh_CN/Changes.org | 1 + 1 file changed, 1 insertion(+) create mode 120000 zh_CN/Changes.org diff --git a/zh_CN/Changes.org b/zh_CN/Changes.org new file mode 120000 index 0000000..5768154 --- /dev/null +++ b/zh_CN/Changes.org @@ -0,0 +1 @@ +../Changes.org \ No newline at end of file -- 2.40.0
>From 46c3b7ef7c8306d466eda4bd2c5b038c7488e52c Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 07/12] * zh_CN/tools.org --- zh_CN/tools.org | 202 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 zh_CN/tools.org diff --git a/zh_CN/tools.org b/zh_CN/tools.org new file mode 100644 index 0000000..ed273ee --- /dev/null +++ b/zh_CN/tools.org @@ -0,0 +1,202 @@ +#+title: 工具 | Org mode +#+setupfile: setup.org +#+include: "resources/preamble.html" export html + +#+macro: link @@html:<a href="https://$1">@@ +#+macro: worg @@html:<a href="../worg/$1">@@ +#+macro: gh {{{link(github.com/$1)}}} +#+macro: end-link @@html:</a>@@ + +#+BEGIN_EXPORT html +<style> + #content { + max-width: 80rem; + } + .columns .outline-3 .org-svg, .columns .outline-3 img { + height: 6.5rem; + } + .columns .outline-3 h3 { + top: 4.5rem; + } + body { + padding-top: 2.5rem; + } +</style> +#+END_EXPORT + +* 导入与导出 +:PROPERTIES: +:HTML_CONTAINER_CLASS: columns +:END: +** Pandoc +:PROPERTIES: +:HTML_CONTAINER_CLASS: starred +:END: +{{{link(pandoc.org)}}} +[[https://lh3.googleusercontent.com/-S8Fwe-PISrU/WExNwRXJHKI/AAAAAAAAAFo/tRbv1NAYBWoEBitmvDRFY_bc5xv07lnMACLcB/s1600/pandoc.png]] + +瑞士军刀级别的 markup 文档转换器:它能将文档在不同格式之间自由转换,包括 Org。 +{{{end-link}}} +* 发步 +:PROPERTIES: +:HTML_CONTAINER_CLASS: columns +:END: +** Hugo +{{{link(gohugo.io)}}} +[[https://upload.wikimedia.org/wikipedia/commons/a/af/Logo_of_Hugo_the_static_website_generator.svg]] + +一个使用 Go 编写的、原生支持 Org 的静态网页生成器。 +{{{end-link}}} +** Org-Jekyll +{{{worg(org-tutorials/org-jekyll.html)}}} +[[https://cdn.worldvectorlogo.com/logos/jekyll.svg]] + +将 Org 与一个简易的博客静态网页生成器融合在一起。 +{{{end-link}}} +** o-blog +{{{link(renard.github.com/o-blog)}}} +[[https://upload.wikimedia.org/wikipedia/commons/3/31/Blogger.svg]] + +自成一体的博客系统,不需要任何外部软件。 +{{{end-link}}} +** Org2Blog +{{{gh(org2blog/org2blog)}}} +# [[https://raw.githubusercontent.com/org2blog/org2blog/master/svg/Org2Blog_shorthand.svg]] + +使用 Org 编写,然后在 WordPress 上发表博客。 +{{{end-link}}} +* 工具 +:PROPERTIES: +:HTML_CONTAINER_CLASS: columns +:END: +** Memacs +:PROPERTIES: +:HTML_CONTAINER_CLASS: starred +:END: +{{{gh(novoid/Memacs)}}} +[[https://static.thenounproject.com/png/870-200.png]] + +提取、分析 Org 的元数据。 +{{{end-link}}} +** org-manage +{{{gh(dmgerman/org-manage)}}} +[[https://static.thenounproject.com/png/3266143-200.png]] + +帮助用户管理一大批 Org 文件。 +{{{end-link}}} +** orgFixLinks +{{{gh(cashTangoTangoCash/orgFixLinks)}}} +[[https://static.thenounproject.com/png/2805259-200.png]] + +一个帮助用户修复文件链接的脚本。 +{{{end-link}}} +** Logseq +{{{gh(logseq/logseq)}}} +[[https://pbs.twimg.com/profile_images/1284058782012563464/oQFKw8uM_400x400.png]] + +一个使用 Org 语法的、隐私优先的知识库。 +{{{end-link}}} +* Org 语法解析 +:PROPERTIES: +:HTML_CONTAINER_CLASS: columns +:END: +** Pico Lisp +{{{link(bitbucket.org/joebo/pico-org/src)}}} +[[https://upload.wikimedia.org/wikipedia/commons/4/40/PicoLisp_Logo.svg]] + +/pico-org/ --- 一个小的 Org 解析库,可以将 Org 文件内容解析成 Pico Lisp 数据解构。 +{{{end-link}}} +** Common Lisp +{{{link(common-lisp.net/project/cl-org-mode/)}}} +[[https://lispcookbook.github.io/cl-cookbook/assets/cl-logo-blue.png]] + +/cl-org-mode/ 将 Org 文件解析成为一个 Common Lisp 里的树结构。此库(初步)支持文学编程。 +{{{end-link}}} +** NodeJS +{{{link(/gioorgi.com/org-mode-parser/)}}} +[[https://seeklogo.com/images/N/nodejs-logo-FBE122E377-seeklogo.com.png]] + +/org-mode-parser/ +{{{end-link}}} +** Python +{{{gh(karlicoss/orgparse)}}} +[[https://cdn.iconscout.com/icon/free/png-256/python-14-569257.png]] + +/orgparse/ 将 Org 文件解析成为一个 Python 的树结构。 +{{{end-link}}} +** Perl +{{{link(metacpan.org/release/Org-Parser)}}} +[[https://upload.wikimedia.org/wikipedia/commons/f/f0/Cebolla_Chulita.png]] + +/Org::parser/ +{{{end-link}}} +** Ruby +{{{gh(bdewey/org-ruby)}}} +[[https://upload.wikimedia.org/wikipedia/commons/7/73/Ruby_logo.svg]] + +/org-ruby/ 是一个解析 Org 文件以及将其转换为文本格式以及 HTML 格式的 Ruby 库。此外,GitHub 使用这个库来显示网页上的 Org 文件。 +{{{end-link}}} +** Rust +{{{gh(poiscript/orgize)}}} +[[https://upload.wikimedia.org/wikipedia/commons/d/d5/Rust_programming_language_black_logo.svg]] + +/Orgize/ 可以解析 Org 文件,以及将其转换为 HTML 格式。 +{{{end-link}}} +** JavaScript +{{{gh(orgapp/orgajs)}}} +[[https://upload.wikimedia.org/wikipedia/commons/9/99/Unofficial_JavaScript_logo_2.svg]] + +/Orga/ 能够解析 Org 文件,将其转换为一个抽象语法树(AST)。 +{{{end-link}}} +* 导出 +:PROPERTIES: +:HTML_CONTAINER_CLASS: columns +:END: +** Drupal converter +{{{link(www.drupal.org/project/orgmode)}}} +[[https://www.drupal.org/files/EL_blue_RGB%281%29.png]] + +一个 drupal 库,可以导入 Org 文件,例如文章,然后转换为 drupal 结点。 +{{{end-link}}} +** Pandoc +{{{gh(kawabata/ox-pandoc)}}} +[[https://static.thenounproject.com/png/2710766-200.png]] + +/ox-pandoc/ 使用 pandoc 来实现 Org 的导出功能。 +{{{end-link}}} +** ox-hugo +:PROPERTIES: +:HTML_CONTAINER_CLASS: starred +:END: +{{{link(ox-hugo.scripter.co)}}} +[[https://upload.wikimedia.org/wikipedia/commons/4/48/Markdown-mark.svg]] + +支持导出到兼容 Hugo 的 Markdown 格式 (黑色星期五 --- Blackfriday)。此格式相比通常的 Markdown 格式更为灵活。 +{{{end-link}}} +** ox-⁎ +[[https://static.thenounproject.com/png/608341-200.png]] + +这里还有很多 Org 导出工具,可以四处看看。 +* 导入 +:PROPERTIES: +:HTML_CONTAINER_CLASS: columns +:END: +** Pandoc +{{{gh(tecosaur/org-pandoc-import)}}} +[[https://static.thenounproject.com/png/2404511-200.png]] + +/org-pandoc-import/ 是一个面对 pandoc 的工具,帮助用户将其它格式的标记文件转换为 Org 格式。 +{{{end-link}}} + +** VimWiki +{{{gh(fasheng/vimwiki2org)}}} +[[https://cdn.freebiesupply.com/logos/large/2x/vim-logo-png-transparent.png]] + +一个简易的转换工具,将 vimwiki 格式文件转换成 Org 格式。 +{{{end-link}}} +** Exchange calenders +{{{gh(kautsig/ews-orgmode)}}} +[[https://upload.wikimedia.org/wikipedia/commons/e/ea/Microsoft_Exchange_%282019-present%29.svg]] + +此脚本可以从一个 Exchange 服务器上获取你的日历,然后在 Org Agenda 上显示出来。 +{{{end-link}}} -- 2.40.0
From 0e9bb65c5b2b93a86902918bcbdd41ebb09f1e7b Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 08/12] * zh_CN/manuals.org --- zh_CN/manuals.org | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 zh_CN/manuals.org diff --git a/zh_CN/manuals.org b/zh_CN/manuals.org new file mode 100644 index 0000000..0d38acc --- /dev/null +++ b/zh_CN/manuals.org @@ -0,0 +1,31 @@ +#+title: 手册 | Org 主模式 +#+setupfile: setup.org +#+include: "resources/preamble.html" export html + +* Org 手册 + +Org 手册是介绍 Org 核心功能的一个全面的官方资源。 + +- 作为 [[file:../org.html][单一 HTML 网页]] +- 作为 [[file:../manual/][多个 HTML 网页]] +- 作为 [[file:../org.pdf][一个 PDF 文档]] + +* Org 精简介绍 + +Org 精简介绍更简洁地介绍了 Org 的主要功能。 + +- 作为 [[file:../orgguide.html][单一 HTML 网页]] +- 作为 [[file:../guide/][多个 HTML 网页]] +- 作为 [[file:../orgguide.pdf][一个 PDF 文档]] + +* Worg:社区文档 + +- 作为 [[file:../worg/][HTML]] +- 作为 Git 代码仓库:=~$ git clone https://git.sr.ht/~bzg/worg= +- [[file:../worg/worg-about.html][关于 Worg]]:如何贡献? + +* GNU Emacs 内置 Org 手册 + +GNU Emacs 负责发步其内置组件的手册,包括 Org 的手册。 + +你可在[[https://www.gnu.org/software/emacs/manual/org.html][此处]]查看 GNU Emacs 的 Org 手册。 -- 2.40.0
>From 2dbb99610cda2e404e4e15aba8d509609c4e8da5 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 09/12] * zh_CN/LICENSE.org --- zh_CN/LICENSE.org | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 zh_CN/LICENSE.org diff --git a/zh_CN/LICENSE.org b/zh_CN/LICENSE.org new file mode 100644 index 0000000..dac0e7f --- /dev/null +++ b/zh_CN/LICENSE.org @@ -0,0 +1,7 @@ +# This file is released by its authors and contributors under the GNU +# Free Documentation license v1.3 or later, code examples are released +# under the GNU General Public License v3 or later. + +这个代码仓库的内容根据 [[https://www.gnu.org/licenses/fdl-1.3.html][GNU Free Documentation License version 1.3 or later]] 授权。 + +代码范例与 CSS 样式表根据 [[https://www.gnu.org/licenses/gpl-3.0.html][GNU General Public License v3 or later]] 授权。 -- 2.40.0
From d49277fd6ff2fed1553eda04d7cfe84f4d19da32 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 10/12] * zh_CN/features.org --- zh_CN/features.org | 270 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 270 insertions(+) create mode 100644 zh_CN/features.org diff --git a/zh_CN/features.org b/zh_CN/features.org new file mode 100644 index 0000000..79ab8f7 --- /dev/null +++ b/zh_CN/features.org @@ -0,0 +1,270 @@ +#+title: 功能 | Org +#+setupfile: setup.org +#+include: "resources/preamble.html" export html + +#+begin_export html +<style> + .side-fig img { + filter: invert(1.4%); + box-shadow: none; + max-width: 100%; + } + #content { + max-width: none; + } + body { + padding: 1em 0 0 0; + } + .outline-text-3 p { + padding-bottom: 0.5em; + } + :root { + --body-left: 0 !important; + --body-right: 0 !important; + } +</style> + +<script type="text/javascript" async src="../resources/js/org-quotes.js"></script> +<div class="banner slim"> <p id="a-quote"></p> </div> +#+end_export + +* 多种标记选项 + :PROPERTIES: + :CUSTOM_ID: markup + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :style max-height:12em; :alt 使用文字元素标记文本的例子 +[[file:resources/img/features/simple-syntax.svg]] + +** 描述 + +Org 常被用于构建与管理复杂的工作流程。为此,Org 使用了优美且简单的语法,从最基本的标记到完整的 LaTeX 排版,从纯文本到文学程序,都可以使用 Org 编写而成。 + +以下这个例子包含了所有你开始使用 Org 需要的内容。 + +*** 更多 + +详见手册(英语):[[file:../manual/Markup-for-Rich-Contents.html][标记]] + +* 结构化的编辑@@comment:与导航@@ + :PROPERTIES: + :CUSTOM_ID: editing + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt 演示在 Org 里折叠与显示章节 +[[file:resources/img/features/folding.gif]] + +** 描述 + +Org 里最基础的结构是由可嵌套、可折叠的章节构成的树。你可以使用一个快捷键 ----- =tab= ----- 来折叠、展开整个树。 + +Org 的树结构给用户带来了快速且优雅的导引与强大的信息遮避功能,让你在保持获取需要信息的能力的同时专心于手头的任务。 + +控制章节可见与否只是 Org 的一个小小的功能,而 Org 仍有其它多种工具与命令来为纯文本结构化的编辑带来便利。 Org 的语法让用户把枯燥的任务变成了单个的键盘命令,让用户更着重于内容而不是形式。 + +*** 更多 + +详见手册(英语):[[file:../manual/Document-Structure.html][文档结构]] + +* 透明化的表格处理 + :PROPERTIES: + :CUSTOM_ID: tables + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt 在 Org 中处理表格,移动行列以及运行公式 +[[file:resources/img/features/tables.gif]] + +** 描述 + +Org 自带了一个强大的表格编辑器。 + +按 =tab= 可以左右移动;按 =return= 可以上下移动。 + +在内容发生改变时,表格结构会自动更新。 + +可以从 =.csv= 和 =.tsv= 文件,或直接从当前缓存区中导入表格,也可以把表格导出到任何 Org 支持的格式。 + +Org 表格不只是静态的数据堆积。它也可以被视作一个完整的[[file:../manual/The-Spreadsheet.html][表格]]系统,包含公式、引用等等 ----- 同时不失其作为纯文本系统的简洁与透明。 + +*** 更多 + +详见手册(英语):[[file:../manual/Built_002din-Table-Editor.html][表格编辑器]]、[[file:../manual/The-Spreadsheet.html][表格系统]] + +Worg 教程(英语):[[file:../worg/org-tutorials/tables.html][使用表格工作]]、[[file:../worg/org-tutorials/org-spreadsheet-intro.html][表格系统]] + +* 更优越的源代码 + :PROPERTIES: + :CUSTOM_ID: babel + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt Demonstration of Org Babel executing code blocks +[[file:resources/img/features/babel.gif]] + +** 描述 + +Org 提供的功能远远超过[[https://jupyter.org/][Jupyter]]、[[https://rmarkdown.rstudio.com/][R Markdown]]等计算笔记本。 + +# Program your way. +[[file:../worg/org-contrib/babel/][Org babel]]把可运行的代码区转换为一个完整的[[https://en.wikipedia.org/wiki/Literate_programming][文学编程(英语,外网)]]环境,使得用户可以用输入与输出串联不同的语言、运行环境、甚至不同的设备到同一个系统里。用户就此可以在[[https://en.wikipedia.org/wiki/Don%27t_repeat_yourself][DRY(英语,外网)]]上达到一个前所为有的高度。 + +# Free your code +使用 Org ,你可以非常简单地从同一个文件里提取源代码与生成帮助文档。尽管很多语言支持从代码备注里生成文档,Org 还可以同时在同一个文件里放入开发者指南、用户手册、实现以及测试 ----- 因此,每个 Org 文件是唯一的、不会逐步失去同步的信息源。 + +# Emacs. We will add your technological distinctiveness to our own. +Org 目前支持超过[[file:../worg/org-contrib/babel/languages/index.html][80种不同语言]],并且像[[https://github.com/nnicandro/emacs-jupyter#org-mode-source-blocks][emacs-jupyter]]这样的组件使得用户可以利用 Jupyter 内核生态来使用更多的语言。 + +*** 更多 + +详见手册(英语):[[file:../manual/Working-with-Source-Code.html][使用源代码]] + +Worg(英语):[[file:../worg/org-contrib/babel/languages/index.html][支持语言]]列表 + +* 导出与发表 + :PROPERTIES: + :CUSTOM_ID: publishing + :HTML_CONTAINER_CLASS: side-fig + :END: +# Powerful publishing + +#+attr_html: :class main-image :alt 示范如何把一个 Org 文件导出到 HTML,markdown,PDF 以及纯文本 +[[file:resources/img/features/exports.gif]] + +** 描述 + +Org 是一个撰写与发表的工具 ----- 它既可以是静态网页生成器,也可以是一系列为发表内容提供便利的工具。 + +你使用 Org 的简洁易懂的标记语法来撰写稿件,然后导出到你所选择的任何一种格式。 Org 支持很多格式,其中包含: + +- =HTML= +- \(\LaTeX\) +- =ODT= +- 以及更多! + +开发者可以轻松地为任何格式创造新的导出后端(详见[[file:../worg/dev/org-export-reference.html][ox的文档]]),并且 Org 也被[[https://pandoc.org][Pandoc]]支持。 + +除开导出单一的文件以外,你还可以/发表项目/ ----- 将一个或更多的 =.org= 文件以及其需要的各种资源导出到一个或更多的发表后端。 + +*** 更多 + +冷知识:Org 的网页是由 Org 编写而成! + +详见手册(英语):[[file:../manual/Markup-for-Rich-Contents.html][标记]],[[file:../manual/Exporting.html][导出]],[[file:../manual/Publishing.html][发表]] + +Worg 教程(英语):发表到 [[file:../worg/org-tutorials/org-publish-html-tutorial.html][HTML]] ;发表到 [[file:../worg/org-tutorials/org-latex-export.html][\(\LaTeX\)]] + +* 把握任务的进程 + :PROPERTIES: + :CUSTOM_ID: planning + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt 演示在 Org 里设置计划,管理一个待办事项 +[[file:resources/img/features/planning.gif]] + +** 描述 + +Org 是一个功能齐全的任务计划工具、时间管理工具以及待办事项工具。 + +任何一个章节都可以通过增加例如 =TODO= 或者 =HOLD= 等关键词来被设置成/待办/。你可以由此跟踪纪录此任务的进度。你也可以使用快捷键 =S-<left>= 和 =S-<right>= 来把任务切换到不同状态。 + +需要增加其他的任务状态?没问题。你可以根据你的工作流程自由地设置任务状态。 + +在 Org /日程/(Agenda)里,你可以轻松地查看多个文件里的任务 ----- 你仅需要添加一个任务状态关键词,例如 =TODO=。Org 为以下功能有内置支持:任务优先级、截止日期、计划中任务、标签、打卡等等。/日程/能够使用上述所有功能来整理任务以及设置优先级。因此,在仅仅使用纯文本标记的同时,你可以把一个简单的待办事项列表无缝升级为一个完整的项目管理软件。 + +*** 更多 + +详见手册(英语):[[file:../manual/TODO-Items.html][待办事项]]、处理[[file:../manual/Dates-and-Times.html][日期与时间]] + +* 可执行的日程表 + :PROPERTIES: + :CUSTOM_ID: agendas + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt Org 日程的一个例子,显示了不同的待办关键词、优先级、分类方式以及计划 +[[file:resources/img/features/agenda.svg]] + +** 描述 + +轻松计划你的一天,方式由你而定。 + +在/日程界面/里(一个由你所有待办事项组成的报告),你可以看到你每日、每周、每月的任务。 + +就算你有上百个 =.org= 文件以及上千个任务,日程仍可以让你集中精力攻克你最需要响应的任务 ----- 并且你可以从日程的优先级界面可以直接跳到你手头这个需要完成的任务。 + +日程的默认界面显示了你当周里计划中的、临近截止的、暂停的、以及未完成的待办任务。 + +对这个默认界面不满意?你可以随意修改 Org 日程的配置。你既可以修改其默认界面,也可以创建[[file:../manual/Custom-Agenda-Views.html][自定义界面]]。 + +从某种程度上来说,Org 是一个富有表达力的、能抓取在工作进程里的交互关键点的语言,使你在因生活、工作、娱乐等等需要构建新的工作进程时的步骤变得更加简单易懂。 + +*** 更多 + +详见手册(英语):[[file:../manual/Agenda-Views.html][日程界面]] + +Worg 教程(英语):[[file:../worg/org-tutorials/org-custom-agenda-commands.html][日程命令]] + +* 打卡 + :PROPERTIES: + :CUSTOM_ID: clocking + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt 使用 Org 来纪录每个小任务花费的时间 +[[file:resources/img/features/clocking.svg]] + +** 描述 + +使用 Org /打卡/(clocking)来纪录你花费在任务上的时间。你可以在一天结束之际生成关于你当天如何使用时间的报告。 + +Org 提供了给开始任务与结束任务打卡的快捷键。当你在使用一个 =.org= 文件时,按下 =C-c C-x C-i= 来打卡开始任务,=C-c C-x C-o= 来打卡结束任务。所有的打卡时间都被存储在该任务标题的属性抽屉里。 + +当你在日程界面时,你可以使用 =I= 和 =O= 打卡。 + +*** 更多 + +详见手册(英语):[[file:../manual/Clocking-Work-Time.html][任务打卡]] + +* 从任何地方抓取信息 + :PROPERTIES: + :CUSTOM_ID: capturing + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt 使用 Org Capture 来纪录编辑文件时产生的一个想法 +[[file:resources/img/features/capturing.gif]] + +** 描述 + +你可以/抓取/信息,然后把它加入到一个 =.org= 文件里。 + +你可以从任何地方抓取信息 ----- 可以是一个 Emacs 缓存区,也可以是其它程序,例如你的浏览器、PDF 阅览器等等。 + +抓取模版让你快速且便捷地从各种工作流程中抓取信息,例如增加新任务、引用手册的关联章节、或者保存收据。 + +*** 更多 + +详见手册(英语):[[file:../manual/Capture.html][抓取]] + +* 极度的可扩展性 + :PROPERTIES: + :CUSTOM_ID: extensibiliy + :HTML_CONTAINER_CLASS: side-fig + :END: + +#+attr_html: :class main-image :alt 显示一些自带的以及自定义的链接种类 +[[file:resources/img/features/links.svg]] + +** 描述 + +Org 不只是一般的“可扩展”;它是 /Emacs 级别/的可扩展。 + +Org 起初只是 Emacs 的一个扩展组件。因此,Org 的各方各面都包含了对可扩展性的考量。 + +举一个小小的例子:超链接。当你在更新开发文档时你会经常重复引用到项目的问题列表,例如GitHub Issues。你可以在 Org 文件里添加一个新的 ~issue:~ 链接类型,使得类似~[[issue:74][big bug]]~的链接能够引用到=https://github.com/author/repo/issues/74=。 + +除了超链接,你也可以自定义解析函数、使用 [[https://www.emacswiki.org/emacs/TrampMode][Tramp]] 链接远程设备的文件,等等。 -- 2.40.0
>From de4613ea1a60747c21d0f90d6cbb7ece6b83ca21 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 11/12] * zh_CN/elpa.org: copied from /elpa.org for now --- zh_CN/elpa.org | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 zh_CN/elpa.org diff --git a/zh_CN/elpa.org b/zh_CN/elpa.org new file mode 100644 index 0000000..908136e --- /dev/null +++ b/zh_CN/elpa.org @@ -0,0 +1,71 @@ +#+title: Org Emacs Lisp Package Archive +#+setupfile: setup.org +#+include: "resources/preamble.html" export html + +* Org Emacs Lisp Package Archive (deprecated) + :PROPERTIES: + :CUSTOM_ID: introduction + :END: + +For versions <= 9.5, [[https://orgmode.org][orgmode.org]] hosts Org ELPA archives. + +*Beware that no new Org versions will be released on Org ELPA after +9.5.* + +Add this to your Emacs init file to be able to list the Org mode +archives: + +#+BEGIN_SRC emacs-lisp +(require 'package) +(add-to-list 'package-archives '("org" . "https://orgmode.org/elpa/") t) +#+END_SRC + +Then =M-x list-packages RET= will list both the latest =org= and +=org-plus-contrib= packages. + +- =org= :: Contains the same set of files that are included in GNU + Emacs. + +- =org-plus-contrib= :: Contains these files plus all contribs files, + the ones you used to find in =contrib/= from the [[https://git.sr.ht/~bzg/org-contrib][git repo]]. + +* Installation + :PROPERTIES: + :CUSTOM_ID: installation + :END: + +By default, Emacs loads packages *after* it loads your Emacs init file. + +We recommend intializing packages as /early/ as possible in your Emacs +init file so that your Org configuration will be correctly handled: + +#+BEGIN_SRC emacs-lisp :exports code +;; -*- emacs-lisp -*- +(package-initialize) ;; Initialize & Install Package +;; (setq org-...) ;; Your custom settings +#+END_SRC + +The package initialization should happen *before* you require Org and +set any Org options. + +Also, you may want to set up Package correctly before initializing it: + +#+BEGIN_SRC emacs-lisp :exports code + ;; -*- emacs-lisp -*- + (unless package-archive-contents ;; Refresh the packages descriptions + (package-refresh-contents)) + (setq package-load-list '(all)) ;; List of packages to load + (unless (package-installed-p 'org) ;; Make sure the Org package is + (package-install 'org)) ;; installed, install it if not + (package-initialize) ;; Initialize & Install Package + ;; (setq org-...) ;; Your custom settings +#+END_SRC + +See the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html][GNU Emacs Package manual]] for details. + +* Questions? + :PROPERTIES: + :CUSTOM_ID: questions + :END: + +Report any problem and ask any question on the Org mode [[https://orgmode.org/worg/org-mailing-list.html][mailing list]]. -- 2.40.0
From 91a578f5baee74415845638e376db060486dd915 Mon Sep 17 00:00:00 2001 From: Ruijie Yu <rui...@netyu.xyz> Date: Tue, 11 Apr 2023 01:32:26 +0800 Subject: [PATCH 12/12] * zh_CN/quickstart.org --- zh_CN/quickstart.org | 265 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 265 insertions(+) create mode 100644 zh_CN/quickstart.org diff --git a/zh_CN/quickstart.org b/zh_CN/quickstart.org new file mode 100644 index 0000000..ddf1b3e --- /dev/null +++ b/zh_CN/quickstart.org @@ -0,0 +1,265 @@ +#+TITLE: 快速开始 | Org 主模式 +#+setupfile: setup.org +#+include: "resources/preamble.html" export html + +* 开始使用 Org@@comment:Get Started@@ + :PROPERTIES: + :CUSTOM_ID: getting-started + :END: + +简单来说,Org 与任何其它的标记语言一样:你可以在任何文本编辑器里使用 [[file:../worg/dev/org-syntax.html][Org 语法]] 编辑文档。 + +然而,为了体验 Org 全部的潜力,你需要一个能够把 Org 语法转换为一个可互动文档的编辑器。 + +#+begin_center +#+attr_html: :class btn +*[[file:../org.html#Installation][安装 Org]]* +#+end_center + +* 文档引言@@comment:Preamble@@ + :PROPERTIES: + :CUSTOM_ID: preamble + :END: + +在文件的最开始(第一个章节标题之前),你常常需要设置标题、作者以及其它[[file:../manual/Export-Settings.html][导出选项]]。 + +#+BEGIN_SRC org +,#+title: Org 的荣光 +,#+author: Org 用户 +#+END_SRC + +* 章节标题@@comment:Heading@@ + :PROPERTIES: + :CUSTOM_ID: headings + :END: + +由星号 ~*~ 开始的行被称作[[file:../worg/dev/org-syntax.html#Headlines_and_Sections][章节标题(heading)]]。 + +一个星号 ~*~ 代表一级章节标题,两个星号 ~**~ 代表二级章节标题,等等。 + +#+BEGIN_SRC org + ,* 欢迎来到 Org + ,** 子章节标题 + 每个额外的 ~*~ 为章节的深度增加一级。 +#+END_SRC + +简单来说,章节标题代表了一个章节的开始。然而,任何章节也可以成为一个[[file:../manual/TODO-Items.html][待办事项]]。 + +待办事项是 Org 用来跟踪、整理各类的任务的基本模块。 + +若要把一个现有的章节标题转换为一个待办事项,仅需在其开头加上一个待办关键词,例如 ~TODO~ 或者 ~HOLD~。 + +#+BEGIN_SRC org + ,* TODO 向世界介绍 Org + ,** TODO 创建一个快速开始指南 +#+END_SRC + +* 标记@@comment:markup@@ + :PROPERTIES: + :CUSTOM_ID: markup + :END: + +# 代码 = code; 逐字 = verbatim +若要在 Org 里标记文字,仅需要在其两侧使用标记字符。*加粗*、/斜体/、_下划线_都很简单;你甚至能够轻松地使用+删除线+。你可以任意组合这些基本的标记,但需要记住一点,若使用了~代码~或=逐字=这两个标记之一,它们需要在这个组合的*_~最里侧~_*,因为它们包含的内容是=按字面=解析的。 + +#+begin_example +若要在 Org 里标记文字,仅需要在其两侧使用标记字符。*加粗*、/斜体/、_下划线_都很简单;你甚至能够轻松地使用+删除线+。你可以任意组合这些基本的标记,但需要记住一点,若使用了~代码~或=逐字=这两个标记之一,它们需要在这个组合的*_~最里侧~_*,因为它们包含的内容是=按字面=解析的。 +#+end_example + +可在[[file:../worg/dev/org-syntax.html#Emphasis_Markers][标记符号(英语)]]里查看更多信息。 + +** 中文用户 +中文用户_:由于 Org 的限制,标记字符的内侧必须不是空格,而外侧必须是空格(包含换行等)。因此,中文用户需要在使用标记时,可以在有需要时使用零宽空格(16进制代码~#x200b~,名称为~ZERO WIDTH SPACE~)。使用方法: + +(原生 Emacs)快捷键: +#+begin_example +C-x 8 RET 200b RET +#+end_example + +使用 Emacs Lisp: +#+begin_src emacs-lisp +(insert-char #x200b) +#+end_src + +* 列表@@comment:Lists@@ + :PROPERTIES: + :CUSTOM_ID: lists + :END: + +# 无序列表 = unordered list; 有序列表 = ordered list +无序列表由~+~、~-~、~*~开头[fn::~*~不能被用作一行的最开头,因为这样它会被解析成一个章节标题。]。有序列表由~1.~、~1)~、~A.~、~A)~开头。有序与无序符号可以以任意顺序嵌套。 + +#+BEGIN_SRC org + 采购单: + 1. 牛奶 + 2. 鸡蛋 + - 有机 + 3. 调料 + + 糖 + + 盐 +#+END_SRC + +# 勾选项 = checkbox +列表可包含勾选项~[ ]~、~[-]~、~[X]~。 +#+BEGIN_SRC org + - [ ] 未开始 + - [-] 进行中 + - [X] 已完成 +#+END_SRC + +# 标签 = tag +列表也可同时包含标签。 +#+BEGIN_SRC org + - [ ] 水果 :: 买苹果 + - [X] 蔬菜 :: 买胡萝卜 +#+END_SRC + +* 链接 + :PROPERTIES: + :CUSTOM_ID: links + :END: + +创建链接时把目标放在两对*半角*方括号中,例如:~[[目标]]~。你也可以在链接里、目标之后添加描述:~[[目标][描述]]~。 + +这个顺序相当好记,因为这跟 HTML 的 =<a>= 标记 ~<a href="目标">描述</a>~ 一样,并且你不可能混淆不同种类的括号,因为 Org 语法里只用中括号。 + +Org 支持一系列不同的链接目标类型,并且你还可以[[file:../manual/Adding-Hyperlink-Types.html][添加你自己的目标类型]]。链接目标类型由其前缀~类型:~表示,例如:~[[类型:目标]]~。若没有提供类型,Org 会在当前文件里搜索一个符合~目标~的章节标题。 + +举个例子: +#+BEGIN_EXAMPLE +[[https://orgmode.org][一个网页]] +[[file:~/Pictures/dank-meme.png]] +[[之前的章节标题][此文档里一个之前的章节标题]] +#+END_EXAMPLE + +** 更多信息 +更多关于链接的信息参见手册(英语):[[file:../manual/Internal-Links.html][内部链接]]、[[file:../manual/External-Links.html][外部链接]]。 + +* 图像 + :PROPERTIES: + :CUSTOM_ID: images + :END: + +Org 会在导出时自动识别且显示图片链接。你只需要链接一个图片,且不提供描述既可。\\ +~[[https://orgmode.org/resources/img/quickstart.svg]]~ + +#+attr_html: :height 120px +[[file:../resources/img/quickstart.svg]] + +在你电脑里的图片也可以按 =C-c C-x C-v= 在 Emacs 缓存区里显示。 + +* 区块 + :PROPERTIES: + :CUSTOM_ID: blocks + :END: + +Org 主模式里可以包含区块 =#+BEGIN= …… =#+END=,不同的区块对应不同的用途。基本的区块包括:引用(quote),举例(example),以及源码(src)。 + +若你只需要等宽文字,你可以使用举例区块。 +#+BEGIN_SRC org +,#+begin_example +monospace 等宽 +,#+end_example +#+END_SRC + +然而,你不能在举例区块里使用 [[file:../worg/org-contrib/babel/][Org Babel]] ----- 你需要使用源码区块。源码区块提供了语法高亮、代码运行、文学编程等等。 +#+BEGIN_SRC org +,#+begin_src emacs-lisp +(message "Hello world") +,#+end_src +#+END_SRC + +** 更多信息 +一个”你好世界“的例子根本不足以向你展示 Org 与源代码的[[file:../manual/Working-with-Source-Code.html][所有功能]]。 + +* 表格 + :PROPERTIES: + :CUSTOM_ID: tables + :END: + +Org 主模式内置了一个表格编辑器,并且支持各种与元素引用以及公式的功能。 + +最简单的表格仅仅是由 ~|~ 分隔开的文本。 +#+BEGIN_SRC org +| 我 | 是 | 一个 | 表格 | +| 我 | 有 | 两行 | ! | +#+END_SRC + +这是在一篇论文([[doi:10.18637/jss.v046.i03][Schulte /et al./ 2012]])里的一个表格,对比了现有的文学编程与可重复研究工具。 + +#+BEGIN_SRC org +| Tool | Literate programming? | Reproducible Research? | Languages | +|--------------+-----------------------+------------------------+-----------| +| Javadoc | partial | no | Java | +| Haskell .lhs | partial | no | Haskell | +| noweb | yes | no | any | +| Sweave | partial | yes | R | +| Org-mode | yes | yes | any | +#+END_SRC + +担心无法在文本表格中对齐?你只需按一个键 ----- =tab=。 + +* 注释 + :PROPERTIES: + :CUSTOM_ID: comments + :END: + +在 Org 里有很多种方法添加注释: + +- 行注释:用~#~开头。 +- 行内注释:把注释包起来(~@@comment:就像这样@@~)。 +- 区块注释:用~#+BEGIN_COMMENT~和~#+END_COMMENT~把注释包起来。 +- 章节注释:在章节标题前加上 ~COMMENT~ 可以把这整个章节变成注释[fn::还有一些对章节的更精细的操作,包括使用特殊章节标签~:ARCHIVE:~以及~:noexport:~。]。 + +#+BEGIN_SRC org +# 一个行注释 + +这是一个@@comment:行内@@注释。 + +行内注释可同时被用作行末注释。@@comment:~#~没有用@@ +这是因为~#~只在作为一行第一个非空格字符时才是行注释。 + +,#+begin_comment +这是一个区块注释。 +它可以跨越多行,或者其它标记与区块定义。 +,#+begin_src emacs-lisp +(+ 1 2) +,#+end_src +,#+end_comment + +,* 一个顶层章节标题 +,** COMMENT 这个章节与其子章节是注释 +,*** 这个章节继承了关键词=COMMENT= +这段文字是注释 +,** 这个章节不是注释 +这段文字会被导出,且代码区块会被运行。 +#+END_SRC + +** 中文用户 +_中文用户_:=@@comment:行内注释@@=两侧需要使用零宽空格,详见[[*标记][此章节]]。 + +* 宏 + :PROPERTIES: + :CUSTOM_ID: macros + :END: + + Org 的语法拥有更多高级功能,[[file:../manual/Macro-Replacement.html][这里]]有一个简单的例子。 + +#+BEGIN_SRC org +,#+macro: attn _*/$1/*_ +{{{attn(注意!这个文本有所有标记!)}}} + +,#+html_head: <style>.red{color:red;}</style> +,#+latex_header: \usepackage{xcolor} +,#+macro: red @@html:<span class="red">$1</span>@@@@latex:\textcolor{red}{$1}@@ +普通文本。{{{red(红色文本。)}}}更多普通文本。 +#+END_SRC + +* 下一步 + :PROPERTIES: + :CUSTOM_ID: next-steps + :END: + +在寻找某一个话题?试着读读[[file:../manual/][手册(英语)]]([[file:../org.pdf][PDF]])吧。 + +在寻找这个快速开始与手册之间的内容?试试[[file:../guide/][指导(英语)]]([[file:../orgguide.pdf][PDF]])吧。 -- 2.40.0
-- Best, RY