~bzg/worg

ref: 559025d3195c39306b5a5546c06a4e375fe4ff7f worg/index.org -rw-r--r-- 7.6 KiB
559025d3Bastien org-contribute.org: Add a note to maintainers 3 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
#+title:      Hello Worg, the Org-Mode Community!
#+author:     Worg people
#+startup:    align fold nodlcheck hidestars oddeven intestate
#+seq_todo:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
#+tags:       Write(w) Update(u) Fix(f) Check(c)
#+language:   en
#+category:   worg
#+options:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc

# 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.

# For this dynamic block to work, you need to add code/elisp/worg.el in
# your load-path.

# Let say that you like [[http://www.gnu.org/software/emacs/][Emacs]] and that you like using [[https://orgmode.org][org-mode]] for editing
# structured files in Emacs.  Then you might want to /share/ some =.org=
# files and ask people to edit them with you.  This is what *Worg* is [[file:worg-about.org][about]]:
# collaboratively editing Org files to build a knowledge database about
# =.org= itself (and planning-related stuff.)

* Worg documentation on your machine

: git clone https://git.sr.ht/~bzg/worg

* Introduction to Org-Mode and Worg

[[https://orgmode.org][Org-mode]] is a powerful system for organizing your complex life with
simple plain-text files.  It seamlessly integrates all your notes,
mindmaps, TODO lists, calendar, day planner, and project schedules
into a single system that can be easily searched (e.g. by grep),
encrypted (e.g. by [[http://www.gnupg.org/][GnuPG]]), backed up and synced (e.g.  by Dropbox),
imported/exported, and [[file:org-faq.org::*Org-mode on mobile devices][accessed on the go]] (e.g. on an iPhone or
Android smartphone).  It can even be used for authoring web pages and
documents.

Check out some [[file:org-screenshots.org][screenshots of Org-mode]] in action.  See [[file:org-quotes.org][what people
have to say]] about Org-mode, and read a few [[file:org-testimonies/index.org][user stories]]!

Org-mode is distributed as part of the [[http://www.gnu.org/software/emacs/][Emacs]] text editor and runs
wherever Emacs runs, including on GNU-Linux, Windows, and Mac.
Written by Carsten Dominik, it is currently maintained by Bastien
Guerry and used by many helpful people who, like you, are desperate to
get and stay organized.  You can read more on [[file:org-maintenance.org][how Org-mode is
maintained]].

The page you're reading is part of =Worg=, a section of the [[https://orgmode.org/][Org-mode web
site]] that is written by a volunteer community of Org-mode fans: [[https://git.sr.ht/~bzg/worg][Worg
sources are hosted here]].

It includes tutorials, ideas, code snippets, etc., shared to make your
introduction and customization of Org-mode as easy as possible.  Worg
is maintained by a group of [[file:worgers.org][Worg contributors]], and maybe [[file:todo.org][you]].

* Org-Mode Resources
  :PROPERTIES:
  :ID:       A6F83C16-B1B9-405A-B996-8D2CA1274DEB
  :CUSTOM_ID: resources
  :END:

** Learn Org-Mode
  :PROPERTIES:
  :CUSTOM_ID: learn
  :END:

#+index: Tutorials
#+index: Glossary

- [[file:org-tutorials/index.org][Org-mode Tutorials]] : Your best starting points for a relaxed overview
- [[https://orgmode.org/manual/index.html][Org-mode Manual]] : Extensive and complete documentation
- [[https://orgmode.org/guide/index.html][Org-mode Guide]] : Not extensive, but complete documentation (also in [[http://www.davidam.com/docu/orgguide.es.html][spanish]] and [[https://gitlab.com/bzg/orgguide_fr][french]])
- [[file:org-glossary.org][Org-mode Glossary]] : An explanation of org-mode terminology
- [[file:org-configs/index.org][Org-mode configuration]] : Beginner's customization guide, examples, survey, and a list of hooks
- [[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 and the French translation ([[file:code/latex/fr-orgcard.tex][tex]] - [[file:images/bzg/fr-orgcard.pdf][pdf]])

** Get Help with Org-Mode
  :PROPERTIES:
  :CUSTOM_ID: get-help
  :END:

- [[file:org-faq.org][Org-mode FAQ]] : Check here before writing to the mailing list
- [[file:org-mailing-list.org][Org-mode Mailing List]] : For unanswered questions, suggestions, and discussion
- [[file:org-irc.org][Org-mode IRC Channel]] : For live Q&A, go to =#org-mode= on [[http://freenode.net/][Freenode]]
- Check [[file:org-web-social.org][latest posts]] on reddit.com and stackoverflow.com
- Browse [[https://www.reddit.com/r/orgmode/][Org-mode discussions on reddit.com]]
- Browse [[https://stackoverflow.com/questions/tagged/org-mode][Org-mode questions on stackoverflow.com]]

** Use Org-Mode Effectively
  :PROPERTIES:
  :CUSTOM_ID: use-effectively
  :END:

- Use Org-mode as a [[file:org-gtd-etc.org][task management system]] (GTD and Pomodoro)
- Author [[file:org-blog-wiki.org][Blogs and Wikis with Org-mode]] (see [[file:org-web.org::*Personal Web Sites][Personal Web Sites]])
- Synchronize org-mode files 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]]
- Integrate [[file:org-mac.org][Org-mode with Mac OS X]]

** Dive Deeper into Org-Mode
  :PROPERTIES:
  :CUSTOM_ID: more-resources
  :END:

- [[file:org-hacks.org][Org-mode Hacks]] : Copy code snippets from other users
- [[file:dev/index.org][Org-mode for developers]] : Reference documentation for developers
- [[file:org-blog-articles.org][Blog posts]] : Read a variety of articles from introductions to specific customizations
- [[file:org-contrib/babel/index.org][Babel]] : [[https://en.wikipedia.org/wiki/Literate_programming][Literate programming]] with active source code blocks
- [[file:org-tools/index.org][Org-mode parsing libraries]] : Parse and analyze =.org= files
- [[file:org-translators.org][Org-mode conversion tools]]  : Import into and export out of Org-mode
- [[file:org-dependencies.org][Org-mode dependencies]] : Dependencies on external packages for advanced functionality
- [[file:org-papers.org][Org-papers]] : Whitepapers and books about Org-mode
- [[file:org-tidy.org][Keep your Org-files tidy]] : Suggestions for attentive users

** Check Out Third-Party Contributions
  :PROPERTIES:
  :CUSTOM_ID: third-party-contributions
  :END:

- [[file:org-contrib/index.org][Contributed packages]], including extensive documentation
- [[file:org-devel.org][Additions under development]]

* Help us sustain our efforts

Org-mode is maintained and developed by volunteers on their free time.

You can help us dedicate more of our time by making a donation or by
[[file:org-contribute.org][contributing]] directly.

** Worg maintenance
   :PROPERTIES:
   :CUSTOM_ID: worg-maintaince
   :END:

- [[file:worg-about.org][About the Worg project]]
- [[file:worg-setup.org][How Worg is set up on the server]]
- [[file:todo.org][The Worg TODO file]]
- [[file:worg-about.org::*How to use git for Worg][How to use git for Worg]]
- [[file:worg-editing.org][Conventions and tools for editing Worg]]
- [[file:worg-git-ssh-key.org][How to create your own SSH key?]]
- [[https://git.sr.ht/~bzg/worg/log][Recent changes to Worg]]
- [[https://orgmode.org/worg/sources/][Org-mode source documents of all Worg pages]]
- [[file:archive/index.org][The archive]] (obsolete content)

** Join the Community

Check out the list of [[file:worgers.org][Worgers and their User Pages]] and a few [[file:org-people.org][profiles
of the Org-mode Community]] (with photos ☺).  You can also meet other
users in the flesh at [[file:orgcamps.org][OrgCamps]].

** Git'r done!

If you like losing your time by reading stuff on how to get organized,
go and check the [[file:gitrdone.org][Git'r done!]] page.