12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699 |
- \input texinfo
- setfilename ../../info/orgguide
- set VERSION 7.3
- c Use proper quote and backtick for code sections in PDF output
- set txicodequoteundirected
- c Version and Contact Info
- uref{http://orgmode.org,maintainers webpage}
- set MAINTAINER Carsten Dominik
- email{carsten at orgmode dot org}
- uref{mailto:carsten at orgmode dot org,contact the maintainer}
- finalout
- iftex
- hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
- macro Ie {}
- I.e.,
- macro ie {}
- i.e.,
- macro Eg {}
- E.g.,
- macro eg {}
- e.g.,
- c Subheadings inside a table.
- ifinfo
- end ifinfo
- item
- end ifnotinfo
- macro seealso{text}
- b{Further reading}noindent \text\
- copying
- Copyright
- quotation
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.3 or
- any later version published by the Free Software Foundation; with no
- Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
- and with the Back-Cover Texts as in (a) below. A copy of the license
- is included in the section entitled ``GNU Free Documentation License.''
- (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
- modify this GNU manual. Buying copies from the FSF supports it in
- developing GNU and promoting software freedom.''
- This document is part of a collection distributed under the GNU Free
- Documentation License. If you want to distribute this document
- separately from the collection, you can do so by adding a copy of the
- license to the document, as described in section 6 of the license.
- end copying
- direntry
- * Org Mode Guide: (orgguide). Abbreviated Org-mode Manual
- titlepage
- subtitle Release
- author by Carsten Dominik
- page
- insertcopying
- c Output the table of contents at the beginning.
- ifnottex
- top Org Mode Guide
- end ifnottex
- detailmenu
- --- The Detailed Node Listing ---
- Introduction
- * Preface:: Welcome
- * Installation:: How to install a downloaded version of Org
- * Activation:: How to activate Org for certain buffers
- * Feedback:: Bug reports, ideas, patches etc.
- Document Structure
- * Outlines:: Org is based on Outline mode
- * Headlines:: How to typeset Org tree headlines
- * Visibility cycling:: Show and hide, much simplified
- * Motion:: Jumping to other headlines
- * Structure editing:: Changing sequence and level of headlines
- * Sparse trees:: Matches embedded in context
- * Plain lists:: Additional structure within an entry
- * Footnotes:: How footnotes are defined in Org's syntax
- Hyperlinks
- * Link format:: How links in Org are formatted
- * Internal links:: Links to other places in the current file
- * External links:: URL-like links to the world
- * Handling links:: Creating, inserting and following
- * Targeted links:: Point at a location in a file
- TODO Items
- * Using TODO states:: Setting and switching states
- * Multi-state workflows:: More than just on/off
- * Progress logging:: Dates and notes for progress
- * Priorities:: Some things are more important than others
- * Breaking down tasks:: Splitting a task into manageable pieces
- * Checkboxes:: Tick-off lists
- Progress logging
- * Closing items:: When was this entry marked DONE?
- * Tracking TODO state changes:: When did the status change?
- Tags
- * Tag inheritance:: Tags use the tree structure of the outline
- * Setting tags:: How to assign tags to a headline
- * Tag searches:: Searching for combinations of tags
- Dates and Times
- * Timestamps:: Assigning a time to a tree entry
- * Creating timestamps:: Commands which insert timestamps
- * Deadlines and scheduling:: Planning your work
- * Clocking work time:: Tracking how long you spend on a task
- Capture - Refile - Archive
- * Capture::
- * Refiling notes:: Moving a tree from one place to another
- * Archiving:: What to do with finished projects
- Capture
- * Setting up a capture location:: Where notes will be stored
- * Using capture:: Commands to invoke and terminate capture
- * Capture templates:: Define the outline of different note types
- Agenda Views
- * Agenda files:: Files being searched for agenda information
- * Agenda dispatcher:: Keyboard access to agenda views
- * Built-in agenda views:: What is available out of the box?
- * Agenda commands:: Remote editing of Org trees
- * Custom agenda views:: Defining special searches and views
- The built-in agenda views
- * Weekly/daily agenda:: The calendar page with current tasks
- * Global TODO list:: All unfinished action items
- * Matching tags and properties:: Structured information with fine-tuned search
- * Timeline:: Time-sorted view for single file
- * Search view:: Find entries by searching for text
- Markup for rich export
- * Structural markup elements:: The basic structure as seen by the exporter
- * Images and tables:: Tables and Images will be included
- * Literal examples:: Source code examples with special formatting
- * Include files:: Include additional files into a document
- * Embedded LaTeX:: LaTeX can be freely used inside Org documents
- Structural markup elements
- * Document title:: Where the title is taken from
- * Headings and sections:: The document structure as seen by the exporter
- * Table of contents:: The if and where of the table of contents
- * Paragraphs:: Paragraphs
- * Emphasis and monospace:: Bold, italic, etc.
- * Comment lines:: What will *not* be exported
- Exporting
- * Export options:: Per-file export settings
- * The export dispatcher:: How to access exporter commands
- * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
- * HTML export:: Exporting to HTML
- * LaTeX and PDF export:: Exporting to La
- end detailmenu
- node Introduction, Document Structure, Top, Top
- menu
- * Preface:: Welcome
- * Installation:: How to install a downloaded version of Org
- * Activation:: How to activate Org for certain buffers
- * Feedback:: Bug reports, ideas, patches etc.
- node Preface, Installation, Introduction, Introduction
- i{This document is a much compressed derivative of the
- node Installation, Activation, Preface, Introduction
- b{Important:}
- ref{Activation}.}
- If you have downloaded Org from the Web, either as a distribution
- file{.tar} file, or as a Git archive, it is best to run it directly from
- the distribution directory. You need to add the
- file{.emacs}:
- end smallexample
- smallexample
- make
- file{.emacs}. It is needed so that
- Emacs can autoload functions that are located in files not immediately loaded
- when Org-mode starts.
- end smalllisp
- section Activation
- Add the following lines to your
- emph{global} keys for some commands --- please choose suitable keys
- yourself.
- end smalllisp
- With this setup, all files with extension
- node Feedback, , Activation, Introduction
- email{emacs-orgmodegnu.org}.
- For information on how to submit bug reports, see the main manual.
- chapter Document Structure
- Org is based on Outline mode and provides flexible commands to
- edit the structure of the document.
- end menu
- section Outlines
- Org is implemented on top of Outline mode. Outlines allow a
- document to be organized in a hierarchical structure, which (at least
- for me) is the best representation of notes and thoughts. An overview
- of this structure is achieved by folding (hiding) large parts of the
- document to show only the general document structure and the parts
- currently being worked on. Org greatly simplifies the use of
- outlines by compressing the entire show/hide functionality into a single
- command, key{TAB} key.
- section Headlines
- Headlines define the structure of an outline tree. The headlines in
- Org start with one or more stars, on the left margin
- code{org-special-ctrl-a/e} to configure special behavior
- of kbd{C-e} in headlines.}. For example:
- end smallexample
- ref{Clean view}, describes a setup to realize this.
- section Visibility cycling
- Outlines make it possible to hide parts of the text in the buffer.
- Org uses just two commands, bound to
- kbd{S-
- table
- item
- emph{Subtree cycling}: Rotate current subtree among the states
- end smallexample
- When called with a prefix argument (key{TAB}}) or with the shift
- key, global cycling is invoked.
- key{TAB} key{TAB}
- smallexample
- ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
- '--------------------------------------'
- item C-u C-u C-u
- end table
- When Emacs first visits an Org file, the global state is set to
- OVERVIEW, i.e. only the top level headlines are visible. This can be
- configured through the variable
- code{overview},
- code{showall}, like this:
- end smallexample
- section Motion
- The following commands jump to other headlines in the buffer.
- kbd
- item C-c C-p
- Previous heading.
- item C-c C-b
- Previous heading same level.
- end table
- section Structure editing
- kbd
- key{RET}
- Insert new heading with same level as current. If the cursor is in a plain
- list item, a new item is created (
- footnote{If you do not want the line to be split,
- customize the variable
- item M-S-
- item r{in new, empty entry}
- In a new entry with no text yet,
- item M-r{/}
- item M-S-r{/}
- item M-S-r{/}
- item C-c C-w
- Refile entry or region to a different location.
- item C-x n s/w
- Narrow buffer to current subtree / widen it again
- node Sparse trees, Plain lists, Structure editing, Document Structure
- emph{sparse
- trees} for selected information in an outline tree, so that the entire
- document is folded as much as possible, but the selected information is made
- visible along with the headline structure above it
- code{org-show-hierarchy-above},
- code{org-show-siblings}, and
- table
- item C-c /
- This prompts for an extra key to select a sparse-tree creating command.
- kbd{C-c C-c}.
- node Plain lists, Footnotes, Sparse trees, Document Structure
- pxref{Checkboxes}). Org supports editing such lists,
- and the HTML exporter (
- itemize
- item
- samp{-},
- samp{*} as bullets.
- emph{Ordered} list items start with samp{1)}.
- emph{Description} list use emph{term} from the
- description.
- smallexample
- b{Elijah Wood} :: He plays Frodo
- -
- end group
- table
- item
- item M-
- pxref{Structure editing}).
- key{RET}
- Insert a new item with a checkbox (
- item M-S-r{/}
- item M-r{/}M-
- item M-S-r{/}
- item C-c C-c
- If there is a checkbox (
- item C-c -
- Cycle the entire list level through the different itemize/enumerate bullets
- (samp{+}, samp{1.},
- end table
- section Footnotes
- A footnote is defined in a paragraph that is started by a footnote marker in
- square brackets in column 0, no indentation allowed. The footnote reference
- is simply the marker in square brackets, inside text. For example:
- end smallexample
- table
- item C-c C-x f
- The footnote action command. When the cursor is on a footnote reference,
- jump to the definition. When it is at a definition, jump to the (first)
- reference. Otherwise, create a new footnote. When this command is called
- with a prefix argument, a menu of additional options including renumbering is
- offered.
- end table
- uref{http://orgmode.org/manual/Document-Structure.html#Document-Structure,
- Chapter 2 of the manual}
- uref{http://sachachua.com/wp/2008/01/outlining-your-notes-with-org/,
- Sacha Chua's tutorial}}
- chapter Tables
- Org comes with a fast and intuitive table editor. Spreadsheet-like
- calculations are supported in connection with the Emacs
- ifinfo
- (
- end ifinfo
- end ifnotinfo
- Org makes it easy to format tables in plain ASCII. Any line with
- samp{|} is also the column separator. A table might look like
- this:
- end smallexample
- A table is re-aligned automatically each time you press
- key{RET} or key{TAB} also moves to
- the next field (
- samp{|-} is considered as a horizontal separator line and will be
- expanded on the next re-align to span the whole table width. So, to
- create the above table, you would only type
- end smallexample
- key{TAB} to align the table and start filling in
- fields. Even faster would be to type
- kbd{C-c
- key{DEL},
- emph{immediately after the cursor was moved into a new field
- with key{TAB}}, key{TAB}} or key{RET}}}, the
- field is automatically made blank.
- kbd
- item C-c |
- Convert the active region to table. If every line contains at least one
- TAB character, the function assumes that the material is tab separated.
- If every line contains a comma, comma-separated values (CSV) are assumed.
- If not, lines are split at whitespace into fields.
- kbd{|Name|Phone|Age C-c
- tsubheading{Re-aligning and field motion}
- c
- key{TAB}
- Re-align the table, move to the next field. Creates a new row if
- necessary.
- item S-
- c
- key{RET}
- Re-align the table and move down to next row. Creates a new row if
- necessary.
- item M-
- itemx M-
- c
- key{left}
- Kill the current column.
- item M-S-
- c
- key{up}
- key{down}
- Move the current row up/down.
- item M-S-
- c
- key{down}
- Insert a new row above the current row. With a prefix argument, the line is
- created below the current one.
- item C-c -
- Insert a horizontal line below current row. With a prefix argument, the line
- is created above the current line.
- item C-c
- c
- end table
- uref{http://orgmode.org/manual/Tables.html#Tables, Chapter 3 of the
- manual}
- uref{http://orgmode.org/worg/org-tutorials/tables.php, Bastien's
- table tutorial}
- uref{http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.php,
- Bastien's spreadsheet tutorial}
- uref{http://orgmode.org/worg/org-tutorials/org-plot.php, Eric's plotting tutorial}}
- chapter Hyperlinks
- Like HTML, Org provides links inside a file, external links to
- other files, Usenet articles, emails, and much more.
- end menu
- section Link format
- Org will recognize plain URL-like links and activate them as
- clickable links. The general link format, however, looks like this:
- r{or alternatively} [[link]]
- noindent
- Once a link in the buffer is complete (all brackets present), Org will change
- the display so that
- samp{[[link][description]]} and
- samp{[[link]]}. To edit the invisible kbd{C-c
- C-l} with the cursor on the link.
- section Internal links
- If the link does not look like a URL, it is considered to be internal in the
- current file. The most important case is a link like
- code{CUSTOM_ID} property
- samp{[[My Target]]} or
- samp{<<My Target>>}.
- section External links
- Org supports links to files, websites, Usenet and email messages,
- BBDB database entries and links to both IRC conversations and their
- logs. External links are URL-like locators. They start with a short
- identifying string followed by a colon. There can be no space after
- the colon. Here are some examples:
- r{on the web}
- file:/home/dominik/images/jupiter.jpg
- r{same as above}
- file:papers/last.pdf
- r{another Org file}
- docview:papers/last.pdf::NNN
- r{Link to heading by ID}
- news:comp.emacs
- r{Mail link}
- vm:folder
- r{VM message link}
- wl:folder#id
- r{MH-E message link}
- rmail:folder#id
- r{Gnus article link}
- bbdb:R.*Stallman
- r{IRC link}
- info:org:External%20links
- end smallexample
- A link should be enclosed in double brackets and may contain a
- descriptive text to be displayed instead of the URL (
- smallexample
- [[http://www.gnu.org/software/emacs/][GNU Emacs]]
- noindent
- If the description is a file name or URL that points to an image, HTML export
- (
- node Handling links, Targeted links, External links, Hyperlinks
- table
- item C-c l
- Store a link to the current location. This is a
- c
- key{up} and
- kbd{C-u} prefix argument, file name completion is used to
- link to a file.
- item C-c C-l
- kbd{C-c C-l} allows you to edit the
- link and description parts of the link.
- item C-c C-o r{or} mouse-2
- Open link at point.
- kbd{C-c %}. Using this
- command several times in direct succession moves through a ring of
- previously recorded positions.
- end table
- section Targeted links
- File links can contain additional information to make Emacs jump to a
- particular location in the file when following a link. This can be a
- line number or a search option after a double colon.
- Here is the syntax of the different ways to attach a search to a file
- link, together with an explanation:
- r{Find line 255}
- [[file:~/xx.org::My Target]] samp{<<My Target>>}}
- [[file:~/xx.org::#my-custom-id]]
- end smallexample
- uref{http://orgmode.org/manual/Hyperlinks.html#Hyperlinks, Chapter 4 of the
- manual}}
- chapter TODO Items
- Org mode does not maintain TODO lists as separate documents
- menu
- * Using TODO states:: Setting and switching states
- * Multi-state workflows:: More than just on/off
- * Progress logging:: Dates and notes for progress
- * Priorities:: Some things are more important than others
- * Breaking down tasks:: Splitting a task into manageable pieces
- * Checkboxes:: Tick-off lists
- node Using TODO states, Multi-state workflows, TODO Items, TODO Items
- samp{TODO}, for example:
- end smallexample
- table
- item C-c C-t
- Rotate the TODO state of the current item among
- end smallexample
- The same rotation can also be done ``remotely'' from the timeline and
- agenda buffers with the pxref{Agenda commands}).
- key{right}key{left}
- Select the following/preceding TODO state, similar to cycling.
- emph{sparse tree} (
- item C-c a t
- Show the global TODO list. Collects the TODO items from all agenda files
- (xref{Global TODO list}, for
- more information.
- key{RET}
- Insert a new TODO entry below the current one.
- noindent
- Changing a TODO state can also trigger tag changes. See the docstring of the
- option
- node Multi-state workflows, Progress logging, Using TODO states, TODO Items
- emph{sequential} states
- in the process of working on an item, for example:
- end smalllisp
- The vertical bar separates the TODO keywords (states that
- emph{no further action}). If
- you don't provide the separator bar, the last state is used as the DONE
- state.
- With this setup, the command
- code{TODO}/
- smalllisp
- (setq org-todo-keywords
- '((sequence "TODO(t)" "|" "DONE(d)")
- (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
- (sequence "|" "CANCELED(c)")))
- kbd{C-c C-t}.
- To define TODO keywords that are valid only in a single file, use the
- following text anywhere in the file.
- end smallexample
- After changing one of these lines, use
- node Progress logging, Priorities, Multi-state workflows, TODO Items
- ref{Clocking
- work time}.
- end menu
- unnumberedsubsec Closing items
- The most basic logging is to keep track of
- footnote{The corresponding
- in-buffer setting is:
- smalllisp
- (setq org-log-done 'time)
- noindent
- Then each time you turn an entry from a TODO (not-done) state into any of the
- DONE states, a line
- footnote{The corresponding in-buffer setting is:
- smalllisp
- (setq org-log-done 'note)
- noindent
- You will then be prompted for a note, and that note will be stored below
- the entry with a
- node Tracking TODO state changes, , Closing items, Progress logging
- code{org-log-into-drawer} to get this behavior.
- For state logging, Org mode expects configuration on a per-keyword basis.
- This is achieved by adding special markers
- samp{} (for a note) in parentheses after each keyword. For example:
- end smallexample
- code{org-todo-keywords}.
- section Priorities
- If you use Org mode extensively, you may end up with enough TODO items that
- it starts to make sense to prioritize them. Prioritizing can be done by
- placing a
- smallexample
- *** TODO [#A] Write letter to Sam Fortune
- noindent
- Org mode supports three priorities: samp{B}, and
- samp{A} is the highest,
- table
- item
- samp{A},
- samp{C} to select a priority, or
- c
- key{up}
- key{down}
- Increase/decrease priority of current headline
- node Breaking down tasks, Checkboxes, Priorities, TODO Items
- samp{[/]} or
- kbd{C-c C-c} on the
- cookie. For example:
- end smallexample
- section Checkboxes
- Every item in a plain list (
- samp{[ ]}. Checkboxes are not included into
- the global TODO list, so they are often great to split a task into a number
- of simple steps.
- Here is an example of a checkbox list.
- end smallexample
- Checkboxes work hierarchically, so if a checkbox item has children that
- are checkboxes, toggling one of the children checkboxes will make the
- parent checkbox reflect if none, some, or all of the children are
- checked.
- table
- item C-c C-c
- Toggle checkbox status or (with prefix arg) checkbox presence at point.
- key{RET}
- Insert a new item with a checkbox.
- This works only if the cursor is already in a plain list item
- (
- end table
- uref{http://orgmode.org/manual/TODO-Items.html#TODO-Items, Chapter 5 of the manual}
- uref{http://orgmode.org/worg/org-tutorials/orgtutorial_dto.php, David
- O'Toole's introductory tutorial}
- uref{http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html,
- Charles Cave's GTD setup}}
- chapter Tags
- An excellent way to implement labels and contexts for cross-correlating
- information is to assign
- samp{_}, and
- samp{:work:}. Several tags can be specified, as in
- menu
- * Tag inheritance:: Tags use the tree structure of the outline
- * Setting tags:: How to assign tags to a headline
- * Tag searches:: Searching for combinations of tags
- node Tag inheritance, Setting tags, Tags, Tags
- i{Tags} make use of the hierarchical structure of outline trees. If a
- heading has a certain tag, all subheadings will inherit the tag as
- well. For example, in the list
- end smallexample
- samp{:work:},
- samp{:notes:}, and
- footnote{As
- with all these in-buffer settings, pressing
- smallexample
- #+FILETAGS: :Peter:Boss:Secret:
- node Setting tags, Tag searches, Tag inheritance, Tags
- kbd{M-
- table
- item C-c C-q
- Enter new tags for the current headline. Org mode will either offer
- completion or a special single-key interface for setting tags, see
- below. After pressing
- code{org-tags-column}. When called with a
- item C-c C-c
- When the cursor is in a headline, this does the same as
- end table
- Org will support tag insertion based on a
- code{org-tag-alist}. Finally you can set
- the default tags for a given file with lines like
- end smallexample
- By default Org mode uses the standard minibuffer completion facilities for
- entering tags. However, it also implements another, quicker, tag selection
- method called
- code{org-tag-alist} in your
- samp{:home:}. In this case you can set something
- like:
- end smalllisp
- smallexample
- #+TAGS: work(w) home(h) tennisclub(t) laptop(l) pc(p)
- node Tag searches, , Setting tags, Tags
- table
- item C-c \
- kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
- xref{Matching tags and properties}.
- code{org-tags-match-list-sublevels}).
- samp{+boss+urgent-project1}, to find entries with tags
- samp{urgent}, but not samp{Kathy|Sally} to find entries
- which are tagged, like samp{Sally}. The full syntax of the
- search string is rich and allows also matching against TODO keywords, entry
- levels and properties. For a complete description with many examples, see
- seealso{
- *
- node Properties, Dates and Times, Tags, Top
- code{PROPERTIES}. Each
- property is specified on a single line, with the key (surrounded by colons)
- first, and the value after it:
- end smallexample
- You may define the allowed values for a particular property
- samp{:Xyz_ALL:}. This special property is
- smallexample
- * CD collection
- :PROPERTIES:
- :NDisks_ALL: 1 2 3 4
- :Publisher_ALL: "Deutsche Grammophon" Philips EMI
- :END:
- code{org-global-properties}, or file-wide like this:
- end smallexample
- kbd
- item C-c C-c d
- Remove a property from the current entry.
- pxref{Tag searches}). The
- syntax for the search string is described in
- table
- end table
- uref{http://orgmode.org/manual/Properties-and-Columns.html#Properties-and-Columns,
- Chapter 7 of the manual}
- uref{http://orgmode.org/worg/org-tutorials/org-column-view-tutorial.php,Bastien
- Guerry's column view tutorial}}
- chapter Dates and Times
- To assist project planning, TODO items can be labeled with a date and/or
- a time. The specially formatted string carrying the date and time
- information is called a
- menu
- * Timestamps:: Assigning a time to a tree entry
- * Creating timestamps:: Commands which insert timestamps
- * Deadlines and scheduling:: Planning your work
- * Clocking work time:: Tracking how long you spend on a task
- node Timestamps, Creating timestamps, Dates and Times, Dates and Times
- samp{<2003-09-16 Tue>} or
- samp{<2003-09-16 Tue 12:00-12:30>}. A
- timestamp can appear anywhere in the headline or body of an Org tree entry.
- Its presence causes entries to be shown on specific dates in the agenda
- (
- noindent *
- A simple timestamp just assigns a date/time to an item. This is just
- like writing down an appointment or event in a paper agenda.
- end smallexample
- b{Timestamp with repeater interval}
- emph{repeater interval}, indicating that it
- applies not only on the given date, but again and again after a certain
- interval of N days (d), weeks (w), months (m), or years (y). The
- following will show up in the agenda every Wednesday:
- end smallexample
- b{Diary-style sexp entries}
- smallexample
- * The nerd meeting on every 2nd Thursday of the month
- <%%(diary-float t 4 2)>
- noindent *
- Two timestamps connected by
- smallexample
- ** Meeting in Amsterdam
- <2004-08-23 Mon>--<2004-08-26 Thu>
- noindent *
- Just like a plain timestamp, but with square brackets instead of
- angular ones. These timestamps are inactive in the sense that they do
- smallexample
- * Gillian comes late for the fifth time [2006-11-01 Wed]
- node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
- table
- item C-c .
- Prompt for a date and insert a corresponding timestamp. When the cursor is
- at an existing timestamp in the buffer, the command is used to modify this
- timestamp instead of inserting a new one. When this command is used twice in
- succession, a time range is inserted. With a prefix, also add the current
- time.
- item C-c !
- Like
- c
- key{left}key{right}
- Change date at cursor by one day.
- item S-r{/}
- samp{15:30-16:30}, modifying the first time will also shift the second,
- shifting the time block with constant length. To change the length, modify
- the second time.
- node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
- noindent *
- Meaning: the task (most likely a TODO item, though not necessarily) is supposed
- to be finished on that date.
- kbd
- samp{DEADLINE} keyword along with a stamp, in the line following the
- headline.
- emph{today} will carry a warning about the
- approaching or missed deadline, starting
- smallexample
- *** TODO write article about the Earth for the Guide
- The editor in charge is [[bbdb:Ford Prefect]]
- DEADLINE: <2004-02-29 Sun>
- noindent *
- Meaning: you are
- footnote{This is quite different from what is normally understood by
- table
- item C-c C-s
- Insert
- end table
- The headline will be listed under the given date
- code{org-agenda-skip-scheduled-if-done}.}. In
- addition, a reminder that the scheduled date has passed will be present
- in the compilation for
- smallexample
- *** TODO Call Trillian for a date on New Years Eve.
- SCHEDULED: <2004-12-25 Sat>
- smallexample
- ** TODO Pay the rent
- DEADLINE: <2005-10-01 Sat +1m>
- noindent
- the
- node Clocking work time, , Deadlines and scheduling, Dates and Times
- table
- item C-c C-x C-i
- Start the clock on the current item (clock-in). This inserts the CLOCK
- keyword together with a timestamp. When called with a
- c
- samp{=>
- HH:MM}.
- item C-c C-x C-x
- Cancel the current clock. This is useful if a clock was started by
- mistake, or if you ended up working on something else.
- kbd{C-u} prefix arg, select the target task from a list of recently clocked
- tasks.
- smallexample
- #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
- #+END: clocktable
- noindent
- For details about how to customize this view, see
- item C-c C-c
- Update dynamic block at point. The cursor needs to be in the
- end table
- The pxref{Timeline}) and in
- the agenda (
- seealso{
- *
- *
- node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
- i{attachments}) in a special directory. Once in the system, tasks and
- projects need to be moved around. Moving completed project trees to an
- archive file keeps the system compact and fast.
- end menu
- section Capture
- Org's method for capturing new items is heavily inspired by John Wiegley
- excellent remember package. It lets you store quick notes with little
- interruption of your work flow. Org lets you define templates for new
- entries and associate them with different targets for storing notes.
- end menu
- unnumberedsubsec Setting up a capture location
- The following customization sets a default target
- ref{Capture templates}.} file for notes, and defines a global
- keykbd{C-c c} is only a suggestion.}
- for capturing new stuff.
- end example
- unnumberedsubsec Using capture
- kbd
- item C-c C-c
- Once you are done entering information into the capture buffer,
- item C-c C-w
- Finalize by moving the entry to a refile location (
- item C-c C-k
- Abort the capture process and return to the previous state.
- node Capture templates, , Using capture, Capture
- samp{Tasks} in file
- file{journal.org} you could
- use:
- end smallexample
- kbd{M-x org-capture}, Org will prompt for a key to select the
- template (if you have more than one template) and then prepare the buffer like
- var{link to where you were when initiating capture}]]
- noindent
- During expansion of the template, special footnote{If you
- need one of these sequences literally, escape the
- smallexample
- %a code{org-store-link}}
- %i
- r{timestamp, date only}
- %T
- r{like the above, but inactive timestamps}
- node Refiling notes, Archiving, Capture, Capture - Refile - Archive
- table
- item C-c C-w
- Refile the entry or region at point. This command offers possible locations
- for refiling the entry and lets you select one with completion. The item (or
- all items in the region) is filed below the target heading as a subitem.
- code{org-refile-targets} for details.
- item C-u C-u C-c C-w
- Jump to the location where
- end table
- section Archiving
- When a project represented by a (sub)tree is finished, you may want
- to move the tree out of the way and to stop it from contributing to the
- agenda. Archiving is important to keep your working files compact and global
- searches like the construction of agenda views fast.
- The most common archiving action is to move a project tree to another file,
- the archive file.
- kbd
- code{org-archive-default-command}.
- C-c $
- Archive the subtree starting at the cursor position to the location
- given by
- end table
- The default archive location is a file in the same directory as the
- current file, with the name derived by appending
- code{org-archive-location}. There is also an in-buffer option for
- setting this variable, for example
- end smallexample
- uref{http://orgmode.org/manual/Capture-_002d-Refile-_002d-Archive.html#Capture-_002d-Refile-_002d-Archive,
- Chapter 9 of the manual}
- uref{http://members.optusnet.com.au/~charles57/GTD/remember.html, Charles
- Cave's remember tutorial}
- uref{http://orgmode.org/worg/org-tutorials/org-protocol-custom-handler.php,
- Sebastian Rose's tutorial for capturing from a web browser}}*
- chapter Agenda Views
- Due to the way Org works, TODO items, time-stamped items, and tagged
- headlines can be scattered throughout a file or even a number of files. To
- get an overview of open action items, or of events that are important for a
- particular date, this information must be collected, sorted and displayed in
- an organized way. There are several different views, see below.
- The extracted information is displayed in a special
- ref{Agenda
- commands}.
- end menu
- section Agenda files
- The information to be shown is normally collected from all
- code{org-agenda-files}.
- kbd
- item C-c ]
- Remove current file from the list of agenda files.
- end table
- section The agenda dispatcher
- The views are created through a dispatcher, which should be bound to a
- global key---for example pxref{Installation}). After
- pressing
- table
- item a
- The calendar-like agenda (
- item t
- pxref{Global TODO list}).
- r{/} M
- A list of headlines matching a TAGS expression (
- item L
- The timeline view for the current buffer (
- item s
- A list of entries selected by a boolean expression of keywords
- and/or regular expressions that must or must not occur in the entry.
- node Built-in agenda views, Agenda commands, Agenda dispatcher, Agenda Views
- menu
- * Weekly/daily agenda:: The calendar page with current tasks
- * Global TODO list:: All unfinished action items
- * Matching tags and properties:: Structured information with fine-tuned search
- * Timeline:: Time-sorted view for single file
- * Search view:: Find entries by searching for text
- node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
- emph{agenda} is to act like a page of a
- paper agenda, showing all the tasks for the current week or day.
- kbd
- end table
- Emacs contains the calendar and diary by Edward M. Reingold. Org-mode
- understands the syntax of the diary and allows you to use diary sexp entries
- directly in Org files:
- footnote{Note that the order of the arguments (month, day, year) depends on the setting of
- end smallexample
- Org can interact with Emacs appointments notification facility. To add all
- the appointments of your agenda files, use the command
- node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
- ref{Agenda commands}.
- kbd
- pxref{Agenda Views}) into a single buffer.
- end table
- subsection Matching tags and properties
- If headlines in the agenda files are marked with pxref{Tags}),
- or have properties (
- kbd{C-c /
- m}. The commands available in the tags list are described in
- table
- item C-c a m
- Produce a list of all headlines that match a given set of tags. The
- command prompts for a selection criterion, which is a boolean logic
- expression with tags, like
- samp{work|home} (
- pxref{Agenda dispatcher}).
- kbd{C-c a m}, but only select headlines that are also TODO items.
- subsubheading Match syntax
- A search string can use Boolean operators samp{|} for
- OR. samp{|}. Parentheses are currently
- not implemented. Each element in the search is either a tag, a regular
- expression matching tags, or an expression like
- samp{-}, to select against it, and
- samp{&} is optional when
- samp{-} is present. Here are some examples, using only tags.
- samp
- samp{:work:}, but discard those also tagged
- item work|laptop
- Selects lines tagged samp{:laptop:}.
- samp{:laptop:} lines to be tagged also
- end table
- You may also test for properties at the same
- time as matching tags, see the manual for more information.
- subsection Timeline for a single file
- The timeline summarizes all time-stamped items from a single Org mode
- file in a
- table
- item C-c a L
- Show a time-sorted view of the Org file, with all time-stamped items.
- When called with a
- end table
- subsection Search view
- This agenda view is a general text search facility for Org mode entries.
- It is particularly useful to find notes.
- kbd
- end table
- For example, the search string
- samp{computer equipment} as a substring.
- Search view can also search for specific keywords in the entry, using Boolean
- logic. The search string {8\.11[bg]
- code{computer}
- and code{ethernet}, and which are also
- not matched by the regular expression
- code{org-agenda-text-search-extra-files}.
- section Commands in the agenda buffer
- Entries in the agenda buffer are linked back to the Org file or diary
- file where they originate. Commands are provided to show and jump to the
- original entry location, and to edit the Org files ``remotely'' from
- the agenda buffer. This is just a selection of the many commands, explore
- the
- table
- tsubheading{Motion}
- key{up} and
- item p
- Previous line (same as kbd{C-n}).
- item mouse-3
- key{SPC}
- Display the original location of the item in another window.
- With prefix arg, make sure that the entire entry is made visible in the
- outline, not only the heading.
- itemx
- kbd{mouse-1} will also works for this.
- itemx
- c
- item o
- Delete other windows.
- item d
- c
- r{and} b
- Go forward/backward in time to display the following
- c
- c
- c
- l
- Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
- logging was on (variable
- kbd{C-u}
- prefix, show all possible logbook entries, including state changes.
- item r
- item s
- Save all Org buffers in the current Emacs session, and also the locations of
- IDs.
- item /
- Filter the current agenda view with respect to a tag. You are prompted for a
- letter to select a tag. Press
- item \
- Narrow the current agenda filter by an additional condition.
- item 0-9
- Digit argument.
- item t
- Change the TODO state of the item, in the agenda and in the
- org file.
- item C-k
- Delete the current agenda item along with the entire subtree belonging
- to it in the original Org file.
- item C-c C-w
- Refile the entry at point.
- item C-c C-x C-a r{or short}
- code{org-archive-default-command}.
- item C-c C-x C-s r{or short}
- c
- c
- c
- key{right} key{left}
- Change the timestamp associated with the current line by one day.
- item I
- Start the clock on the current item.
- item O / X
- Stop/cancel the previously started clock.
- end table
- section Custom agenda views
- The main application of custom searches is the definition of keyboard
- shortcuts for frequently used searches, either creating an agenda
- buffer, or a sparse tree (the latter covering of course only the current
- buffer).
- Custom commands are configured in the variable
- kbd{C-c a C}. You can also directly set it with
- Emacs Lisp in
- smalllisp
- end group
- noindent
- The initial string in each entry defines the keys you have to press after the
- dispatcher command
- table
- item C-c a w
- as a global search for TODO entries with
- item C-c a u
- as a global tags search for headlines marked
- samp{:urgent:}
- kbd{C-c a u}, but limiting the search to
- headlines that are also TODO items
- seealso{
- *
- *
- node Markup, Exporting, Agenda Views, Top
- TeX{}, or DocBook allow much richer formatting,
- Org mode has rules on how to prepare text for rich export. This section
- summarizes the markup rules used in an Org-mode buffer.
- end menu
- section Structural markup elements
- end menu
- subheading Document title
- smallexample
- #+TITLE: This is the title of the document
- node Headings and sections, Table of contents, Document title, Structural markup elements
- ref{Document
- Structure}, forms the basis for defining sections of the exported document.
- However, since the outline structure is also used for (for example) lists of
- tasks, only the first three outline levels will be used as headings. Deeper
- levels will become itemized lists. You can change the location of this
- switch globally by setting the variable
- smallexample
- #+OPTIONS: H:4
- node Table of contents, Paragraphs, Headings and sections, Structural markup elements
- smallexample
- #+OPTIONS: toc:2 (only to two levels in TOC)
- #+OPTIONS: toc:nil (no TOC at all)
- node Paragraphs, Emphasis and monospace, Table of contents, Structural markup elements
- samp{\\} at the end of a line.
- To keep the line breaks in a region, but otherwise use normal formatting, you
- can use this construct, which can also be used to format poetry.
- end smallexample
- When quoting a passage from another document, it is customary to format this
- as a paragraph that is indented on both the left and the right margin. You
- can include quotations in Org-mode documents like this:
- end smallexample
- If you would like to center some text, do it like this:
- end smallexample
- subheading Emphasis and monospace
- You can make words i{/italic/}, _underlined_,
- code{~verbatim~}, and, if you must,
- node Comment lines, , Emphasis and monospace, Structural markup elements
- samp{#} in column zero are treated as comments and will
- never be exported. If you want an indented line to be treated as a comment,
- start it with
- samp{COMMENT} will never be exported. Finally, regions surrounded by
- samp{#+END_COMMENT} will not be exported.
- kbd
- end table
- section Images and Tables
- For Org mode tables, the lines before the first horizontal separator line
- will become table header lines. You can use the following lines somewhere
- before the table to assign a caption and a label for cross references, and in
- the text you can refer to the object with {tab:basic-data
- smallexample
- #+CAPTION: This is the caption for the next table (or link)
- #+LABEL: tbl:basic-data
- | ... | ...|
- |-----|----|
- TeX{}, and DocBook) allow you to directly include
- images into the exported document. Org does this, if a link to an image
- files does not have a description part, for example
- smallexample
- #+CAPTION: This is the caption for the next figure link (or table)
- #+LABEL: fig:SED-HR4049
- [[./img/a.jpg]]
- node Literal examples, Include files, Images and tables, Markup
- smallexample
- #+BEGIN_EXAMPLE
- Some example from a text file.
- #+END_EXAMPLE
- smallexample
- Here is an example
- : Some example from a text file.
- smallexample
- #+BEGIN_SRC emacs-lisp
- (defun org-xor (a b)
- "Exclusive or."
- (if a (not b) b))
- #+END_SRC
- kbd{C-c '} to both enter and leave the editing buffer.
- section Include files
- During export, you can include the content of another file. For example, to
- include your
- smallexample
- #+INCLUDE: "~/.emacs" src emacs-lisp
- noindent
- The optional second and third parameter are the markup (e.g.
- samp{example}, or samp{src}, the
- language for formatting the contents. The markup is optional, if it is not
- given, the text will be assumed to be in Org mode format and will be
- processed normally.
- node Embedded LaTeX, , Include files, Markup
- TeX{}
- For scientific notes which need to be able to contain mathematical symbols
- and the occasional formula, Org-mode supports embedding La
- smallexample
- Angles are written as Greek letters \alpha, \beta and \gamma. The mass if
- the sun is M_sun = 1.989 x 10^30 kg. The radius of the sun is R_} =
- 6.96 x 10^8 m. If $a^2=b$ and $b=2$, then the solution must be either
- $a=+\sqrt}$ or $a=-\sqrt}$.
- \begin}
- x=\sqrt}
- \end}
- noindent With
- seealso{
- node Exporting, Publishing, Markup, Top
- TeX{}/PDF
- for beautiful printed documents and DocBook to enter the world of many other
- formats using DocBook tools. There is also export to iCalendar format so
- that planning information can be incorporated into desktop calendars.
- TeX{}, and processing to PDF
- * DocBook export:: Exporting to DocBook
- * iCalendar export::
- node Export options, The export dispatcher, Exporting, Exporting
- kbd{C-c
- C-e t}.
- kbd
- end table
- code{user-full-name})
- #+DATE: a date, fixed, of a format string for
- code{user-mail-address})
- #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
- #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
- #+LANGUAGE: language for HTML, e.g. code{org-export-default-language})
- #+TEXT: Some descriptive text to be inserted at the beginning.
- #+TEXT: Several lines may be given.
- #+OPTIONS: H:2 num:t toc:t \n:nil :t ::t |:t ^:t f:t TeX:t ...
- #+LINK_UP: the ``up'' link of an exported page
- #+LINK_HOME: the ``home'' link of an exported page
- #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage}
- node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
- table
- item C-c C-e
- Dispatcher for export and publishing commands.
- node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
- table
- item C-c C-e a
- Export as ASCII file.
- r{and} C-c C-e N
- Like the above commands, but use Latin-1 encoding.
- r{and} C-c C-e U
- Like the above commands, but use UTF-8 encoding.
- node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
- table
- item C-c C-e h
- Export as HTML file
- item C-c C-e b
- Export as HTML file and immediately open it with a browser.
- smallexample
- #+HTML: Literal HTML code for export
- noindent or
- end smallexample
- section La
- table
- item C-c C-e l
- Export as Lafile{myfile.tex}.
- TeX{} and then process to PDF.
- TeX{} and then process to PDF, then open the resulting PDF file.
- TeX{} output uses the class
- code{#+LaTeX_CLASS: myclass} in your
- file. The class must be listed in
- TeX{} as described in
- TeX{} file. Similarly to the HTML exporter, you can use
- code{#+BEGIN_LaTeX ... #+END_LaTeX} construct to add
- verbatim LaTeX code.
- section DocBook export
- kbd
- end table
- Similarly to the HTML exporter, you can use
- code{#+BEGIN_DocBook ... #+END_DocBook} construct to add verbatim LaTeX
- code.
- section iCalendar export
- kbd
- file{.ics} file.
- code{org-agenda-files} and write it to the file given by
- end table
- uref{http://orgmode.org/manual/Exporting.html#Exporting, Chapter 12 of the manual}
- uref{http://orgmode.org/worg/org-tutorials/images-and-xhtml-export.php,
- Sebastian Rose's image handling tutorial}
- uref{http://orgmode.org/worg/org-tutorials/org-latex-export.php, Thomas
- Dye's LaTeX export tutorial}
- node Publishing, Working With Source Code, Exporting, Top
- emph{projects} composed of interlinked org
- files. You can also configure Org to automatically upload your exported HTML
- pages and related attachments, such as images and source code files, to a web
- server. For detailed instructions about setup, see the manual.
- Here is an example:
- end smalllisp
- kbd
- item C-c C-e P
- Publish the project containing the current file.
- item C-c C-e E
- Publish every project.
- seealso{
- *
- *
- node Working With Source Code, Miscellaneous, Publishing, Top
- subheading Structure of Code Blocks
- The structure of code blocks is as follows:
- end example
- Where
- code{<language>} specifies the language of the code block
- (e.g. code{shell}, code{python}, etc...),
- code{<header arguments>} can be used to control many aspects of code block
- behavior as demonstrated below, and
- subheading Editing source code
- Use
- kbd{C-c '}
- again to exit the edit buffer.
- kbd{C-c C-c} to evaluate the current code block and insert its results
- in the Org-mode buffer. By default, evaluation is only turned on for
- example
- #+begin_src emacs-lisp
- (+ 1 2 3 4)
- #+end_src
- #+results:
- : 10
- subheading Extracting source code
- Use
- code{org-babel-expand-src-block}
- which can expand both variable and ``noweb'' style references. In order to
- tangle a code block it must have a
- subheading Library of Babel
- Use
- code{contrib/library-of-babel.org}.
- table
- item :var
- The
- item :results
- The emph{collection},
- emph{handling} of code block results. Values of
- code{value} (the default) specify how results are collected
- from a code block's evaluation. Values of code{scalar}
- code{raw} code{latex} and
- code{silent},
- code{prepend}, and
- item :session
- A header argument of
- item :exports
- Any combination of the emph{results} of a block can be
- retained on export, this is specified by setting the
- code{code} code{none} or
- item :tangle
- A header argument of
- code{:tangle filename}.
- code{:cache yes} will cause associate a hash of the
- expanded code block with the results, ensuring that code blocks are only
- re-run when their inputs have changed.
- code{:noweb yes} will expand ``noweb'' style references
- on evaluation and tangling.
- code{:file filename} header argument in which case the results
- are saved to the named file, and a link to the file is inserted into the
- Org-mode buffer.
- seealso{
- *
- node Miscellaneous, , Working With Source Code, Top
- menu
- * Completion:: M-TAB knows what you need
- * Clean view:: Getting rid of leading stars in the outline
- * MobileOrg:: Org-mode on the iPhone
- node Completion, Clean view, Miscellaneous, Miscellaneous
- kbd{M-
- TeX{} symbols after
- samp{:} in a
- headline.
- section A cleaner outline view
- Some people find it noisy and distracting that the Org headlines start with a
- potentially large number of stars, and that text below the headlines is not
- indented. While this is no problem when writing a
- emph{list-oriented} outline, indented structure is a lot cleaner:
- group
- * Top level headline | * Top level headline
- ** Second level | * Second level
- *** 3rd level | * 3rd level
- some text | some text
- *** 3rd level | * 3rd level
- more text | more text
- * Another top level headline | * Another top level headline
- end smallexample
- code{org-indent-mode}, which will prepend intangible space to each line.
- You can turn on
- code{org-startup-indented}, or you can turn it on for individual
- files using
- end smallexample
- If you want a similar effect in earlier version of Emacs and/or Org, or if
- you want the indentation to be hard space characters so that the plain text
- file looks as similar as possible to the Emacs display, Org supports you by
- helping to indent (with
- smallexample
- #+STARTUP: hidestars odd
- node MobileOrg, , Clean view, Miscellaneous
- i{MobileOrg} is an application for the
- seealso{
- *
- *
- bye
- end ignore
- c fill-column: 77
- c LocalWords: webdavhost pre
|