org-contribute: Add Aaron L. Zeng
[worg.git] / index.org
blob417beed890ae102624dd70077691aa8c4d1924f3
1 #+title:      Hello Worg, the Org-Mode Community!
2 #+author:     Worg people
3 #+email:      mdl AT imapmail DOT org
4 #+startup:    align fold nodlcheck hidestars oddeven intestate
5 #+seq_todo:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
6 #+tags:       Write(w) Update(u) Fix(f) Check(c)
7 #+language:   en
8 #+category:   worg
9 #+options:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
11 # For this dynamic block to work, you need to add code/elisp/worg.el in
12 # your load-path.
14 # Let say that you like [[http://www.gnu.org/software/emacs/][Emacs]] and that you like using [[https://orgmode.org][org-mode]] for editing
15 # structured files in Emacs.  Then you might want to /share/ some =.org=
16 # files and ask people to edit them with you.  This is what *Worg* is [[file:worg-about.org][about]]:
17 # collaboratively editing Org files to build a knowledge database about
18 # =.org= itself (and planning-related stuff.)
20 # We put true links to the server, as sitemap.org and theindex.org are
21 # generated on the server during the publication
22 [[https://orgmode.org/worg/sitemap.html][Sitemap]] and [[https://orgmode.org/worg/theindex.html][index]]
24 * Introduction to Org-Mode and Worg
26 [[https://orgmode.org][Org-mode]] is a powerful system for organizing your complex life with
27 simple plain-text files.  It seamlessly integrates all your notes,
28 mindmaps, TODO lists, calendar, day planner, and project schedules
29 into a single system that can be easily searched (e.g. by grep),
30 encrypted (e.g. by [[http://www.gnupg.org/][GnuPG]]), backed up and synced (e.g.  by Dropbox),
31 imported/exported, and [[file:org-faq.org::*MobileOrg][accessed on the go]] (e.g. on an iPhone or
32 Android smartphone).  It can even be used for authoring web pages and
33 documents.
35 Check out some [[file:org-screenshots.org][screenshots of Org-mode]] in action.  See [[file:org-quotes.org][what people have to
36 say]] about Org-mode, and read a few [[file:org-testimonies/index.org][user stories]]!
38 Org-mode is distributed as part of the popular [[http://www.gnu.org/software/emacs/][Emacs]] text editor and runs
39 wherever Emacs runs, including on GNU-Linux, Windows, and Mac.  Written by
40 Carsten Dominik, it is currently maintained by Bastien Guerry and used by
41 many helpful people who, like you, are desperate to get and stay organized.
43 The page you're reading is part of =Worg=, a section of the [[https://orgmode.org/][Org-mode web
44 site]] that is written by a volunteer community of Org-mode fans.  It
45 includes tutorials, ideas, code snippets, etc., shared to make your
46 introduction and customization of Org-mode as easy as possible.  Worg is
47 maintained by Matthew Lundin, a group of [[file:worgers.org][Worg contributors]], and maybe [[file:worg-todo.org][you]].
49 * Org-Mode Resources
50   :PROPERTIES:
51   :ID:       A6F83C16-B1B9-405A-B996-8D2CA1274DEB
52   :END:
54 ** Learn Org-Mode
56 #+index: Tutorials
57 #+index: Glossary
59 - [[https://orgmode.org/][Org-mode Main Page]]               : The official page for Org-mode
60 - [[file:org-tutorials/index.org][Org-mode Tutorials]]               : Your best starting point
61 - [[file:org-glossary.org][Org-mode Glossary]]                : An explanation of org-mode terminology
62 - [[https://orgmode.org/manual/index.html][Org-mode Manual]]               : Extensive and complete documentation
63 - [[https://orgmode.org/guide/index.html][Org-mode Guide]]                   : Not extensive, but complete documentation
64   - Spanish translation of the orgguide ([[https://github.com/davidam/orgguide-es][repository]] - [[http://www.davidam.com/docu/orgguide.es.html][html]])
65   - French translation of the orgguide ([[https://gitlab.com/bzg/orgguide_fr][repository]])
66 - [[file:org-configs/index.org][Org-mode configuration]]           : Beginner's customization guide, examples, survey,
67   and a list of all hooks
68 - [[file:orgcard.org][Org-mode reference card]]          : check the [[file:orgcard.org][HTML]], [[https://orgmode.org/orgcard.pdf][pdf]] and [[https://orgmode.org/orgcard.txt][ASCII]] versions.
69   - French translation of the orgcard ([[file:code/latex/fr-orgcard.tex][tex]] - [[file:images/bzg/fr-orgcard.pdf][pdf]])
70 - [[file:exporters/index.org][New exporter]]            : Preliminary documentation for the new exporter.
72 ** Library of Babel
74 A collection of generally useful code blocks available as a [[file:library-of-babel.org][HTML]] or
75 [[https://orgmode.org/worg/library-of-babel.org][.org]] file.
77 ** Get Help with Org-Mode
79 - [[file:org-faq.org][Org-mode FAQ]]      : Check here before writing to the mailing list
80 - [[file:org-mailing-list.org][Org-mode Mailing List]]   : For unanswered questions, suggestions, and
81   discussion
82 - Org-mode IRC Channel    : For live Q&A, go to =#org-mode= on [[http://freenode.net/][Freenode]]
84 ** Use Org-Mode Effectively
86 - Use Org-mode as a [[file:org-gtd-etc.org][task management system]] (perfect for GTD and the
87   Pomodoro Technique)
88 - Author [[file:org-blog-wiki.org][Blogs and Wikis with Org-mode]] (see [[file:org-web.org][example web pages]])
89 - Integrate [[file:org-mac.org][Org-mode with Mac OS X]]
90 - Synchronize org-mode files easily with [[https://github.com/simonthum/git-sync][git-sync]], a [[file:org-tutorials/org-vcs.org][VCS of your choice]], or [[file:org-tutorials/unison-sync.org][Unison]]
92 ** Dive Deeper into Org-Mode
94 - [[file:dev/index.org][Org-mode for developers]] : reference documentation for developers
95 - [[file:org-blog-articles.org][Blog posts]]              : Read a variety of articles from introductions to
96   specific customizations
97 - [[file:org-hacks.org][Org-mode Hacks]]          : Copy code snippets from other users
98 - [[file:org-contrib/babel/index.org][Org Babel]] : Learn about [[https://en.wikipedia.org/wiki/Literate_programming][Literate programming]] within Org-mode
99 - Tools
100   - [[file:org-translators.org][Org-mode conversion tools]]  : Import into and export out of Org-mode
101   - [[file:org-tools/index.org][Org-mode parsing libraries]] : Parse and analyze .org files
102 - [[file:org-dependencies.org][Org-mode dependencies]] : Dependencies on external packages for advanced
103   functionality [Work in progress]
104 - [[file:org-papers.org][Org-papers]] : Whitepapers and books about Org-mode
106 ** Check Out Third-Party Contributions
108 - [[file:org-contrib/index.org][Contributed packages]], including extensive documentation
109 - Repository of contributed code:
110   1. the =contrib/= directory of the Org-mode package
111   2. the [[https://orgmode.org/worg/code/][code]] directory of Worg
112      - [[https://orgmode.org/worg/code/org-info-js/index.html][org-info-js]] by Sebastian Rose: great javascript
113        tool to navigate through a HTML page (as exported by Org) the way you
114        navigate through an Org or an info manual, i.e. supporting folding,
115        previous/next buttons, etc.
116 - [[file:org-devel.org][Additions under development]]
118 # FIXME: should we add this?
120 # [[file:org-survey.org][Org survey results]]
121 # [[file:org-code/index.org][Org add-ons]] should be documented here and maybe not in the manual?
123 * Join the Community
125 - Check out the list of [[file:worgers.org][Worgers and their User Pages]] and a few
126   [[file:org-people.org][profiles of the Org-mode Community]] (with photos ☺)
127 - Meet other users in the flesh at [[file:orgcamps.org][OrgCamps]]
129 ** Help out
131 - Improve Worg by sharing your knowledge about Org-mode: see [[Maintenance of Worg]].
132 - Improve Org-mode:
133   - Send [[https://orgmode.org/org.html#Feedback][bug reports]] after checking the [[file:org-issues.org][issue tracker]]
134   - Help [[file:org-tests/index.org][test]]
135   - [[file:org-contribute.org][Contribute to Org-mode]]
137 * Maintenance of Worg
139 - Intro
140   - [[file:worg-about.org][About the Worg project]]
141   - [[file:worg-setup.org][How Worg is set up on the server]]
142   - [[file:worg-maintainance.org][About Worg maintainer and gardners]]
143 - Tasks
144   - [[file:worg-todo.org][The Worg TODO file]]
145 - Howtos
146   - [[file:worg-git.org][An introduction to git for Worgers]]
147   - [[file:worg-editing.org][Conventions and tools for editing Worg]]
148   - [[file:worg-git-ssh-key.org][How to create your own SSH key?]]
149 - Miscellaneous
150   - [[https://code.orgmode.org/bzg/worg/commits/master][Recent changes to Worg]]
151   - [[https://orgmode.org/worg/sources/][Org-mode source documents of all Worg pages]]
153 ** Latest changes to the Worg git repository
155 #+begin_export html
156 <script language="JavaScript" src="http://feed2js.org//feed2js.php?src=http%3A%2F%2Forgmode.org%2Fw%2F%3Fp%3Dworg.git%3Ba%3Drss%3Bopt%3D--no-merges&num=10&au=y&date=y&targ=y&utf=y"  charset="UTF-8" type="text/javascript"></script>
158 <noscript>
159 <a href="http://feed2js.org//feed2js.php?src=http%3A%2F%2Forgmode.org%2Fw%2F%3Fp%3Dworg.git%3Ba%3Drss%3Bopt%3D--no-merges&num=10&au=y&date=y&targ=y&utf=y&html=y">View RSS feed</a>
160 </noscript>
161 #+end_export
163 * Git'r done!
165 If you like losing your time by reading stuff on how to get organized,
166 go and check the [[file:gitrdone.org][Git'r done!]] page.