org-tutorials/index.org

   1 #+TITLE:      Org tutorials
   2 #+AUTHOR:     Worg people
   3 #+EMAIL:      bzg AT altern DOT org
   4 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
   5 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
   6 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
   7 #+TAGS:       Write(w) Update(u) Fix(f) Check(c) NEW(n)
   8 #+LANGUAGE:   en
   9 #+PRIORITIES: A C B
  10 #+CATEGORY:   worg
  11
  12 # This file is released by its authors and contributors under the GNU
  13 # Free Documentation license v1.3 or later, code examples are released
  14 # under the GNU General Public License v3 or later.
  15
  16 [[file:../index.org][{Back to Worg's index}]]
  17
  18 #+index: Tutorials
  19
  20 * General Introductions to Org-mode
  21   :PROPERTIES:
  22   :ID:       5B439D78-F862-4380-959C-BEB542DFE352
  23   :END:
  24
  25 - [[https://www.youtube.com/playlist?list=PLVtKhBrRV_ZkPnBtt_TD1Cs9PJlU0IIdE][Rainer König video tutorials]], a series of short (most are between 3 and 10 min.) tutorials that gradually builds up your knowledge and org-mode powers.
  26 # (Headlines & outline mode, ToDo keywords, Schedule, deadlines & agenda views, Repeating tasks, Checklists, Tags, Agenda view (advanced), Customized agenda views, Drawers, Logging & quck notes, Archiving, Automatic logging of status changes, Splitting your system up to several files, The first capture template(s), The :PROPERTIES: drawer, Archiving to different files, Ordered tasks, Timers, Clocking (aka time tracking), Column view, Effort estimates, Linking (internal), Linking (external), Attachments, Priorities, Tables, Exporting, Advanced exporting, Publishing, Dynamic blocks, Tracking habits, Bulk agenda actions, Presenting my system, Google Calendar integration, Source code in OrgMode, Goal setting & Goal Tracking).
  27 # I feel the titles give the User precise information and shows they real world working useful things, but it's bulky like this. Please let's talk about if/how to show this sub-list... :)
  28
  29 - Org-mode can be as pretty (or not) ;) as you like,
  30   - [[http://www.howardism.org/Technical/Emacs/orgmode-wordprocessor.html][Org as a Word Processor]]
  31   - [[https://github.com/rougier/elegant-emacs][Elegant Emacs]]
  32   - [[https://lepisma.xyz/2017/10/28/ricing-org-mode/][Ricing up Org Mode]]
  33   - [[https://zzamboni.org/post/beautifying-org-mode-in-emacs/][Beautifying Org Mode in Emacs]]
  34   - [[https://github.com/jonnay/org-beautify-theme][Org beautify theme (making org-mode beautiful)]]
  35 - Org-mode in science with Carsten Dominik
  36   - [[https://orgmode.org/talks.html][Google Tech Talk about Org-mode]], a 45 minute talk given by Carsten
  37     Dominik during a visit at [[http://maps.google.com/%3Fq%3D37.423156,-122.084917%2B(Google%20Inc.)&hl%3Den][Google]].
  38   - [[http://www.nf.mpg.de/orgmode/guest-talk-dominik.html][Organizing a Scientist's Life and Work]], a 45 minute talk given by
  39     Carsten Dominik during a visit at the [[http://www.nf.mpg.de/][Max-Planck Institute for
  40     neurological Research Cologne]].
  41   - On [[http://twit.tv/floss136][FLOSS Weekly Episode 136]] (Audio+Video download available)
  42     Randal Schwartz interviews Carsten Dominik about Org-mode.
  43
  44 - Org-mode in task and project organization
  45   - [[http://www.linuxjournal.com/article/9116][Getting Organized with Emacs Org-mode]] by [[http://www.planetizen.com/user/2][Abhijeet Chavan]], an article
  46     originally published in the [[http://www.linuxjournal.com/][Linux Journal]].
  47   - [[file:orgtutorial_dto.org][The OrgMode tutorial]] by [[http://dto.freeshell.org/notebook/][David O'Toole]], covering the basics of TODO
  48     lists and the agenda.  It has been translated into [[file:orgtutorial_dto-fr.org][French]], [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fOrgTutorial][Japanese]],
  49     [[file:orgtutorial_dto-es.org][Spanish]], [[http://hokmen.chan.googlepages.com/OrgTutorial.en-cn.html][Chinese]], [[http://jmjeong.com/index.php?display=Emacs/OrgMode][Korean]], [[http://habrahabr.ru/blogs/emacs/105300/][Russian]], [[http://deneb.iszt.hu/~pasztor/orgtutorial/notebook/orgtutorial-hu.html][Hungarian]] and [[file:orgtutorial_dto-pt.org][Portuguese]].
  50   - [[http://members.optusnet.com.au/~charles57/GTD/orgmode.html][Using Emacs org-mode for GTD]] by [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]] contains an
  51     introduction into Org-mode, among other things.  Charles has also
  52     written a more extensive document ([[id:50A0DEB1-4B63-4CC4-840E-313615C4BAE3][see below]]), but here we still
  53     link to the earlier version because of its nice overview over
  54     Org-mode.
  55 - General presentations
  56   - [[https://orgmode.org/worg/org-tutorials/org-screencasts/ghm2011-demo.html][Emacs Org-mode presentation at GNU Hackers Meeting 2011 in Paris]] (in
  57     English), by Bastien Guerry.
  58   - [[http://jaderholm.com/screencasts.html][A 25 minute screencast]] by [[http://jaderholm.com][Scott Jaderholm]], demonstrating the basic
  59     features of Org-mode.
  60   - [[http://sachachua.com/wp/2008/01/18/outlining-your-notes-with-org/][Outlining Your Notes with Org]] by [[http://sachachua.com/wp/][Sacha Chua]] covers outlining,
  61     searching and internal links.
  62   - Emacs Org-mode, [[https://orgmode.org/list/20081016191332.GE1080@thinkpad.adamsinfoserv.com][video version of a 2-hour talk]] by Russell Adams at
  63     the [[http://www.hlug.org/][Houston Linux User Group]].  The first half of the first hour is
  64     /not/ about Org-mode, but about the Linux command =xargs=.
  65   - [[https://github.com/novoid/org-mode-workshop/blob/master/featureshow/org-mode-teaser.org][Demonstration of Org-mode features]] by Karl Voit, presented for the
  66     first time at [[http://glt12-programm.linuxtage.at/events/96.de.html][Grazer Linuxtage 2012]].
  67   - [[https://github.com/novoid/org-mode-workshop][Org-mode Workshop]] by Karl Voit, conducted at [[http://www.TUGraz.at][Graz University of
  68     Technology]] in November 2012 (3x4 hours). It includes a newer version
  69     of the feature-show from the entry above.
  70   - [[file:org-outside-org.org][Org-mode outside Org-mode]] by Thorsten Jolitz and François Pinard. An
  71     introduction to the available libraries for using Org-mode's concepts and
  72     Org-mode's functionality outside of Org-mode files, e.g. when working with
  73     programming-language source-code files.
  74 - Orgmode in other languages
  75   - /In German language:/ [[ftp://ftp.freiesmagazin.de/2009/freiesMagazin-2009-10.pdf][Ordnung ins Chaos mit Org-Mode]], an excellent
  76     introduction into Org-mode, by Rainer Koenig, published in the free
  77     electronic journal [[http://www.freiesmagazin.de/][Freies Magazin]].
  78   - /In German:/ [[http://www.suenkler.info/emacs-orgmode.html][Der Emacs Org mode]], a comprehensive blog post about Org-mode, by
  79     Hendrik Sünkler.
  80   - /In French:/ A [[http://www.olivierberger.com/weblog/index.php?post/2010/08/14/Ma-vie-a-chang%C3%A9-%3A-j-utilise-org-mode][general introduction]] on Org for the "[[http://lifehacking.fr][lifehacking]]"
  81     group, by Olivier Berger.
  82   - /In Spanish:/ [[file:org-reference-guide-es.org][A reference guide]] of each features, their text format
  83     and their available keys. Don't confuse with
  84     [[http://www.davidam.com/docu/orgguide.es.html][Guía Compacta de Org Mode]].
  85 - Org-mode in mobile devices
  86   - [[https://orgro.org/][Orgro]], a mobile org-mode file viewer (iOS & Android)
  87   - [[http://www.orgzly.com/][Orgzly]], Outliner for notes and to-do lists (Android only)
  88   - [[https://beorgapp.com/][Be Org app]], be organized, be in control (iOS only)
  89   - [[https://mobileorg.github.io/][MobileOrg]], a free (open-source) application for storing, searching, viewing and editing your Org mode files (iOS only)
  90   - [[https://github.com/200ok-ch/organice/blob/master/README.org][Organice]], built for mobile and desktop browsers and syncs with Dropbox, Google Drive and WebDAV.
  91
  92 * In praise of the Org lightweight markup language
  93
  94 - [[https://karl-voit.at/2017/09/23/orgmode-as-markup-only/][Org-Mode Is One of the Most Reasonable Markup Languages to Use for
  95   Text]], by Karl Voit.
  96
  97 * Org not-so-hidden gems
  98
  99 This blog post lists some useful Org features that are often
 100 overlooked by new users:
 101
 102 - [[https://bzg.fr/en/some-emacs-org-mode-features-you-may-not-know.html/][Org-mode features You May Not Know]], Bastien
 103
 104 * Power users describe their setup
 105   :PROPERTIES:
 106   :ID:       50A0DEB1-4B63-4CC4-840E-313615C4BAE3
 107   :END:
 108
 109 #+index: Setup
 110 In the following documents, the authors describe the details of their
 111 setup, along with the workflows they use to get organized with
 112 Org-mode.  While as a beginner you probably should start with only a
 113 simple setup, these descriptions will be a fantastic source of
 114 inspiration once you start growing your use of Org-mode.
 115
 116 - [[http://newartisans.com/2007/08/using-org-mode-as-a-day-planner][Using Org-mode as a day planner]] by [[http://johnwiegley.com][John Wiegley]] shows how to use
 117   Org-mode after the fashion of a pen-and-paper day planner.
 118
 119 - [[http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html][How I use Emacs and Org-mode to implement GTD]] by [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]] shows
 120   one method of doing GTD with org-mode and covers (among other
 121   things) categories, effort estimates, tags, scheduling, and custom
 122   agenda commands.
 123
 124 - [[http://doc.norang.ca/org-mode.html][Organize Your Life In Plain Text!]] by Bernt Hansen describes how to
 125   use Org-mode to track and clock everything you work on.
 126
 127 * Tutorials on specific features
 128 ** Lists
 129
 130 - A short [[http://bzg.fr/org-playing-with-lists-screencast.html][screencast]] presenting a few features of plain lists, by
 131   Bastien.
 132
 133 ** Tables, Spreadsheet, Plotting
 134    :PROPERTIES:
 135    :CUSTOM_ID: Spreadsheet
 136    :END:
 137
 138 - [[file:tables.org][A very short introduction to tables in Org-mode]], by Bastien.
 139
 140 - [[file:org-spreadsheet-intro.org][A very short introduction to Org as a spreadsheet system]], by
 141   Bastien.
 142
 143 - [[file:org-spreadsheet-lisp-formulas.org][Using Emacs lisp for spreadsheet formulas]] ([[file:org-tableur-tutoriel.org][french version]]), by Bastien.
 144
 145 - [[https://github.com/novoid/org-mode-workshop/blob/master/featureshow/org-mode-teaser.org#1131-referencing-example-with-detailed-explanation][Various spreadsheet formulas with explanations how they work]]
 146   by Karl Voit.
 147
 148 - [[file:org-plot.org][Plotting tables in Org-Mode using org-plot]] by Eric Schulte
 149
 150 - [[file:org-dot-diagrams.org][Plotting process diagrams or work flows in Org-Mode using dot]] by Karl Voit
 151
 152 - [[http://www.youtube.com/watch?v=EQAd41VAXWo][Can your editor do this]], awesome little video showing how to create
 153   HTML tables from an embedded Org-mode table.
 154
 155 - [[file:multitarget-tables.org][Using multiple-target tables and general formatting functions]] by
 156   [[http://claimid.com/ejr/][Jason Riedy]].
 157
 158 - [[http://www.hollenback.net/index.php/EmacsOrgTimestamps][Timestamps in Org and Calc]], how to calculate and display times in Org-mode by Phil Hollenback
 159
 160 - [[file:org-lookups.org][Table lookup functions]] by Jarmo Hurri
 161
 162 - The following are not tutorials but listed here somehow for
 163   "completeness" of the information sources to be checked too:
 164   - [[https://orgmode.org/manual/The-spreadsheet.html][Org manual, section about spreadsheet]]
 165
 166   - [[https://orgmode.org/worg/org-faq.html#Tables][Worg FAQ, section about tables]]
 167
 168   - [[https://orgmode.org/worg/org-hacks.html#Tables][Worg hacks, section about tables]]
 169
 170   - [[https://code.orgmode.org/bzg/org-mode/raw/master/testing/lisp/test-org-table.el][most of the automated Emacs Regression Tests (ERT) for Org tables]]
 171
 172 ** Dates and Times
 173
 174 - [[http://members.optusnet.com.au/~charles57/GTD/org_dates/][Using Dates and Times in Emacs Org-mode]] by [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]].
 175
 176 - [[http://sachachua.com/wp/2007/12/30/clocking-time-with-emacs-org/][Clocking time with Emacs Org]] by [[http://sachachua.com/wp/][Sacha Chua]].
 177
 178 ** Tags, Properties, and Column View
 179
 180 - [[http://sachachua.com/wp/2008/01/04/tagging-in-org-plus-bonus-code-for-timeclocks-and-tags/][Tagging in Org]] by [[http://sachachua.com/wp/][Sacha Chua]].
 181
 182 - [[https://orgmode.org/list/m38x2qkipg.fsf@cam.ac.uk][What's the use of Column View?]] by Christian Egli is a short tutorial
 183   about Column View that was sent to [[http://news.gmane.org/gmane.emacs.orgmode][emacs-orgmode@gnu.org]].
 184
 185 - [[file:org-column-view-tutorial.org][Emacs Org's Column View]] by [[http://bzg.fr][Bastien]], with an accompanying [[http://emacs-doctor.com/org-column-screencast.html][screencast]].
 186
 187 ** Remember
 188
 189 - [[http://members.optusnet.com.au/~charles57/GTD/remember.html][Remember mode tutorial]] by [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]].
 190
 191 - [[http://sachachua.com/wp/2007/10/05/remembering-to-org-and-planner/][Remembering to Org and Planner]] by [[http://sachachua.com/wp/][Sacha Chua]].
 192
 193 ** Capture
 194
 195 - [[file:org-protocol-custom-handler.org][Defining custom handlers for use with org-protocol]] by Sebastian Rose
 196
 197 - [[http://members.optusnet.com.au/~charles57/GTD/datetree.html][Capture mode  and date trees in org-mode]] by [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]].
 198
 199 ** Agenda and search
 200
 201 - [[file:org-custom-agenda-commands.org][Using custom agenda commands]] by Matt Lundin
 202
 203 - [[file:advanced-searching.org][Advanced searching]] by Matt Lundin
 204
 205 - [[file:../agenda-optimization.org][Agenda speed up and optimization]] by Bastien
 206
 207 - [[file:agenda-filters.org][Agenda filters and limits]] by Bastien
 208
 209 ** Customization
 210
 211 - [[file:org-customize.org][Using customize to find and set options]] by Carsten Dominik.
 212 - [[file:org-appearance.org][Customizing Org appearance]]
 213
 214 ** Export and Publishing
 215
 216 - [[file:org-publish-html-tutorial.org][Publishing Org-mode files to HTML]], covering the basics of publishing
 217   to HTML, by Sebastian Rose.
 218 - [[file:org-publish-layersmenu.org][Phplayersmenu and HTML publishing]], shows how to create and maintain JavaScript
 219   menus (Phplayermenu) for HTML export, by Sebastian Rose.
 220 - [[file:images-and-xhtml-export.org][Images and XHTML export]], shows simple image handling in HTML export, by
 221   Sebastian Rose.
 222 - [[file:org-taskjuggler.org][Creating Gantt charts by exporting to TaskJuggler]], explains the usage of
 223   the TaskJuggler exporter.  There is a Serbo-Croatian translation [[file:org-taskjuggler-scr.org][here]] by
 224   Jovana Milutinovich.
 225 - [[file:org-latex-export.org][Using the OLD LaTeX exporter]] introduces configuration topics for
 226   users of Org Mode < 8.0.
 227 - [[file:org-latex-preview.org][Some notes on previewing LaTeX fragments]].
 228 - [[file:org-google-sync.org][Syncing with Google Calendar]]
 229 - [[http://www.youtube.com/watch?v=1-dUkyn_fZA][Demonstration of Org-mode as a tool for reproducible research]] by John Kitchin
 230   at SciPy 2013.
 231 - Write your book in Org-mode, and publish it with [[http://leanpub.com][Leanpub]] and the [[http://juanreyero.com/open/ox-leanpub/index.html][ox-leanpub exporter]].
 232
 233 ** Reproducible research
 234    A talk by [[http://www.cheme.cmu.edu/people/faculty/jkitchin.htm][John Kitchin]] at [[http://conference.scipy.org/scipy2013/][SciPy 2013]]. In his truly amazing talk
 235    [[http://www.youtube.com/watch?v%3D1-dUkyn_fZA][Emacs + org-mode + python in reproducible research]], John shows off
 236    the capabilities of Org mode for reproducible research and
 237    authoring.  This may be the best demonstration yet on this subject.
 238 ** Import
 239
 240 - [[file:org-import-rtm.org][Importing from remember the milk]]
 241
 242 ** Dependencies between tasks
 243
 244 - [[http://karl-voit.at/2016/12/18/org-depend/][Karl Voit on how he is using org-depend.el]]
 245
 246 * Special tasks
 247 ** Natural Project Planning
 248
 249 - [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]] about using Org-mode to implement [[http://members.optusnet.com.au/~charles57/GTD/Natural_Project_Planning.html][Natural Project
 250   Planning]] according to David Allen.
 251
 252 ** Tracking Habits
 253
 254 - [[file:tracking-habits.org][Tracking habits with org-mode]], by Matt Lundin.
 255
 256 ** Measuring Personal Effectiveness
 257 - [[file:org-effectiveness.org][Org Effectiveness Tutorial]]
 258 ** Using version Control with Your org files
 259
 260 - [[file:org-vcs.org][Using version control with your org files]], by Ian Barton.
 261 - Use [[https://github.com/simonthum/git-sync][git-sync]] (disclaimer: my script) if you have a git repo of your own
 262   somewhere in the interclouds.
 263 - Use [[http://git-annex.branchable.com/sync/][git-annex]] for even more decentralized sync and/or heavier workloads.
 264 - [[http://karl-voit.at/2014/08/20/org-losses-determining-post-commit/][Prevent losing collapsed Org lines by mistake]] by Karl Voit
 265   - A post-commit hook generates a warning on your agenda if more than
 266     xxx lines were removed.
 267
 268 ** How to use jsMath with org-mode
 269 - [[file:org-jsmath.org][How to use jsMath with org-mode]], by Darlan Cavalcante Moreira.
 270
 271 ** Creating a Blog with Jekyll and org
 272 - How to create a [[file:org-jekyll.org][blog]] with Jekyll.
 273 - [[http://juanreyero.com/open/org-jekyll/index.html][Exporting your blog with org-jekyll]] (a different approach).
 274
 275 ** Creating Beamer presentations
 276
 277    - A [[file:../exporters/beamer/ox-beamer.org][tutorial]] for the new (org version 8.x) exporter, by Suvayu Ali.
 278    - Here is a [[file:org-beamer/tutorial.org][tutorial]] for the /old/ exporter (org v7.x), by Eric S. Fraga.
 279    - Also available is a [[http://www.youtube.com/watch?v=Ho6nMWGtepY&feature=player_embedded][YouTube video]] by Shulei Zhu, demonstrating the
 280      whole process.
 281 ** Creating Non-Beamer presentations
 282
 283    - A simple [[file:non-beamer-presentations.org][tutorial]] by Eric Schulte
 284
 285 ** Keeping up with your team's tasks
 286    A setup that makes it easy to [[http://juanreyero.com/article/emacs/org-teams.html][keep up with the work]] of several
 287    people, packaged as org-secretary.el in contrib.
 288 ** Tracking tasks through a series of meetings
 289    This tutorial describes a workflow for running a series of
 290    meetings, for example of a commission or any other group, and for
 291    keeping track of the groups tasks.  [[file:org-meeting-tasks.org][Link to the tutorial]].
 292
 293    You may also want to check [[https://lists.gnu.org/archive/html/emacs-orgmode/2019-10/msg00300.html][this message by Christian Egli]] about his
 294    own setup for taking notes during meetings.
 295
 296 ** Weaving a budget with Org and ledger
 297
 298    [[file:weaving-a-budget.org][This tutorial]] describes how to use Org and [[http://www.ledger-cli.org][ledger]] to manage your
 299    budget.
 300
 301 ** Managing your web bookmarks
 302
 303 - [[http://karl-voit.at/2014/08/10/bookmarks-with-orgmode/][Simple method by Karl Voit]]
 304
 305 ** Contact management
 306
 307 - [[http://karl-voit.at/2015/02/01/muttfilter/][Per-contact FROM-email Addresses for Users Of mutt and org-contacts.el]] by Karl Voit
 308   - Although he is using mutt as email software, the method can be
 309     easily adapted for many other email tools.
 310
 311 ** Contributing your package through Melpa + GitHub
 312
 313    Want to contribute ?
 314    GitHub + MELPA + Worg is a popular way to publish your contribution.
 315
 316    [[file:melpa-github.org][Contribute through Melpa + GitHub + Worg]]
 317
 318 * Personal Setup
 319
 320   See also [[id:50A0DEB1-4B63-4CC4-840E-313615C4BAE3][Powerusers describe their setup]]
 321
 322   - [[http://sachachua.com/wp/][Sacha Chua]] about [[http://sachachua.com/wp/2007/12/22/a-day-in-a-life-with-org/][A day in a life with Org]] and about the basics of
 323     [[http://sachachua.com/wp/2007/12/28/emacs-getting-things-done-with-org-basic/][Getting Things Done with Org]]
 324
 325   - David O'Toole explains his setup in [[https://orgmode.org/list/20071221.230243.10858071.dto@pod.lab][this post]].
 326
 327   - This [[http://www.brool.com/?p=82][blog post]] shows a very simple and clear GTD setup.
 328
 329   - Manuel Hermenegildo describes his [[https://orgmode.org/list/18477.45794.800484.69970@clip.dia.fi.upm.es][Setup for collaborative work
 330     using Org]].
 331
 332   - Jan Böcker describes his approach to [[http://www.jboecker.de/2010/04/14/general-reference-filing-with-org-mode.html][general reference filing]] with
 333     org-mode.
 334
 335 * Screencasts
 336
 337   See the [[file:org-screencasts/index.org][Screencasts]] page for a complete list of Org-mode screencasts.
 338
 339 * Features waiting for tutorials
 340
 341 - The Clock Table
 342 - Sparse Trees
 343 - Hyperlinks
 344 - Using TODO states
 345 - Using TAGS
 346 - Embedded LaTeX
 347 - Using orgtbl-mode in LaTeX
 348 - Capture
 349
 350 * Org-related pages by Tutorial authors
 351
 352 Here are the pages of a number of people that write for or about
 353 Org-mode:
 354
 355 - [[http://www.newartisans.com][John Wiegley]]
 356 - [[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]]
 357 - [[http://sachachua.com/wp/][Sacha Chua]]
 358 - [[http://karl-voit.at/tags/emacs/][Karl Voit]]