index.org

   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
  10
  11 # For this dynamic block to work, you need to add code/elisp/worg.el in
  12 # your load-path.
  13
  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.)
  19
  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]]
  23
  24 * Introduction to Org-Mode and Worg
  25
  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.
  34
  35 Check out some [[file:org-screenshots.org][screenshots of Org-mode]] in action.  See [[file:org-quotes.org][what people
  36 have to say]] about Org-mode, and read a few [[file:org-testimonies/index.org][user stories]]!
  37
  38 Org-mode is distributed as part of the popular [[http://www.gnu.org/software/emacs/][Emacs]] text editor and
  39 runs wherever Emacs runs, including on GNU-Linux, Windows, and Mac.
  40 Written by Carsten Dominik, it is currently maintained by Bastien
  41 Guerry and used by many helpful people who, like you, are desperate to
  42 get and stay organized.  The way Org-mode maintenance is done is
  43 described [[file:org-maintenance.org][here]].
  44
  45 The page you're reading is part of =Worg=, a section of the [[https://orgmode.org/][Org-mode web
  46 site]] that is written by a volunteer community of Org-mode fans.  It
  47 includes tutorials, ideas, code snippets, etc., shared to make your
  48 introduction and customization of Org-mode as easy as possible.  Worg
  49 is maintained by Matthew Lundin, a group of [[file:worgers.org][Worg contributors]], and
  50 maybe [[file:worg-todo.org][you]].
  51
  52 * Help us sustain our efforts
  53
  54 Org-mode is maintained and developed by volunteers on their free time.
  55
  56 You can help us dedicate more of our energy by [[file:donate.org][making a donation]].
  57
  58 Of course, you can also join the party and [[file:org-contribute.org][contribute]] with code and
  59 documentation.
  60
  61 * Org-Mode Resources
  62   :PROPERTIES:
  63   :ID:       A6F83C16-B1B9-405A-B996-8D2CA1274DEB
  64   :END:
  65
  66 ** Learn Org-Mode
  67
  68 #+index: Tutorials
  69 #+index: Glossary
  70
  71 - [[https://orgmode.org/][Org-mode Main Page]]               : The official page for Org-mode
  72 - [[file:org-tutorials/index.org][Org-mode Tutorials]]               : Your best starting point
  73 - [[file:org-glossary.org][Org-mode Glossary]]                : An explanation of org-mode terminology
  74 - [[https://orgmode.org/manual/index.html][Org-mode Manual]]               : Extensive and complete documentation
  75 - [[https://orgmode.org/guide/index.html][Org-mode Guide]]                   : Not extensive, but complete documentation
  76   - Spanish translation of the orgguide ([[https://github.com/davidam/orgguide-es][repository]] - [[http://www.davidam.com/docu/orgguide.es.html][html]])
  77   - French translation of the orgguide ([[https://gitlab.com/bzg/orgguide_fr][repository]])
  78 - [[file:org-configs/index.org][Org-mode configuration]]           : Beginner's customization guide, examples, survey,
  79   and a list of all hooks
  80 - [[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.
  81   - French translation of the orgcard ([[file:code/latex/fr-orgcard.tex][tex]] - [[file:images/bzg/fr-orgcard.pdf][pdf]])
  82 - [[file:exporters/index.org][New exporter]]            : Preliminary documentation for the new exporter.
  83
  84 ** Library of Babel
  85
  86 A collection of generally useful code blocks available as a [[file:library-of-babel.org][HTML]] or
  87 [[https://orgmode.org/worg/library-of-babel.org][.org]] file.
  88
  89 ** Get Help with Org-Mode
  90
  91 - [[file:org-faq.org][Org-mode FAQ]]      : Check here before writing to the mailing list
  92 - [[file:org-mailing-list.org][Org-mode Mailing List]]   : For unanswered questions, suggestions, and
  93   discussion
  94 - Org-mode IRC Channel    : For live Q&A, go to =#org-mode= on [[http://freenode.net/][Freenode]]
  95
  96 ** Use Org-Mode Effectively
  97
  98 - Use Org-mode as a [[file:org-gtd-etc.org][task management system]] (perfect for GTD and the
  99   Pomodoro Technique)
 100 - Author [[file:org-blog-wiki.org][Blogs and Wikis with Org-mode]] (see [[file:org-web.org][example web pages]])
 101 - Integrate [[file:org-mac.org][Org-mode with Mac OS X]]
 102 - 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]]
 103
 104 ** Dive Deeper into Org-Mode
 105
 106 - [[file:dev/index.org][Org-mode for developers]] : reference documentation for developers
 107 - [[file:org-blog-articles.org][Blog posts]]              : Read a variety of articles from introductions to
 108   specific customizations
 109 - [[file:org-hacks.org][Org-mode Hacks]]          : Copy code snippets from other users
 110 - [[file:org-contrib/babel/index.org][Org Babel]] : Learn about [[https://en.wikipedia.org/wiki/Literate_programming][Literate programming]] within Org-mode
 111 - Tools
 112   - [[file:org-translators.org][Org-mode conversion tools]]  : Import into and export out of Org-mode
 113   - [[file:org-tools/index.org][Org-mode parsing libraries]] : Parse and analyze .org files
 114 - [[file:org-dependencies.org][Org-mode dependencies]] : Dependencies on external packages for advanced
 115   functionality [Work in progress]
 116 - [[file:org-papers.org][Org-papers]] : Whitepapers and books about Org-mode
 117
 118 ** Check Out Third-Party Contributions
 119
 120 - [[file:org-contrib/index.org][Contributed packages]], including extensive documentation
 121 - Repository of contributed code:
 122   1. the =contrib/= directory of the Org-mode package
 123   2. the [[https://orgmode.org/worg/code/][code]] directory of Worg
 124      - [[https://orgmode.org/worg/code/org-info-js/index.html][org-info-js]] by Sebastian Rose: great javascript
 125        tool to navigate through a HTML page (as exported by Org) the way you
 126        navigate through an Org or an info manual, i.e. supporting folding,
 127        previous/next buttons, etc.
 128 - [[file:org-devel.org][Additions under development]]
 129
 130 # FIXME: should we add this?
 131
 132 # [[file:org-survey.org][Org survey results]]
 133 # [[file:org-code/index.org][Org add-ons]] should be documented here and maybe not in the manual?
 134
 135 * Join the Community
 136
 137 - Check out the list of [[file:worgers.org][Worgers and their User Pages]] and a few
 138   [[file:org-people.org][profiles of the Org-mode Community]] (with photos ☺)
 139
 140 - Meet other users in the flesh at [[file:orgcamps.org][OrgCamps]]
 141
 142 ** Help out
 143
 144 - Improve Worg by sharing your knowledge about Org-mode: see
 145   [[Maintenance of Worg]].
 146
 147 - Improve Org-mode:
 148   - Send [[https://orgmode.org/org.html#Feedback][bug reports]] after checking the [[file:org-issues.org][issue tracker]]
 149   - Help [[file:org-tests/index.org][test]]
 150   - [[file:org-contribute.org][Contribute to Org-mode]]
 151
 152 * Maintenance of Worg
 153
 154 - Intro
 155   - [[file:worg-about.org][About the Worg project]]
 156   - [[file:worg-setup.org][How Worg is set up on the server]]
 157   - [[file:worg-maintenance.org][About Worg maintainer and gardeners]]
 158 - Tasks
 159   - [[file:worg-todo.org][The Worg TODO file]]
 160 - Howtos
 161   - [[file:worg-git.org][An introduction to git for Worgers]]
 162   - [[file:worg-editing.org][Conventions and tools for editing Worg]]
 163   - [[file:worg-git-ssh-key.org][How to create your own SSH key?]]
 164 - Miscellaneous
 165   - [[https://code.orgmode.org/bzg/worg/commits/master][Recent changes to Worg]]
 166   - [[https://orgmode.org/worg/sources/][Org-mode source documents of all Worg pages]]
 167
 168 * Git'r done!
 169
 170 If you like losing your time by reading stuff on how to get organized,
 171 go and check the [[file:gitrdone.org][Git'r done!]] page.