orgguide_en.texi 109 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/orgguide
  4. @settitle Le guide compact du mode Org
  5. @documentencoding UTF-8
  6. @documentlanguage fr
  7. @include org-version.inc
  8. @c Use proper quote and backtick for code sections in PDF output
  9. @c Cf. Texinfo manual 14.2
  10. @set txicodequoteundirected
  11. @set txicodequotebacktick
  12. @c Version and Contact Info
  13. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  14. @set AUTHOR Carsten Dominik
  15. @set MAINTAINER Carsten Dominik
  16. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  17. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  18. @c %**end of header
  19. @finalout
  20. @c Macro definitions
  21. @iftex
  22. @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
  23. @end iftex
  24. @c Subheadings inside a table.
  25. @macro tsubheading{text}
  26. @ifinfo
  27. @subsubheading \text\
  28. @end ifinfo
  29. @ifnotinfo
  30. @item @b{\text\}
  31. @end ifnotinfo
  32. @end macro
  33. @macro seealso{text}
  34. @noindent
  35. @b{Further reading}@*@noindent \text\
  36. @end macro
  37. @copying
  38. Copyright @copyright{} 2010--2014 Free Software Foundation
  39. @quotation
  40. Permission is granted to copy, distribute and/or modify this document
  41. under the terms of the GNU Free Documentation License, Version 1.3 or
  42. any later version published by the Free Software Foundation; with no
  43. Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
  44. and with the Back-Cover Texts as in (a) below. A copy of the license
  45. is included in the section entitled ``GNU Free Documentation License''
  46. in the full Org manual, which is distributed together with the compact
  47. guide.
  48. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  49. modify this GNU manual.''
  50. @end quotation
  51. @end copying
  52. @dircategory Emacs
  53. @direntry
  54. * Org Mode Guide: (orgguide). Abbreviated Org-mode Manual
  55. @end direntry
  56. @titlepage
  57. @title Le guide compact du mode Org
  58. @subtitle Release @value{VERSION}
  59. @author by Carsten Dominik traduit par Laurent Garnier
  60. @c The following two commands start the copyright page.
  61. @page
  62. @vskip 0pt plus 1filll
  63. @insertcopying
  64. @end titlepage
  65. @c Output the table of contents at the beginning.
  66. @shortcontents
  67. @ifnottex
  68. @node Top, Introduction, (dir), (dir)
  69. @top Org Mode Guide
  70. @insertcopying
  71. @end ifnottex
  72. @menu
  73. * Introduction:: Commencer
  74. * Structure de document:: Un arbre fonctionne comme votre cerveau
  75. * Tables:: Pure magie pour le formattage rapide
  76. * Hyperliens:: Notes dans contexte
  77. * Listes TODO:: Chaque branche d'arbre peut être un élément TODO
  78. * Balises:: Marquage des en-tête et correspondances d'ensemble de balises
  79. * Propriétés:: Propriétés
  80. * Dates et heures:: Créer des éléments utiles pour la planification
  81. * Capturer - Sauver - Archiver::Les tenants et les aboutissants des projets
  82. * Les vues de l'agenda:: La collecte d'information en vue
  83. * Marquage:: Préparer le texte pour une exportation riche
  84. * Exportation:: Partage et publication de notes
  85. * Publication:: Créer un site web de fichiers Org liés
  86. * Travail avec le code source:: Extrait de code source intégré dans Org
  87. * Divers:: Tout ce qui n'allait pas ailleurs
  88. * GNU Free Documentation License:: This manual license.
  89. @detailmenu
  90. --- The Detailed Node Listing ---
  91. Introduction
  92. * Préface:: Bienvenue
  93. * Installation:: Comment faire pour installer une version téléchargée de Org
  94. * Activation:: Comment activer Org pour certains tampons
  95. * Réactions:: Rapports debogues, idées, patchs etc.
  96. Structure du document
  97. * Grandes lignes:: Org est basé sur le mode Outline
  98. * Titres :: Comment composer des titres d'arbres Org
  99. * Cycle de visibilité:: Afficher et masquer, très simplifié
  100. * Motion:: Sauts à d'autres titres
  101. * Structure d'édition:: Modification de la séquence et le niveau des titres
  102. * Arbres clairsemés:: Correspondances intégrées dans le contexte
  103. * Listes complètes:: Structure supplémentaire dans une entrée
  104. * Notes:: Comment les notes sont définies dans la syntaxe de Org
  105. Hyperliens
  106. * Format de lien:: Comment les liens sont formatés dans Org
  107. * Liens internes:: Liens vers d'autres endroits dans le fichier actuel
  108. * Liens externes:: Les URL comme des liens vers le monde
  109. * Manipulation de liens:: Création, insertion et suivant
  110. * Liens ciblés:: Le point, à un emplacement dans un fichier
  111. Listes TODO
  112. * Utilisation des états TODO:: Configuration et basculement des états
  113. * Flux de travail multi-état:: Plus qu'un simple marche/arrêt
  114. * Journalisation des progrès:: Dates et notes des progrès
  115. * Priorités:: Certaines choses sont plus importantes que d'autres
  116. * Diviser les tâches:: Fractionnement d'une tâche en éléments gérables
  117. * Boîtes à cocher:: Listes à cocher
  118. Journalisation des progrès
  119. * Fermeture des items:: Quand cet item a été marqué DONE?
  120. * Suivi des basculement d'états TODO:: Quand cet état a-t-il basculé?
  121. Balises
  122. * Héritage de balise:: Mots clés qui utilisent la structure arborescente des grandes lignes
  123. * Configuration des balises:: Comment attribuer des balises à un titre
  124. * Balise de groupes:: Utilisez une balise pour en chercher plusieurs
  125. * Recherche de balise:: A la recherche de combinaisons de balises
  126. Dates et heures
  127. * Horodatages:: Donner une durée à une entrée de l'arborescence
  128. * Création d'horodatages:: Les commandes qui insèrent des horodateurs
  129. * Dates limites et calendrier:: Planification de votre travail
  130. * Chronométrage du temps de travail:: Suivi du temps passé sur une tâche
  131. Capturer - Sauver - Archiver
  132. * Capture:: Capture de nouvelles choses
  133. * Sauver et copier:: Déplacement d'un arbre d'un endroit à un autre
  134. * Archivage:: Que faire avec des projets finis
  135. Capture
  136. * Configuration d'un emplacement de capture:: Où les notes seront stockées
  137. * Utilisation de capture:: Commandes qui invoquent et terminent la capture
  138. * Modèles de capture:: Définir le contour des types de notes différentes
  139. Vues de l'agenda
  140. * Fichiers de l'agenda:: Fichiers recherchés pour les informations de l'agenda
  141. * Répartiteur de l'agenda:: Accès clavier de l'agenda
  142. * Les vues intégrées dans l'agenda:: Ce qui est disponible hors de la boîte ?
  143. * Commandes de l'agenda:: Montage à distance des arbres Org
  144. * Personnaliser les vues de l'agenda:: Définition de recherches spéciales et vues
  145. Les vues intégrées dans l'agenda
  146. * L'agenda quotidien/hebdomadaire:: La page du calendrier avec les tâches actuelles
  147. * Liste TODO globale:: Tous les éléments d'action inachevées
  148. * Correspondance balises et propriétés:: Informations structurées avec recherche affinée
  149. * Chronologie:: Vue chronologique pour un fichier unique
  150. * Vue de recherche:: Trouver des entrées par recherche de texte
  151. Marquages pour exportation riche
  152. * Eléments structurels de marquage:: La structure de base comme vue par l'exportateur
  153. * Tableaux et imagess:: Images, tableaux et mécanisme de légende
  154. * Exemples littéraux:: Des exemples de code source avec un formatage spécial
  155. * Inclure des fichiers:: Inclure des fichiers supplémentaires dans un document
  156. * @LaTeX{} embarqué:: @LaTeX{} peut être utilisé librement à l'intérieur des documents Org
  157. Eléments de balisage structurels
  158. * Titre du document:: Lorsque le titre est tiré de
  159. * Rubriques et sections:: La structure de document telle que vue par l'exportateur
  160. * Table des matières:: Le si et où de la table des matières
  161. * Paragraphes:: Paragraphes
  162. * Emphase et monospace:: Gras, italique, etc.
  163. * Commentaires:: Ce qui *ne* sera *pas* exporté
  164. Exportation
  165. * Options d'exportation:: Les paramètres par fichier d'exportation
  166. * Le répartiteur exportation:: Comment accéder aux commandes de l'exportateur
  167. * Exporter en ASCII/Latin-1/UTF-8 ::Exportation vers des fichiers avec encodage
  168. * Exporter en HTML:: Exportation en HTML
  169. * Exporter en @LaTeX{} et PDF ::Exportation en @LaTeX{}, et traitement en PDF
  170. * Exporter vers iCalendar:: Exportation vers iCalendar
  171. Divers
  172. * Complétion:: M-TAB connaît ce dont vous avez besoin
  173. * Vue propre:: Se débarasser des étoiles dans les grandes lignes
  174. * MobileOrg:: Mode Org sur l'iPhone
  175. @end detailmenu
  176. @end menu
  177. @node Introduction, Structure du document, Top, Top
  178. @chapter Introduction
  179. @menu
  180. * Préface:: Bienvenue
  181. * Installation:: Comment faire pour installer une version téléchargée de Org
  182. * Activation:: Comment activer Org pour certains tampons
  183. * Réactions:: Rapports debogues, idées, patchs etc.
  184. @end menu
  185. @node Préface, Installation, Introduction, Introduction
  186. @section Préface
  187. Org est un mode pour prendre des notes, maintenir des listes TODO, et faire
  188. de la planification de projet avec un système de texte brut rapide et efficace.
  189. Il est également un système de création et de publication, et il permet le
  190. travail avec du code source pour la programmation littérale et la recherche
  191. reproductible.
  192. @i{Ce document est un dérivé beaucoup plus comprimé du
  193. @uref{http://orgmode.org/index.html#sec-4_1, manuel complet Org-Mode}.
  194. Il contient toutes les fonctions de base et des commandes, ainsi que des
  195. conseils importants pour la personnalisation. Il est destiné aux débutants
  196. intimidés par un manuel de 200 pages uniquement à cause de sa taille.}
  197. @node Installation, Activation, Préface, Introduction
  198. @section Installation
  199. @b{Important:} @i{Si vous utilisez une version de Org qui fait partie de la
  200. distribution d'Emacs ou un paquet XEmacs, prière sauter cette section et allez
  201. directement à la @ref{Activation}.}
  202. Si vous avez téléchargé à partir Org depuis le Web, soit comme une distribution
  203. @file{.zip} ou un fichier @file{.tar}, ou comme une archive Git, il est
  204. préférable de l'exécuter directement à partir du répertoire de distribution. Vous
  205. devez ajouter le sous-répertoire @file{lisp} au chemin de chargement d'Emacs.
  206. Pour ce faire, ajoutez la ligne suivante à votre fichier de configuration
  207. @file{.emacs}:
  208. @smallexample
  209. (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
  210. (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
  211. @end smallexample
  212. @noindent
  213. Pour aller plus vite vous devriez byte-compiler le fichier Lisp avec la
  214. commande shell :
  215. @smallexample
  216. make autoloads
  217. @end smallexample
  218. @node Activation, Réactions, Installation, Introduction
  219. @section Activation
  220. Ajoutez les lignes suivantes à votre fichier @file{.emacs}. Les quatre dernières
  221. définissent des touches @emph{globales} pour certaines commandes --- prière
  222. de choisir les touches appropriées vous-même.
  223. @smalllisp
  224. ;; The following lines are always needed. Choose your own keys.
  225. (global-set-key "\C-cl" 'org-store-link)
  226. (global-set-key "\C-ca" 'org-agenda)
  227. (global-set-key "\C-cc" 'org-capture)
  228. (global-set-key "\C-cb" 'org-iswitchb)
  229. @end smalllisp
  230. Avec cette configuration, tous les fichiers avec l'extension @samp{.org}
  231. seront mis en mode Org.
  232. @node Réactions, Activation, Introduction
  233. @section Réactions
  234. Si vous rencontrez des problèmes avec Org, ou si vous avez des questions,
  235. remarques, ou idées à propos de lui, prière d'envoyez un mail à
  236. la liste de diffusion @email{emacs-orgmode@@gnu.org}. Pour plus
  237. d'informations sur comment soummettre les rapports de bogues, voir le manuel
  238. complet.
  239. @node Structure du document, Tables, Introduction, Top
  240. @chapter Structure du document
  241. Org est basé sur le mode Outline et fournit des commandes flexibles pour
  242. éditer la structure du document.
  243. @menu
  244. * Outline:: Org est basé sur le mode Outline
  245. * Titres :: Comment composer des titres d'arbres Org
  246. * Cycle de visibilité:: Afficher et masquer, très simplifié
  247. * Motion:: Sauts à d'autres titres
  248. * Structure d'édition:: Modification de la séquence et le niveau des titres
  249. * Arbres clairsemés:: Correspondances intégrées dans le contexte
  250. * Listes complètes:: Structure supplémentaire dans une entrée
  251. * Notes:: Comment les notes sont définies dans la syntaxe de Org
  252. @end menu
  253. @node Outline, Lignes d'en-tête, Structure du document, Structure du document
  254. @section Outline
  255. Org est implémenté par dessus le mode Outline. Les grandes lignes permettent
  256. au document d'être organisé avec une structure hiérarchique, qui (au moins
  257. pour moi) est la meilleure représentation de notes et pensées. Un aperçu de
  258. cette structure est réalisée en pliant (dépliant) de grandes parties du
  259. document pour montrer que la structure générale du document et les parties
  260. en cours d'élaboration. Org simplifie grandement l'utilisation de grandes
  261. lignes en comprimant l'ensemble de la fonctionnalité montrer/cacher en une
  262. seule commande, @command{org-cycle}, qui est liée avec la touche @key{TAB}.
  263. @node Lignes d'en-tête, Cycle de visibilité, Outlines, Structure du document
  264. @section Lignes d'en-tête
  265. Les lignes d'en-tête définissent la structure d'une grande ligne de l'arbre.
  266. Les lignes d'en-tête dans Org commencent par une ou plusieurs étoiles,
  267. dans la marge de gauche@footnote{Voir la variable @code{org-special-ctrl-a/e}
  268. pour configurer un comportement spécial de @kbd{C-a} et @kbd{C-e} dans les
  269. lignes d'en-tête.}.
  270. Par exemple :
  271. @smallexample
  272. * Ligne d'en-tête de niveau un
  273. ** Deuxième niveau
  274. *** Troisième niveau
  275. du texte
  276. *** Troisième niveau
  277. encore du texte
  278. * Une autre ligne d'en-tête de niveau un
  279. @end smallexample
  280. @noindent Notez qu'une ligne d'en-tête nommée d'après @code{org-footnote-section},
  281. qui par défaut @samp{Notes}, est considérée comme spéciale. Un sous-arbre
  282. avec cette ligne d'en-tête sera ignoré par des fonctions d'exploration.
  283. Certaines personnes trouvent l'abus d'étoiles trop embêtant et préfèreraient
  284. une grande ligne qui ait des espaces suivis par une seule étoile comme début
  285. de ligne d'en-tête. @ref{Clean view}, décrit une configuration qui réalise cela.
  286. @node Cycle de visibilité, Motion, Lignes d'en-tête, Structure du document
  287. @section Cycle de visibilité
  288. Les grandes lignes permettent de cacher des parties du texte dans le tampon.
  289. Org n'utilise que deux commands, liées à @key{TAB} et
  290. @kbd{S-@key{TAB}} pour changer la visibilité du tampon..
  291. @table @kbd
  292. @item @key{TAB}
  293. @emph{Cycle de l'arborescence}: Rotation courante de l'arborescence à
  294. travers les états
  295. @smallexample
  296. ,-> PLIE -> ENFANTS -> ARBORESCENCE --.
  297. '-------------------------------------'
  298. @end smallexample
  299. Lorsqu'appelé avec un argument préfixé (@kbd{C-u @key{TAB}}) ou avec la touche
  300. shift, le cycle global est invoqué.
  301. @item S-@key{TAB} @r{and} C-u @key{TAB}
  302. @emph{Cycle global:} Rotation du tampon entier à travers les états
  303. @smallexample
  304. ,-> APERCU -> CONTENU -> TOUT MONTRER --.
  305. '---------------------------------------'
  306. @end smallexample
  307. @item C-u C-u C-u @key{TAB}
  308. Montre tout, y compris les tiroirs.
  309. @end table
  310. Quand Emacs visite une première fois un fichier Org, l'état global est
  311. configuré à OVERVIEW, i.e. seules les lignes d'en-tête de niveau 1 sont
  312. visibles. Cela peut être configuré à travers la variable
  313. @code{org-startup-folded}, ou sur la base d'un fichier-per en ajoutant un
  314. raccourci clavier de démarrage @code{overview}, @code{content},
  315. @code{showall}, comme ça :
  316. @smallexample
  317. #+STARTUP: content
  318. @end smallexample
  319. @node Motion, Structure d'édition, Cycle de visibilité, Structure du document
  320. @section Motion
  321. Les commandes suivantes sautent jusqu'à d'autres lignes d'en-tête dans le
  322. tampon:
  323. @table @kbd
  324. @item C-c C-n
  325. Prochain en-tête.
  326. @item C-c C-p
  327. Précédent en-tête.
  328. @item C-c C-f
  329. Prochain en-tête de même niveau.
  330. @item C-c C-b
  331. Précédent en-tête de même niveau.
  332. @item C-c C-u
  333. Retour vers l'en-tête de plus au niveau.
  334. @end table
  335. @node Structure d'édition, Arbres clairsemés, Motion, Structure du document
  336. @section Structure d'édition
  337. @table @kbd
  338. @item M-@key{RET}
  339. Insérez une nouvelle rubrique avec même niveau que l'actuelle.
  340. Si le curseur est dans une liste simple, un nouvel élément est créé
  341. (@pxref{Listes complètes}). Lorsque
  342. cette commande est utilisée dans le milieu d'une ligne, la ligne
  343. est divisée et le reste de la ligne devient le nouveau
  344. titre@footnote{Si vous ne voulez pas que la ligne soit divisée, personnalisez la
  345. variable @code{org-M-RET-may-split-line}.}.
  346. @item M-S-@key{RET}
  347. Insère une nouvelle entrée TODO avec le même niveau que l'en-tête
  348. courante.
  349. @item @key{TAB} @r{in new, empty entry}
  350. Dans une nouvelle entrée, encore vierge, @key{TAB} bouclera à travers les niveaux
  351. raisonnables.
  352. @item M-@key{left}@r{/}@key{right}
  353. Promouvoir/rétrograder l'entrée actuelle d'un niveau.
  354. @item M-S-@key{left}@r{/}@key{right}
  355. Promouvoir/rétrograder le sous-arbre actuel d'un niveau.
  356. @item M-S-@key{up}@r{/}@key{down}
  357. Déplacer l'arborescence vers le haut/bas (échange avec le sous-arbre
  358. précédent/suivant de même niveau).
  359. @item C-c C-w
  360. Enregistre l'entrée ou la région à un autre emplacement. @xref{Refile and copy}.
  361. @item C-x n s/w
  362. Réduit le tampon à la sous-arborescence actuelle / l'élargit à nouveau.
  363. @end table
  364. Quand il y a une région active (Transient Mark mode), monter/descendre
  365. fonctionne pour toutes les lignes d'en-tête de la région.
  366. @node Arbres clairsemés, Listes complètes, Structure d'édition, Structure du document
  367. @section Arbres clairsemés
  368. Une caractéristique importante du mode Org est la capacité de construire des
  369. @emph{arbres clairsemés} pour les informations sélectionnées dans un arbre de
  370. grande ligne, de sorte que la totalité du document est pliée au maximum,
  371. mais l'information sélectionnée est rendue visible avec la structure de cette
  372. ligne d'en-tête ci-dessus@footnote{Voir aussi la variable
  373. @code{org-show-context-detail} pour décider comment le contexte est montré autour
  374. de chaque correspondance.}. Juste essayez et vous verrez immédiatement comment
  375. ça marche.
  376. Le mode Org contient plusieurs commandes de création telle que les arbres,
  377. toutes ces commandes peuvent être atteintes via un répartiteur:
  378. @table @kbd
  379. @item C-c /
  380. Cela invite à ajouter une touche pour sélectionner une commande
  381. de création d'arbre clairsemé.
  382. @item C-c / r
  383. Demande une expression régulière et montre un arbre clairsemé avec
  384. toutes les correspondances qui sont mises en sur-brillance; la
  385. sur-brillance disparait en tapant @kbd{C-c C-c}.
  386. @end table
  387. Les autres commandes d'abre clairsemés sélectionnent les titres basés sur les
  388. mots clés TODO, les balises, ou les propriétés et seront discutés plus tard
  389. dans ce manuel.
  390. @node Listes complètes, Notes, Arbres clairsemés, Structure du document
  391. @section Listes complètes
  392. Dans une entrée de l'arbre des grandes lignes, les listes formatées à la main
  393. peuvent fournir une structure supplémentaire. Elles fournissent également un
  394. moyen de créer des listes de cases à cocher (@pxref{Cases à cocher}). Org permet
  395. l'édition de telles listes, et l'exportateur HTML (@pxref{Exporting}) les analyse
  396. et les formate.
  397. Org connaît les listes ordonnées, non ordonnées, et les listes de description.
  398. @itemize @bullet
  399. @item
  400. les items des listes @emph{non ordonnées} commencent avec @samp{-}, @samp{+}, ou
  401. @samp{*} comme puces.
  402. @item
  403. les items des listes @emph{ordonnées} commencent avec @samp{1.} or @samp{1)}.
  404. @item
  405. les listes de @emph{description} utilisent @samp{ :: } pour séparate le
  406. @emph{terme} de la description.
  407. @end itemize
  408. Les items appartenant à la même liste doivent avoir la même empreinte sur la
  409. première ligne. Un item finit avant la ligne suivante qui est indentée
  410. comme sa puce/son nombre, ou moins. Une liste se termine quand tous les items
  411. sont fermés, ou avant deux lignes blanches. Un exemple:
  412. @smallexample
  413. @group
  414. ** Le seigneur des anneaux
  415. Mes scènes préférées sont (dans cet ordre)
  416. 1. L'attaque de Rohirrim
  417. 2. Le combat d'Eowyn avec le roi sorcier
  418. + C'était déjà ma scène favorite dans le livre.
  419. + J'aime vraiment Miranda Otto.
  420. Les acteurs importants dans le film sont :
  421. - @b{Elijah Wood} :: Il joue Frodon
  422. - @b{Sean Austin} :: Il joue Sam, l'ami de Frodon.
  423. @end group
  424. @end smallexample
  425. Les commandes suivantes agissent sur les items quand le curseur est dans la
  426. première ligne d'un item (la ligne avec la puce ou le nombre).
  427. @table @kbd
  428. @item @key{TAB}
  429. Les items peuvent être pliés juste comme les niveaux de lignes d'en-tête.
  430. @item M-@key{RET}
  431. Insère un nouvel item au niveau en cours. Avec un argument
  432. préfixé, force le nouveau titre (@pxref{Structure d'édition}).
  433. @item M-S-@key{RET}
  434. Insère un nouvel item avec une boîte à cocher (@pxref{Cases à cocher}).
  435. @item M-S-@key{up}@r{/}@key{down}
  436. Déplace l'item incluant des sous-items vers le haut/bas (échange
  437. avec l'item précédent/suivant de même niveau d'indentation). Si
  438. la liste est ordonnée, la renumérotation est automatique.
  439. @item M-@key{left}@r{/}M-@key{right}
  440. Augmente/diminue l'indentation d'un item, laissant les enfants
  441. seuls.
  442. @item M-S-@key{left}@r{/}@key{right}
  443. Augmente/diminue l'indentation d'un item, incluant les sous-items.
  444. @item C-c C-c
  445. Si il y a une boîte à cocher (@pxref{Cases à cocher}) dans la ligne d'item,
  446. modifie l'état de la boîte à cocher. Vérifie aussi les puces et la cohérence de
  447. toute la liste.
  448. @item C-c -
  449. Cycle la liste entière des niveaux à travers les différents
  450. items/numéros
  451. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
  452. @end table
  453. @node Notes, Listes complètes, Structure du document
  454. @section Notes
  455. Une note de bas de page est définie dans un paragraphe qui a commencé par une
  456. marque de la note de bas de page entre des crochets en colonne 0, aucune
  457. indentation n'est autorisée. La référence de la note de bas de page est
  458. simplement la marque entre crochets, à l'intérieur du texte. Par exemple:
  459. @smallexample
  460. La page d'accueil Org[fn:1] est maintenant beaucoup mieux qu'auparavant.
  461. ...
  462. [fn:1] Le lien est: http://orgmode.org
  463. @end smallexample
  464. @noindent
  465. Les commandes suivantes manipulent les notes de bas de pages :
  466. @table @kbd
  467. @item C-c C-x f
  468. La commande de création de note. Quand le curseur est
  469. sur une référence de note, il saute sur la définition.
  470. Quand c'est une définition, il saute sur la (première)
  471. référence. Quand cette commande est appelée avec un
  472. argument préfixé, un menu d'options supplémentaires
  473. incluant la rénumérotation est proposé.
  474. @item C-c C-c
  475. Saute entre les définitions et références.
  476. @end table
  477. @seealso{
  478. @uref{http://orgmode.org/manual/Document-Structure.html#Document-Structure,
  479. Chapter 2 of the manual}@*
  480. @uref{http://sachachua.com/wp/2008/01/outlining-your-notes-with-org/,
  481. Sacha Chua's tutorial}}
  482. @node Tables, Hyperliens, Structure du document, Top
  483. @chapter Tables
  484. Org vient avec un éditeur de tableau intuitif et rapide. Les calculs de type
  485. tableur sont supportés avec le paquet Emacs @file{calc}
  486. @ifinfo
  487. (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
  488. @end ifinfo
  489. @ifnotinfo
  490. (voir le manuel Emacs Calculator pour plus d'informations sur ce sujet).
  491. @end ifnotinfo
  492. Org permet facilement de formater des tableaux en ASCII. Chaque ligne avec
  493. @samp{|} comme le premier caractère non-espace est considéré comme une partie de
  494. la table. @samp{|} est aussi le séparateur de colonne. Une table pourrait
  495. ressembler à ceci:
  496. @smallexample
  497. | Nom | Tél. | Age |
  498. |-------+-------+-----|
  499. | Peter | 1234 | 17 |
  500. | Anna | 4321 | 25 |
  501. @end smallexample
  502. Une table est ré-alignée automatiquement chaque fois que vous pressez @key{TAB} ou
  503. @key{RET} ou @kbd{C-c C-c} à l'intérieur de la table. @key{TAB} déplace aussi le
  504. prochain champ (@key{RET} pour la prochaine ligne) et crée une table des lignes à
  505. la fin de la table ou avant la ligne horizontale. L'indentation de cette table
  506. est configurée par la première ligne. Toute ligne commençant par @samp{|-} est
  507. considérée comme un séparateur horizontal de ligne et sera développé sur le
  508. prochain ré-alignement afin de couvrir toute la largeur de la table. Donc, pour
  509. créer le tableau ci-dessus vous taperez seulement
  510. @smallexample
  511. |Nom|Tél.|Age|
  512. |-
  513. @end smallexample
  514. @noindent
  515. en ensuite presserez @key{TAB} pour aligner la table et commencer à remplir les
  516. champs. Encore plus vite vous pourriez taper @code{|Nom|Tél.|Age} suivi par
  517. @kbd{C-c @key{RET}}.
  518. Lorsque vous tapez du texte dans un champ, Orgl traite @key{DEL},
  519. @key{Backspace}, et toutes les touches de caractères d'une façon spéciale, telle
  520. que l'insertion et la suppression évite de décaler les autres champs. Aussi,
  521. lorsque vous taper @emph{immédiatement après que le curseur ait bougé dans un
  522. nouveau champ avec @kbd{@key{TAB}}, @kbd{S-@key{TAB}} ou @kbd{@key{RET}}}, le
  523. champ est automatiquement mis en blanc.
  524. @table @kbd
  525. @tsubheading{Création et conversion}
  526. @item C-c |
  527. Convertit la region active en table. Si chaque ligne contient au moins un
  528. caractère TAB, the function assumes that the material is tab separated. If every
  529. line contains a comma, comma-separated values (CSV) are assumed. la fonction
  530. suppose que le matériel est séparé par une tabulation. Si chaque ligne contient
  531. une virgule, une valeur de virgule de séparation (CSV) est supposée.
  532. Sinon, les lignes sont divisées au niveau des espaces dans les champs.
  533. @*
  534. S'il n'y a pas de région active, cette commande crée une table
  535. Org vide. Mais c'est juste plus facile de commencer à taper,
  536. comme
  537. @kbd{|Nom|Tél.|Age C-c @key{RET}}.
  538. @tsubheading{Ré-alignement et mouvement de champ}
  539. @item C-c C-c
  540. Ré-aligne la table sans déplacement du curseur.
  541. @c
  542. @item @key{TAB}
  543. Ré-aligne la table, déplace vers le prochain champ. Crée
  544. une nouvelle ligne si nécessaire.
  545. @c
  546. @item S-@key{TAB}
  547. Ré-aligne, déplace au champ précédent.
  548. @c
  549. @item @key{RET}
  550. Ré-aligne la table et déplace vers le bas vers la prochaine ligne. Crée une
  551. nouvelle ligne si nécessaire.
  552. @tsubheading{Edition de ligne et colonne}
  553. @item M-@key{left}
  554. @itemx M-@key{right}
  555. Déplace la colonne courante vers la gauche/droite.
  556. @c
  557. @item M-S-@key{left}
  558. Détruit la colonne courante.
  559. @c
  560. @item M-S-@key{right}
  561. Insère une nouvelle colonne vers la gauche depuis la position du curseur.
  562. @c
  563. @item M-@key{up}
  564. @itemx M-@key{down}
  565. Déplace la ligne courante vers le haut/bas.
  566. @c
  567. @item M-S-@key{up}
  568. Détruit la ligne courante ou la ligne horizontale.
  569. @c
  570. @item M-S-@key{down}
  571. Insère une nouvelle ligne au-dessus de la courante. Avec un
  572. argument préfixé, la ligne est créée en dessous de la courante.
  573. @c
  574. @item C-c -
  575. Insère une ligne horizontale en dessous de la courante. Avec un
  576. argument préfixé, la ligne est créée au dessus de la courante.
  577. @c
  578. @item C-c @key{RET}
  579. Insère une ligne horizontale en dessous de la courante, et
  580. déplace le cursuer à la ligne en dessous de l'horizontale.
  581. @c
  582. @item C-c ^
  583. Tri les lignes de la table dans la région. La position du point
  584. indique les colonnes utilisées pour le tri, et le rang des
  585. lignes est le rang entre la plus proche ligne de séparation
  586. horizontale, ou la table entière.
  587. @end table
  588. @seealso{
  589. @uref{http://orgmode.org/manual/Tables.html#Tables, Chapter 3 of the
  590. manual}@*
  591. @uref{http://orgmode.org/worg/org-tutorials/tables.php, Bastien's
  592. table tutorial}@*
  593. @uref{http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.php,
  594. Bastien's spreadsheet tutorial}@*
  595. @uref{http://orgmode.org/worg/org-tutorials/org-plot.php, Eric's plotting tutorial}}
  596. @node Hyperliens, Listes TODO, Tables, Top
  597. @chapter Hyperliens
  598. Comme HTML, Org fournit des liens à l'intérieur d'un fichier, des liens
  599. externes vers d'autres fichiers, des articles Usenet, des e-mails, et
  600. beaucoup plus.
  601. @menu
  602. * Format de lien:: Comment les liens sont formatés dans Org
  603. * Liens internes:: Liens vers d'autres endroits dans le fichier actuel
  604. * Liens externes:: Les URL comme des liens vers le monde
  605. * Manipulation de liens:: Création, insertion et suivant
  606. * Liens ciblés:: Le point, à un emplacement dans un fichier
  607. @end menu
  608. @node Format de lien, Liens internes, Hyperliens, Hyperliens
  609. @section Format de lien
  610. Org reconnaîtra des liens URL et les activera comme liens cliquables. Le
  611. format général pour les liens, cependant, ressemblera ceci:
  612. @smallexample
  613. [[lien][description]] @r{ou alternativement} [[lien]]
  614. @end smallexample
  615. @noindent
  616. Une fois qu'un lien est complet (tous les crochets sont fermés) dans le
  617. buffer, Org changera l'affichage de sorte que @samp{description} soit affiché
  618. au lieu de
  619. @samp{[[link][description]]} et @samp{link} est affiché au lieu de
  620. @samp{[[link]]}. Pour éditer la partie invisible @samp{link}, utiliser @kbd{C-c
  621. C-l} avec le curseur sur le lien.
  622. @node Liens internes, Liens externes, Format de lien, Hyperliens
  623. @section Liens internes
  624. Si le lien ne ressemble pas à une URL, il est considéré comme interne au
  625. fichier courant. Le cas le plus important est lien comme
  626. @samp{[[#my-custom-id]]} qui fera la liaison entre l'entrée et la propriété
  627. @code{CUSTOM_ID} de @samp{my-custom-id}.
  628. Des liens comme @samp{[[My Target]]} ou @samp{[[My Target][Find my target]]}
  629. mènent à une recherche de texte dans le fichier courant pour les cibles
  630. correspondantes qui ressemblent à @samp{<<My Target>>}.
  631. Les liens internes seront utilisés pour se référer à leur destination, via
  632. des liens ou des nombres, si possible.
  633. @node Liens externes, Liens manuels, Liens internes, Hyperliens
  634. @section Liens externes
  635. Org supporte les liens vers des fichiers, vers sites web, vers Usenet et vers
  636. des messages e-mail, vers des entrées de base de données BBDB et des liens
  637. vers des conversations et journaux IRC. Les liens externes sont des
  638. localisateurs d'URL. Ils commencent par une courte chaîne d'identification
  639. suivi de deux points. Il ne peut y avoir d'espace après les deux points.
  640. Voici quelques exemples:
  641. @smallexample
  642. http://www.astro.uva.nl/~dominik @r{sur le web}
  643. file:/home/dominik/images/jupiter.jpg @r{fichier, chemin absolu}
  644. /home/dominik/images/jupiter.jpg @r{idem que ci-dessus}
  645. file:papers/last.pdf @r{fichier, chemin relatif}
  646. file:projects.org @r{un autre fichier Org}
  647. docview:papers/last.pdf::NNN @r{fichier ouvert en doc-mode view à la page NNN}
  648. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{lien vers l'en-tête avec ID}
  649. news:comp.emacs @r{lien Usenet}
  650. mailto:adent@@galaxy.net @r{lien Mail}
  651. vm:folder @r{lien dossier VM}
  652. vm:folder#id @r{lien message VM}
  653. wl:folder#id @r{lien message WANDERLUST}
  654. mhe:folder#id @r{lien message MH-E}
  655. rmail:folder#id @r{lien message RMAIL}
  656. gnus:group#id @r{lien article Gnus}
  657. bbdb:R.*Stallman @r{lien BBDB (avec expression régulière)}
  658. irc:/irc.com/#emacs/bob @r{lien IRC}
  659. info:org:External%20links @r{lien noeud Info (avec un espace encodé)}
  660. @end smallexample
  661. Un lien devrait être entouré de doubles crochets et peut contenir un texte de
  662. description qui sera affiché à la place de l'URL (@pxref{Link
  663. format}), par exemple:
  664. @smallexample
  665. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  666. @end smallexample
  667. @noindent
  668. Si la description est un nom de fichier ou une URL qui pointe vers une image,
  669. l'exportation HTML (@pxref{HTML export}) rendra l'image cliquable. S'il n'y a
  670. pas de description et que le lien pointe sur une image, cette image sera
  671. reliée dans l'exportation HTML.
  672. @node Liens manuels, Liens ciblés, Liens externes, Hyperliens
  673. @section Liens manuels
  674. Org fournit des méthodes pour créer un lien avec une bonne syntaxe, pour
  675. l'insérer dans un fichier Org, et faire suivre le lien.
  676. @table @kbd
  677. @item C-c l
  678. Stocke un lien à l'emplacement courant. C'est une commande @emph{globale}
  679. (vous devez créer la liaison vous-même) qui peut être utilisée dans
  680. n'importe quel buffer pour créer un lien. Le lien sera stocké pour
  681. des insertions ultérieures dans un buffer Org (voir plus bas).
  682. @c
  683. @item C-c C-l
  684. Insère un lien. Cela attend un lien à insérer dans le buffer. Vous
  685. pouvez juste taper un lien, ou utiliser les flèches @key{haut} et @key{bas}
  686. pour accéder aux liens stockés. On vous demandera de saisir la
  687. description du lien. Lorsqu'appelée avec un argument préfixé @kbd{C-u}, la
  688. complétion de nom de fichier est utilisée pour lier à un fichier.
  689. @c
  690. @item C-c C-l @r{(with cursor on existing link)}
  691. Quand le curseur est sur un lien existant, @kbd{C-c C-l} vous permet d'éditer
  692. le lien et sa description.
  693. @c
  694. @item C-c C-o @r{or} mouse-1 @r{or} mouse-2
  695. Ouvre le lien au point.
  696. @item C-c &
  697. Revient sur une position enregistrée. Une position est enregistrée
  698. par la commande suivant les liens internes, et par @kbd{C-c %}. L'utilisation
  699. de cette commande plusieurs fois successivement déplace à travers le cycle des
  700. positions précédemment enregistrées.
  701. @c
  702. @end table
  703. @node Liens ciblés, , Liens manuels, Hyperliens
  704. @section Liens ciblés
  705. Les liens de fichiers contiennent des information supplémentaires pour
  706. permettre à Emacs d'aller à des endroits particuliers dans le fichier en
  707. suivant un lien. Cela peut être un numéro de ligne ou une option de
  708. recherche après deux points (@key{:}).
  709. Voici la syntaxe des différentes façon de lier une recherche à un fichier
  710. lien, ensemble avec une explication :
  711. @smallexample
  712. [[file:~/code/main.c::255]] @r{Trouve la ligne 255}
  713. [[file:~/xx.org::Ma Cible]] @r{Find @samp{<<Ma Cible>>}}
  714. [[file:~/xx.org::#my-custom-id]] @r{Trouve les entrées avec id
  715. personnalisé}
  716. @end smallexample
  717. @seealso{
  718. @uref{http://orgmode.org/manual/Hyperlinks.html#Hyperlinks, Chapter 4 of the
  719. manual}}
  720. @node Listes TODO, Balises, Hyperliens, Top
  721. @chapter Listes TODO
  722. Le mode Org ne nécessite pas que les listes TODO (de tâches) soient dans des
  723. documents à part. Les listes TODO font partie d'un fichier de notes, parce que
  724. les listes TODO viennent habituellement en prenant des notes! Avec le mode Org,
  725. il suffit de marquer une entrée dans un arbre comme étant un élément TODO. De
  726. cette façon, les informations ne sont pas dupliquées, et les listes TODO
  727. restent dans le contexte dont elles sont issues.
  728. Le mode Org fournissant des méthodes pour vous donner un aperçu de toutes les
  729. choses que vous avez à faire, recueillies auprès de nombreux fichiers.
  730. @menu
  731. * Utilisation des états TODO:: Configuration et basculement des états
  732. * Flux de travail multi-état:: Plus qu'un simple marche/arrêt
  733. * Journalisation des progrès:: Dates et notes des progrès
  734. * Priorités:: Certaines choses sont plus importantes que d'autres
  735. * Diviser les tâches:: Fractionnement d'une tâche en éléments gérables
  736. * Boîtes à cocher:: Listes à cocher
  737. @end menu
  738. @node Utilisation des états TODO, Flux de travail multi-état, Listes TODO, Listes TODO
  739. @section Utilisation des états TODO
  740. N'importe qu'elle ligne d'en-tête devient un item TODO lorsqu'elle commence
  741. par le mot @samp{TODO}, par exemple:
  742. @smallexample
  743. *** TODO Ecrire une lettre à Sam Fortune
  744. @end smallexample
  745. @noindent
  746. Les commandes la plus importantes fonctionnant avec les entrées TODO sont :
  747. @table @kbd
  748. @item C-c C-t
  749. Permutation de l'état actuel de TODO parmi les deux états possibles :
  750. @smallexample
  751. (unmarked) -> TODO -> DONE -> (unmarked)
  752. @end smallexample
  753. La même rotation peut être effectuée ``à distance'' à partir de la chronologie
  754. et des tampons agenda avec la commande @kbd{t} (@pxref{Commandes de l'agenda}).
  755. @item S-@key{right}@r{/}@key{left}
  756. Sélectionne l'état TODO suivant/précédent, de façon cyclique.
  757. @item C-c / t
  758. Voir les listes TODO dans un @emph{arbre clairsemé} (@pxref{Arbres clairsemés}).
  759. Plie le tampon, mais montre toutes les listes TODO et la hiérarchie des
  760. rubriques au dessus d'elles.
  761. @item C-c a t
  762. Montre la liste TODO en entier. Collecte les items TODO du
  763. fichier agenda (@pxref{Vues de l'agenda}) dans un tampon simple.
  764. @xref{Liste TODO globale}, pour plus d'information.
  765. @item S-M-@key{RET}
  766. Insère une nouvelle entrée TODO en dessous de l'actuelle.
  767. @end table
  768. @noindent
  769. Le changement d'un état TODO peut également déclencher des changements de
  770. balises. Voir la documentation de l'option @code{org-todo-state-tags-triggers}
  771. pour les details.
  772. @node Flux de travail multi-état, Journalisation des progrès, Utilisation des états TODO, Listes TODO
  773. @section Flux de travail multi-état
  774. Vous pouvez utiliser les mots clés TODO pour indiquer différents états
  775. @emph{sequentiels} dans le processus du travail sur un item, par exemple :
  776. @smalllisp
  777. (setq org-todo-keywords
  778. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  779. @end smalllisp
  780. La barre verticale sépare les mots-clés TODO (états qui @emph{ont besoin
  781. d'actions}) des états DONE (qui n'ont @emph{plus besoin d'action}). Si vous ne
  782. mettez pas. Si vous ne mettez pas la barre de séparation, le dernier état est
  783. considéré comme DONE. Avec cette configuration, la commande @kbd{C-c C-t}
  784. cyclera une entrée depuis TODO vers FEEDBACK, puis vers VERIFY, et finallement
  785. vers DONE et DELEGATED. Parfois vous pouvez utiliser différents ensembles de
  786. mots-clés TODO en parallèle. Par exemple, vous pouvez vouloir avoir le basique
  787. @code{TODO}/@code{DONE}, mais aussi un flux de travail, résoudre les bogues.
  788. Votre configuration devrait ressembler à cela:
  789. @smalllisp
  790. (setq org-todo-keywords
  791. '((sequence "TODO(t)" "|" "DONE(d)")
  792. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")))
  793. @end smalllisp
  794. Les mots-clés devraient tous être différents, cela aide le mode Org à garder
  795. une trace de quelle sous-séquence devrait être utilisée pour une entrée
  796. donnée. L'exemple montre aussi comment définir des touches pour un accès
  797. plus rapide à un état en particulier, en ajoutant une lettre entre
  798. parenthèses après chaque mot-clé---vous serez invité pour la touche après
  799. @kbd{C-c C-t}.
  800. Pour définir les mots-clés TODO qui sont valides uniquement dans un seul
  801. fichier, utilisez les lignes suivantes n'importe où dans le fichier.
  802. @smallexample
  803. #+TODO: TODO(t) | DONE(d)
  804. #+TODO: REPORT(r) BUG(b) KNOWNCAUSE(k) | FIXED(f)
  805. #+TODO: | CANCELED(c)
  806. @end smallexample
  807. Après le changement de l'une de ces lignes, utiliser @kbd{C-c C-c} avec le
  808. curseur encore dans la ligne pour faire connaître le changement au mode Org.
  809. @node Journalisation des progrès, Priorités, Flux de travail multi-état, Listes TODO
  810. @section Journalisation des progrès
  811. Le mode Org peut enregistrer automatiquement un horodatage et éventuellement
  812. une note lorsque vous marqué un item TODO comme DONE, ou même chaque fois
  813. que vous changez l'état d'un item TODO. Ce système est hautement configurable;
  814. les paramétrages peuvent être sur la base d'un mot-clé et peuvent être situé
  815. dans un fichier ou même une arborescence. Pour information sur comment
  816. l'horloge fonctionne pour une tâche, voir @ref{Clocking
  817. work time}.
  818. @menu
  819. * Fermeture des items:: Quand cet item a été marqué DONE?
  820. * Suivi des basculement d'états TODO:: Quand cet état a-t-il basculé?
  821. @end menu
  822. @node Fermeture des items, Suivi des changements d'états TODO, Journalisation des progrès, Journalisation des progrès
  823. @unnumberedsubsec Fermeture des items
  824. La journalisation la plus basique est de garder la trace de @emph{quand} un
  825. certain item TODO est fini. Ceci est achevé avec@footnote{La correspondance
  826. dans la configuration du tampon est : @code{#+STARTUP: logdone}}.
  827. @smalllisp
  828. (setq org-log-done 'time)
  829. @end smalllisp
  830. @noindent
  831. Ensuite chaque fois que vous modifiez une entrée depuis un état TODO (non
  832. fait) en n'importe quel état DONE, une ligne @samp{CLOSED: [timestamp]} sera
  833. inséré juste après la ligne d'en-tête. Si vous voulez enregistrer une note
  834. avec l'horodatage, utilisez@footnote{La correspondance dans la configuration du
  835. tampon est : @code{#+STARTUP:lognotedone}}
  836. @smalllisp
  837. (setq org-log-done 'note)
  838. @end smalllisp
  839. @noindent
  840. Vous serez invités pour une note, et cette note sera stockée en dessous de
  841. l'entrée avec un en-tête @samp{Closing Note}.
  842. @node Suivi des changements d'états TODO, , Fermeture des items, Journalisation des progrès
  843. @unnumberedsubsec Suivi des changements d'états TODO
  844. Vous pouvez souhaiter garder la trace des changements d'états TODO. Vous
  845. pouvez aussi juste enregistrer un horodatage, ou une note horodatée pour
  846. un changement. Ces enregistrements seront insérés après l'en-tête comme
  847. une liste à puces. Personnalisez la variable @code{org-log-into-drawer} pour
  848. obtenir ce comportement.
  849. Pour un état de journalisation, le mode Org s'attend à une configuration
  850. sur un per-mot-clés. Cela est achevé par ajout de marqueurs spéciaux @samp{!}
  851. (pour un horodatage) et
  852. @samp{@@} (pour une note) entre parenthèses après
  853. chaque mot clé. Par exemple:
  854. @smallexample
  855. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  856. @end smallexample
  857. @noindent
  858. définira les mots clés TODO et les raccourcis clavier, et aussi requiert
  859. que le temps soit enregistré quand l'entrée est configurée à DONE, et qu'une
  860. note soit enregistrée lors de la permutation vers WAIT ou CANCELED. La même
  861. syntaxe fonctionnent aussi lors du paramétrage de @code{org-todo-keywords}.
  862. @node Priorités, Diviser les tâches, Journalisation des progrès, Listes TODO
  863. @section Priorités
  864. Si vous utilisez le mode Org avancé, vous pouvez vous retrouver avec
  865. suffisamment d'items TODO que commencent à donner leur donner un sens de
  866. priorité. La priorisation ben être faite en plaçant un @emph{cookie de priorité}
  867. dans l'en-tête d'un item TODO, comme ça
  868. @smallexample
  869. *** TODO [#A] Write letter to Sam Fortune
  870. @end smallexample
  871. @noindent
  872. Le mode Org comprend trois priorités: @samp{A}, @samp{B}, and @samp{C}.
  873. @samp{A} est la plus élevée, @samp{B} est celle par défaut. Les priorités
  874. font la différence uniquement dans l'agenda.
  875. @table @kbd
  876. @item @kbd{C-c ,}
  877. Définit la priorité de l'en-tête courante. Pressez @samp{A}, @samp{B} ou
  878. @samp{C} pour sélectionner une priorité, ou @key{SPC} pour enlever le cookie.
  879. @c
  880. @item S-@key{up}/@key{dwn}
  881. Augmenter/réduire la priorité de l'en-tête en cours.
  882. @end table
  883. @node Diviser les tâches, Cases à cocher, Priorités, Listes TODO
  884. @section Découper les tâches en sous-tâches
  885. Il est souvent conseillé de décomposer une grosse tâche en tâches plus petites,
  886. plus gérable sous-tâches. Vous pouvez faire cela en créant une arborescence
  887. de grandes lignes en dessous d'un item TODO, avec des sous-tâches détaillées
  888. sur l'arbre. Pour garder un aperçu sur la fraction des sous-tâches qui ont
  889. déjà été effectuées, insérer soit @samp{[/]} ou
  890. @samp{[%]} n'importe où dans l'en-tête.
  891. Les cookies seront mis à jour chaque fois que le statut TODO d'un enfant
  892. change, ou en pressant @kbd{C-c C-c} sur le cookie. Par exemple :
  893. @smallexample
  894. * Organiser une fête [33%]
  895. ** TODO Appeler des gens [1/2]
  896. *** TODO Peter
  897. *** DONE Sarah
  898. ** TODO Acheter de la nourriture
  899. ** DONE Parler aux voisins
  900. @end smallexample
  901. @node Cases à cocher, , Diviser les tâches, Listes TODO
  902. @section Cases à cocher
  903. Chaque item d'une liste complète (@pxref{Listes complètes}) peut être constitué
  904. d'une boîte à cocher en commençant par la chaîne @samp{[ ]}. Les cases à cocher
  905. ne sont pas incluses dans la liste complète TODO,
  906. donc elles sont souvent bien pour diviser une tâche en un nombre d'étapes
  907. simples. Voici un exemple d'une liste de boîte à cocher:
  908. @smallexample
  909. * TODO Organiser une fête [1/3]
  910. - [-] appeler des gesn [1/2]
  911. - [ ] Peter
  912. - [X] Sarah
  913. - [X] commander de la nourriture
  914. @end smallexample
  915. Les cases à cocher Les boîtes à cocher fonctionnent de façon hiérarchique, donc
  916. si un item boîte à cocher a des enfants qui sont des boîtes à cocher, basculer
  917. l'un des enfants fera que la boîte parente reflètera si vide, quelque, ou tous
  918. les enfants qui sont cochés.
  919. @noindent
  920. Les commandes suivantes fonctionnent avec les boîtes à cocher :
  921. @table @kbd
  922. @item C-c C-c
  923. Bascule le statut de la boîte ou (avec un argument préfixé) présence au point.
  924. @item M-S-@key{RET}
  925. Insère un nouvel item avec une boîte à cocher. Cela fonctionne
  926. seulement si le curseur est déjà dans un item de liste
  927. (@pxref{Listes complètes}).
  928. @end table
  929. @seealso{
  930. @uref{http://orgmode.org/manual/TODO-Items.html#TODO-Items, Chapter 5 of the manual}@*
  931. @uref{http://orgmode.org/worg/org-tutorials/orgtutorial_dto.php, David
  932. O'Toole's introductory tutorial}@*
  933. @uref{http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html,
  934. Charles Cave's GTD setup}}
  935. @node Balises, Propriétés, Listes TODO, Top
  936. @chapter Balises
  937. Un excellent moyen pour implémenter des étiquettes et contextes pour les
  938. informations en corrélation croisées est d'assigner des @i{balises} aux
  939. en-tête. Le mode Org a un support étendu pour les balises.
  940. Chaque en-tête peut contenir une liste de balises; elles apparaissent à la fin de
  941. l'en-tête.
  942. Les balises sont des mots ordinaires contenant des lettres, des nombres,
  943. @samp{_}, et @samp{@@}. Les balises doivent être précédées et suivies par deux
  944. points, par exemple, @samp{:work:}. Plusieurs balises peuvent être spécifiées,
  945. comme @samp{:work:urgent:}.
  946. Les balises seront par défaut en gras de la même couleur que l'en-tête.
  947. @menu
  948. * Héritage de balise:: Mots clés qui utilisent la structure arborescente des grandes lignes
  949. * Configuration des balises:: Comment attribuer des balises à un titre
  950. * Balise de groupes:: Utilisez une balise pour en chercher plusieurs
  951. * Recherche de balise:: A la recherche de combinaisons de balises
  952. @end menu
  953. @node Héritage de balise, Configuration de balises, Balises, Balises
  954. @section Héritage de balise
  955. Les @i{Balises} font usage de la structure hiérarchique des grandes lignes de
  956. l'arborescence.
  957. Si un en-tête a une certaine balise, toutes les sous-en-tête en hériteront.
  958. Par exemple, dans la liste
  959. @smallexample
  960. * Rencontre avec le groupe français :work:
  961. ** Résumé par Frank :boss:notes:
  962. *** TODO Préparer des diapositives pour lui :action:
  963. @end smallexample
  964. @noindent
  965. l'en-tête final aura les balises @samp{:work:}, @samp{:boss:},
  966. @samp{:notes:}, et @samp{:action:} bien que l'en-tête n'est pas explicitement
  967. marqué par ces balises. Vous pouvez aussi définir des balises telles que toutes
  968. les entrées dans un fichier devraient en hériter comme si ces balises étaient
  969. définies à un hypothétique niveau zéro qui entourerait tout le fichier.
  970. Utiliser une ligne comme cela@footnote{Comme avec tous ces réglages dans le
  971. tampon, presser @kbd{C-c C-c} active n'importe quel changement dans la ligne.}:
  972. @smallexample
  973. #+FILETAGS: :Peter:Boss:Secret:
  974. @end smallexample
  975. @node Configuration de balises, Balise de groupes, Héritage de balise, Balises
  976. @section Configuration de balises
  977. Les balises peuvent être simplement tapées dans le tampon à la fin d'une
  978. en-tête. Après deux points, @kbd{M-@key{TAB}} permet la complétion sur les
  979. balises. Il y a aussi une commande spéciale pour insérer des balises:
  980. @table @kbd
  981. @item C-c C-q
  982. Entre de nouvelles balises pour l'en-tête courante. Le mode Org offrira
  983. une complétion ou une interface spéciale touche-simple pour configurer des
  984. balises, voir plus bas. Après avoir pressé @key{RET}, les balises seront
  985. insérées et alignés à @code{org-tags-column}. Lorsqu'appelé avec un argument
  986. préfixé @kbd{C-u} toutes les balises dans le tampon courant seront alignées
  987. avec cette colonne, juste pour rendre les choses plus belles.
  988. @item C-c C-c
  989. Lorsque le curseur est sur une en-tête, cela fait la même chose que
  990. @kbd{C-c C-q}.
  991. @end table
  992. Org supportera l'insertion de balise basée sur une @emph{liste de balises}. Par
  993. défaut cette liste est construite dynamiquement, contenant toutes les balises
  994. couramment utilisées dans le tampon. Vous pouvez aussi spécifier globalement
  995. une liste de balises en dur avec la variable @code{org-tag-alist}. Finalement
  996. vous pouvez paramétrer les balises par défaut pour un fichier donné avec des
  997. lignes comme
  998. @smallexample
  999. #+TAGS: @@work @@home @@tennisclub
  1000. #+TAGS: laptop car pc sailboat
  1001. @end smallexample
  1002. Par défaut le mode Org utilise les facilités de complétion standard du
  1003. mini-tampon pour entrer les balises. Toutefois, il implémente aussi d'autres,
  1004. plus brèves, méthode de sélection de balises appelées @emph{sélection rapide
  1005. de balises}. Cela vous permet de sélectionner et dé-sélectionner des balises
  1006. juste avec une seule touche appuyée. Pour que cela fonctionne bien vous devrez
  1007. affecter une unique lettre à la plupart de vos balises communément utilisées.
  1008. Vous pouvez faire cela globalement en configurant la variable
  1009. @code{org-tag-alist} dans votre fichier @file{.emacs}. Par exemple, vous
  1010. pouvez trouver l'intérêt de baliser beaucoup d'item dans différents fichiers
  1011. avec @samp{:@@home:}. Dans ce cas vous pouvez configurer quelque chose comme :
  1012. @smalllisp
  1013. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  1014. @end smalllisp
  1015. @noindent
  1016. Si la balise est seulement pertinante pour le fichier sur lequel vous
  1017. travaillez, alors vous pouvez la ligne d'option TAGS à la place comme :
  1018. @smallexample
  1019. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  1020. @end smallexample
  1021. @node Balise de groupes, Tag searches, Configuration de balises, Balises
  1022. @section Balise de groupes
  1023. @cindex balises de groupe
  1024. @cindex balises, groupes
  1025. Dans un ensemble de balises mutellement exclusives, la première balise peut
  1026. être définie comme une @emph{balise de groupe}. Lorsque vous cherchez une
  1027. balise de groupe, cela vous renverra les correspondances pour tous les membres
  1028. du groupe. Dans une vue d'agenda, par balise de groupe affichera les en-tête
  1029. balisées avec au moins l'un des membre du groupe. Cela rend les recherches de
  1030. balise et filtres plus flexible.
  1031. Vous pouvez configurer des balises de groupe en insérant deux points entre la
  1032. balise de groupe et une autre, comme cela:
  1033. @example
  1034. #+TAGS: @{ @@read : @@read_book @@read_ebook @}
  1035. @end example
  1036. Dans cet exemple, @samp{@@read} est une @emph{balise de groupe} pour un
  1037. ensemble de trois balises: @samp{@@read}, @samp{@@read_book} et
  1038. @samp{@@read_ebook}.
  1039. Vous pouvez aussi utiliser le mot-clé @code{:grouptags} directement lors de la
  1040. configuration
  1041. @var{org-tag-alist}, voir la documentation de cette variable.
  1042. @kindex C-c C-x q
  1043. @vindex org-group-tags
  1044. Si vous souhaitez ignorer temporairement les balises de groupe, basculer une
  1045. balise de groupe supportée avec @command{org-toggle-tags-groups}, liée à
  1046. @kbd{C-c C-x q}. Si vous souhaitez
  1047. désactiver les balises de groupes complètement, configurer @var{org-group-tags}
  1048. à nil.
  1049. @node Balise de recherches, , Balise de groupes, Balises
  1050. @section Balise de recherches
  1051. Une fois qu'un système de balises a été configuré, il peut être utilisé pour
  1052. collecter les informations relatives dans des listes spéciales.
  1053. @table @kbd
  1054. @item C-c \
  1055. @itemx C-c / m
  1056. Crée un arbre epuré avec toutes les en-tête correspondantes à une
  1057. recherche de balise. Avec un argument préfixé @kbd{C-u}, ignore les
  1058. en-tête qui ne sont pas des lignes TODO.
  1059. @item C-c a m
  1060. Crée une liste de balises correspondantes à tous les fichiers de l'agenda.
  1061. @xref{Correspondance balises et propriétés}.
  1062. @item C-c a M
  1063. Crée une liste complète de correspondances de balise à tous les
  1064. fichiers d'agenda, mais ne regarde que les items TODO et force le
  1065. regard des sous-items (voir la variable @code{org-tags-match-list-sublevels}).
  1066. @end table
  1067. Ces commandes invitent toutes à une correspondance de chaînes qui permet la
  1068. logique booléenne de base comme @samp{+boss+urgent-project1}, pour trouver des
  1069. entrées avec des balises @samp{boss} et @samp{urgent}, mais pas @samp{project1,
  1070. ou @samp{Kathy|Sally} pour trouver entrées qui sont balisées, comme
  1071. @samp{Kathy} ou @samp{Sally}. La syntaxe complète des recherches de chaînes
  1072. est riche et permet aussi la correspondance avec les mots-clés TODO, niveaux
  1073. d'entrée et propriétés. Pour une description complète avec beaucoup d'exemples,
  1074. voir @ref{Correspondance balises et propriétés}.
  1075. @seealso{
  1076. @uref{http://orgmode.org/manual/Tags.html#Tags, Chapter 6 of the manual}@*
  1077. @uref{http://sachachua.com/wp/2008/01/tagging-in-org-plus-bonus-code-for-timeclocks-and-tags/,
  1078. Sacha Chua's article about tagging in Org-mode}}
  1079. @node Propriétés, Dates et heures, Balises, Top
  1080. @chapter Propriétés
  1081. Les propriétés sont des paires de valeurs clés associées à une entrée. Elles
  1082. vivent dans un tiroir spécial avec le nom @code{PROPERTIES}. Chaque propriété
  1083. est spécifiée sur une seule ligne, avec la clé (entourrée de deux points)
  1084. d'abord, et la valeur ensuite:
  1085. @smallexample
  1086. * collection de CD
  1087. ** Classique
  1088. *** Variations de Goldberg
  1089. :PROPERTIES:
  1090. :Title: Variations de Goldberg
  1091. :Composer: J.S. Bach
  1092. :Publisher: Deutsche Grammophon
  1093. :NDisks: 1
  1094. :END:
  1095. @end smallexample
  1096. Vous pouvez définir les valeurs permises pour une propriété en particulier
  1097. @samp{:Xyz:} configurant une propriété @samp{:Xyz_ALL:}. Cette propriété
  1098. spéciale est @emph{l'héritage}, donc si vous la configurez au niveau 1 entrée,
  1099. ça s'appliquera à l'arbre entier. Lorsque les valeurs autorisées sont définies,
  1100. la configuration de la propriété correspondante devient plus facile et moins
  1101. sujette à erreurs. Par exemple avec la collection de CD, nous pouvons
  1102. prédéfinir les éditeurs et le nombre de disques dans une boîte comme :
  1103. @smallexample
  1104. * collection de CD
  1105. :PROPERTIES:
  1106. :NDisks_ALL: 1 2 3 4
  1107. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  1108. :END:
  1109. @end smallexample
  1110. ou globalement en utilsant @code{org-global-properties}, ou déposer à l'échelle
  1111. comme ça :
  1112. @smallexample
  1113. #+PROPERTY: NDisks_ALL 1 2 3 4
  1114. @end smallexample
  1115. @table @kbd
  1116. @item C-c C-x p
  1117. Configure une propriété. Cela invite à saisir une propriété, nom et valeur.
  1118. @item C-c C-c d
  1119. Supprime une propriété de l'entrée en cours.
  1120. @end table
  1121. Pour créer un arbre rare et des listes spéciale avec sélection basée sur les
  1122. propriétés, les mêmes commandes sont utilisées que pour les recherches de
  1123. balises (@pxref{Tag searches}). La syntaxe pour la recherche de chaîne est
  1124. décrite @ref{Correspondance balises et propriétés}.
  1125. @table @kbd
  1126. @end table
  1127. @seealso{
  1128. @uref{http://orgmode.org/manual/Properties-and-Columns.html#Properties-and-Columns,
  1129. Chapter 7 of the manual}@*
  1130. @uref{http://orgmode.org/worg/org-tutorials/org-column-view-tutorial.php,Bastien
  1131. Guerry's column view tutorial}}
  1132. @node Dates et heures, Capturer - Sauver - Archiver, Propriétés, Top
  1133. @chapter Dates et heures
  1134. Pour aider à la plannification du projet, les items TODO peuvent être étiquetés
  1135. avec une date et/ou une heure. La chaîne spécialement formatée tenant compte de
  1136. la date et de l'heure est appelée @emph{horodatage} dans le mode Org.
  1137. @menu
  1138. * Horodatages:: Donner une durée à une entrée de l'arborescence
  1139. * Création d'horodatages:: Les commandes qui insèrent des horodateurs
  1140. * Dates limites et calendrier:: Planification de votre travail
  1141. * Chronométrage du temps de travail:: Suivi du temps passé sur une tâche
  1142. @end menu
  1143. @node Horodatages, Création d'horodatages, Dates et heures, Dates et heures
  1144. @section Horodatages
  1145. Un horodatage est une spécification d'une date (éventuellement avec un temps ou
  1146. une plage de temps) dans un format spécial, soit @samp{<2003-09-16 Tue>} ou
  1147. @samp{<2003-09-16 Tue 09:39>} ou @samp{<2003-09-16 Tue 12:00-12:30>}. Un horodatage peut apparaître n'importe où dans une ligne
  1148. d'en-tête ou dans le corps d'une entrée d'arbre Org. Sa présence provoque
  1149. l'affichage des entrées à des dates spécifiques dans l'agenda
  1150. (@pxref{L'agenda hebdomadaire/quotidien}). Nous distinguons:
  1151. @noindent
  1152. @b{L'horodatage complet; les événements; les rendez-vous}@*
  1153. Un simple horodatage affecte juste une date/temps à un item. C'est juste comme
  1154. écrire un rendez-vous ou un événement sur un agenda papier.
  1155. @smallexample
  1156. * Rencontrer Peter au cinéma
  1157. <2006-11-01 Wed 19:15>
  1158. * Discussion sur le changement climatique
  1159. <2006-11-02 Thu 20:00-22:00>
  1160. @end smallexample
  1161. @noindent
  1162. @b{Horodatage avec intervalles répétés}@*
  1163. Un horodatage peut contenir un @emph{intervalle répété}, indiquant qu'il ne
  1164. s'applique pas seulement sur les dates données,; mais encore et encore après
  1165. un certains intervalle de N jours (d), semaines (w), mois (m), ou années (y).
  1166. Les exemples suivants montreront l'agenda chaque mercredi :
  1167. @smallexample
  1168. * Aller chercher Sam à l'école
  1169. <2007-05-16 Wed 12:30 +1w>
  1170. @end smallexample
  1171. @noindent
  1172. @b{Entrées d'expressions symboliques quotidienne}@*
  1173. Pour des spécifications plus complexes de dates, le mode Org supporte l'usage
  1174. d'expression symbolique spéciales implémentées dans le paque Emacs
  1175. calendar/diary. Par exemple
  1176. @smallexample
  1177. * Le rendez-vous geek chaque deuxième jeudi du mois
  1178. <%%(diary-float t 4 2)>
  1179. @end smallexample
  1180. @noindent
  1181. @b{Plage de temps}@*
  1182. Deux horodatages connectés par @samp{--} dénote une plage.
  1183. @smallexample
  1184. ** Rendez-vous à Amsterdam
  1185. <2004-08-23 Mon>--<2004-08-26 Thu>
  1186. @end smallexample
  1187. @noindent
  1188. @b{Horodatage inactif}@*
  1189. Comme l'horodatage complet, mais avec des crochets au lieu des chevrons. Ces
  1190. horodatages sont inactifs dans le sens où ils ne déclenchent @emph{pas} une
  1191. entrée pour la montrer dans l'agenda.
  1192. @smallexample
  1193. * Gillian est arrivée en retard pour la 5ème fois
  1194. [2006-11-01 Wed]
  1195. @end smallexample
  1196. @node Création d'horodatages, Dates limites et calendrier, Horodatages, Dates et heures
  1197. @section Création d'horodatages
  1198. Pour que le mode Org puisse reconnaître les horodatages, ils doivent être dans
  1199. un format spécifique. Toutes les commandes listées en dessous produisent des
  1200. horodatages dans le format correct.
  1201. @table @kbd
  1202. @item C-c .
  1203. Invite à saisir une date et insérer l'horodatage correspondant. Lorsque le
  1204. curseur est sur un horodatage existant dans le tampon, la commande est
  1205. utilisée pour modifier cet horodatage au lieu d'en insérer un nouveau.
  1206. Lorsque la commande est utilisée deux fois successivement, une plage de
  1207. temps est insérée. Avec un préfixe, rajoute l'heure actuelle.
  1208. @c
  1209. @item C-c !
  1210. Comme @kbd{C-c .}, mais insère un horodatage inactif qui ne provoquera pas une
  1211. entrée dans l'agenda.
  1212. @c
  1213. @item S-@key{left}@r{/}@key{right}
  1214. Change la date au niveau du curseur d'un jour.
  1215. @c
  1216. @item S-@key{up}@r{/}@key{down}
  1217. Change l'item sous le curseur dans un horodatage. Le curseur peut être sur une
  1218. année, un mois, un jour, une heure ou une minute. Lorsque l'horodatage
  1219. contient une plage de temps comme @samp{15:30-16:30}, la modification de la
  1220. première heure affectera la seconde, le décalage sera constant. Pour changer
  1221. cette constante, modifier la seconde heure.
  1222. @end table
  1223. Lorsque le mode Org invite à saisir une date/temps, cela acceptera n'importe
  1224. qu'elle chaîne contenant une date et/ou une information temporelle, et
  1225. interprètera intelligemment la chaîne, déduisant par défaut les informations
  1226. non précisées depuis la date et l'heure. Vous pouvez aussi sélectionner une
  1227. date dans le calendrier qui s'affiche. Voir le manuel pour plus d'informations.
  1228. @node Dates limites et calendrier, Chronométrage du temps de travail, Création d'horodatages, Dates et heures
  1229. @section Dates limites et calendrier
  1230. Un horodatage peut être précédé par des mots-clés spéciaux pour faciliter la
  1231. plannification.
  1232. @noindent
  1233. @b{DEADLINE (date limite)}@*
  1234. Sens: la tâche (souvent comme un item TODO, bien que pas nécessairement) est
  1235. supposée être finie à cette date.
  1236. @table @kbd
  1237. @item C-c C-d
  1238. Insère le mot-clé @samp{DEADLINE} suivi d'un horodatage, dans la ligne
  1239. d'en-tête suivante.
  1240. @end table
  1241. Sur la date limite, la tâche sera listée dans l'agenda. De plus, l'agenda pour
  1242. @emph{aujourd'hui} mentionnera une alerte à propos de l'approche ou du loupé de
  1243. la date limite, commençant @code{org-deadline-warning-days} avant la date
  1244. d'échéance, et continuant jusqu'à ce que l'entrée soit marquée DONE. Un
  1245. exemple :
  1246. @smallexample
  1247. *** TODO écrire un article à propos de la Terre
  1248. L'éditeur en charge est [[bbdb:Ford Prefect]]
  1249. DEADLINE: <2004-02-29 Sun>
  1250. @end smallexample
  1251. @noindent
  1252. @b{SCHEDULED (plannifié)}@*
  1253. Sens: vous @i{plannifiez de démarrer le travail} sur une tâche à la date donnée
  1254. @footnote{C'est assez différent de ce qui normalement compris par
  1255. @i{plannification d'un rendez-vous}, qui est fait dans le mode Org juste par
  1256. insertion d'une étiquette de temps sans mot-clé.}
  1257. @table @kbd
  1258. @item C-c C-s
  1259. Insère le mot-clé @samp{SCHEDULED} avec une étiquette, sur la ligne suivant
  1260. l'en-tête.
  1261. @end table
  1262. L'en-tête sera listée sous la date donnée@footnote{Cela sera encore listé sur
  1263. cette date après qu'elle soit marquée DONE. Si vous n'aimez pas ça, configurez
  1264. la variable @code{org-agenda-skip-scheduled-if-done}.}. De plus, un rappel
  1265. signalant que la date prévue est passée sera présent dans la compilation pour
  1266. @emph{aujourd'hui}, jusqu'à ce que l'entrée soit marquée DONE. I.e.@: la tâche
  1267. sera automatiquement transmise jusqu'à ce qu'elle soit achevée.
  1268. @smallexample
  1269. *** TODO Appeler Trillian pour un rencard au nouvel an
  1270. SCHEDULED: <2004-12-25 Sat>
  1271. @end smallexample
  1272. Quelques tâches ont besoin d'être répétées encore et encore. Le mode Org aide à
  1273. organiser de telles usages de tâches un tel appel répété dans un DEADLINE,
  1274. SCHEDULED, ou un horodatage complet. Dans l'exemple suivant
  1275. @smallexample
  1276. ** TODO Payer le loyer
  1277. DEADLINE: <2005-10-01 Sat +1m>
  1278. @end smallexample
  1279. @noindent
  1280. le @code{+1m} est un répétiteur; l'interprétation attendue est que la tâche ait
  1281. une date limite sur <2005-10-01> et se répète chaque mois à partir de cette
  1282. date.
  1283. @node Chronométrage du temps de travail, , Dates limites et calendrier, Dates et heures
  1284. @section Chronométrage du temps de travail
  1285. Le mode Org vous permet de chronométrer le temps que vous passez sur des tâches
  1286. spécifiques dans un projet.
  1287. @table @kbd
  1288. @item C-c C-x C-i
  1289. Démarre le chrono à l'item actuel (clock-in). Cela insère le mot-clé
  1290. CLOCK ensemble avec un horodatage. Lorsque appelé avec un argument
  1291. préfixé @kbd{C-u}, sélectionne la tâche depuis une liste de tâches
  1292. récemment chronométrées.
  1293. @c
  1294. @item C-c C-x C-o
  1295. Arrête le chrono (clock-out). Cela insère un autre horodatage au même
  1296. endroit que le chrono avait fait son dernier démarrage. Cela calcule
  1297. aussi directement le temps résultant en l'insérant après la plage de
  1298. temps comme @samp{=>
  1299. HH:MM}.
  1300. @item C-c C-x C-e
  1301. Met à jour l'effort estimé pour la tâche en cours de chronométrage.
  1302. @item C-c C-x C-q
  1303. Annule le chrono en cours. C'est utile si un chrono a été déclenché
  1304. par erreur, ou si vous cessez votre travail sur quelque chose d'autre.
  1305. @item C-c C-x C-j
  1306. Saute jusqu'à l'entrée qui contient le chrono en cours. Avec un argument
  1307. préfixé @kbd{C-u}, sélectionne la tâche cible dans une liste de tâches
  1308. récemment chronométrées.
  1309. @item C-c C-x C-r
  1310. Insère un bloc dynamique contenant un rapport de chrono comme une table
  1311. en mode Org dans le fichier courant. Lorsque le curseur est sur une table
  1312. de chrono existante, il l'a met à jour.
  1313. @smallexample
  1314. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  1315. #+END: clocktable
  1316. @end smallexample
  1317. @noindent
  1318. Pour les détails sur la personnalisation, voir @uref{http://orgmode.org/manual/Clocking-work-time.html#Clocking-work-time,the manual}.
  1319. @item C-c C-c
  1320. Mise à jour du bloc dynamique au point. Le curseur a besoin
  1321. d'être dans la ligne @code{#+BEGIN} du bloc dynamique.
  1322. @end table
  1323. La touche @kbd{l} être utilisée dans la ligne du temps (@pxref{Chronologie}) et
  1324. dans l'agenda (@pxref{L'agenda hebdomadaire/quotidien}) pour montrer quelles tâches ont été
  1325. travaillée et fermée durant la journée.
  1326. @seealso{
  1327. @uref{http://orgmode.org/manual/Dates-and-Times.html#Dates-and-Times,
  1328. Chapter 8 of the manual}@*
  1329. @uref{http://members.optusnet.com.au/~charles57/GTD/org_dates/, Charles
  1330. Cave's Date and Time tutorial}@*
  1331. @uref{http://doc.norang.ca/org-mode.html#Clocking, Bernt Hansen's clocking workflow}}
  1332. @node Capturer - Sauver - Archiver, Vues de l'agenda, Dates et heures, Top
  1333. @chapter Capturer - Sauver - Archiver
  1334. Une part importante de n'importe quel système d'organisation est la
  1335. capacité de capturer rapidement les nouvelles idées et tâches, et de
  1336. leur associer des documents de référence. Org définit un processus de
  1337. capture pour créer des tâches. Il stocke les fichiers reliés à une
  1338. tâche (@emph{attachements}) dans un répertoire spécial. Une fois dans le
  1339. système, les tâches et projets ont besoin d'être déplacés autour. Le
  1340. déplacement d'arborescences de projet complété vers un fichier d'archive
  1341. garde le système compact et rapide.
  1342. @menu
  1343. * Capture:: Capture de nouvelles choses
  1344. * Sauver et copier:: Déplacement d'un arbre d'un endroit à un autre
  1345. * Archivage:: Que faire avec des projets finis
  1346. @end menu
  1347. @node Capture, Sauver et copier, Capturer - Sauver - Archiver, Capturer - Sauver - Archiver
  1348. @section Capture
  1349. Org vous permet de stocker des notes rapides avec peu d'interruption de votre
  1350. flux de travail. Vous pouvez définir des modèles pour les nouvelles entrées et
  1351. les associer à différentes cibles pour le stockage de notes.
  1352. @menu
  1353. * Configuration d'un emplacement de capture:: Où les notes seront stockées
  1354. * Utilisation de capture:: Commandes qui invoquent et terminent la capture
  1355. * Modèles de capture:: Définir le contour des types de notes différentes
  1356. @end menu
  1357. @node Configuration d'un emplacement de capture, Utilisation de capture, Capture, Capture
  1358. @unnumberedsubsec Configuration d'un emplacement de capture
  1359. La personnalisation suivante configure un fichier cible par
  1360. défaut, @footnote{Utilisant des modèles de capture, voir
  1361. @ref{Modèles de capture}.}, et définit un raccourci clavier global pour la
  1362. capture d'autres choses.
  1363. @example
  1364. (setq org-default-notes-file (concat org-directory "/notes.org"))
  1365. (define-key global-map "\C-cc" 'org-capture)
  1366. @end example
  1367. @node Utilisation de capture, Modèles de capture, Configuration d'un emplacement de capture, Capture
  1368. @unnumberedsubsec Utilisation de capture
  1369. @table @kbd
  1370. @item C-c c
  1371. Démarre une procédure de capture. Vous serez placé dans une tampon indirect
  1372. réduit pour éditer l'item.
  1373. @item C-c C-c
  1374. Une fois que vous avez fini d'entrer les informations dans le
  1375. tampon de capture, @kbd{C-c C-c} vous renverra vers la fenêtre
  1376. de configuration avant le processus de capture, donc vous
  1377. pouvez résumer votre travail sans distraction.
  1378. @item C-c C-w
  1379. Finaliser en déplaçant l'entrée vers un emplacement de fichier (voir section
  1380. 9.2).
  1381. @item C-c C-k
  1382. Annule le processus de capture et renvoit à l'état précédent.
  1383. @end table
  1384. @node Modèles de capture, , Utilisation de capture, Capture
  1385. @unnumberedsubsec Modèles de capture
  1386. Vous pouvez utiliser des modèles pour générer différents types de capture
  1387. de notes, et les stocker dans différents endroits. Par exemple, si vous
  1388. aimeriez stocker des nouvelles tâches sous un en-tête @samp{Tâches} dans le
  1389. fichier @file{TODO.org}, et le journal des entrées dans une arborescence de date
  1390. dans @file{journal.org} vous pouvez utiliser :
  1391. @smallexample
  1392. (setq org-capture-templates
  1393. '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
  1394. "* TODO %?\n %i\n %a")
  1395. ("j" "Journal" entry (file+datetree "~/org/journal.org")
  1396. "* %?\nEntered on %U\n %i\n %a")))
  1397. @end smallexample
  1398. @noindent
  1399. Dans ces entrées, la première chaîne est la clé pour accéder au modèle, la
  1400. seconde est une courte description. Vient ensuite le type de l'entrée et une
  1401. définition de l'emplacement de la cible pour stocker la note. Finalement, le
  1402. modèle lui-même, une chaîne avec des échappements % où remplir les informations
  1403. basées sur le temps et le contexte.
  1404. Lorsque vous appelez @kbd{M-x org-capture}, Org vous invitera à saisir une
  1405. touche pour choisir le modèle (si vous en avez plus d'un) et ensuite
  1406. préparera le tampon comme
  1407. @smallexample
  1408. * TODO
  1409. [[file:@var{lien vers où vous étiez lors de l'initialisation de la capture}]]
  1410. @end smallexample
  1411. @noindent
  1412. Durant l'expansion du modèle, les échappements @kbd{%} spéciaux@footnote{Si vous
  1413. avez besoin d'une de ces séquences littéralement, échappez le @kbd{%} avec une
  1414. contre-oblique.} permet l'insertion dynamique de contenu. Voici une petite
  1415. sélection des possibilités, consulter le manuel pour plus de détails.
  1416. @smallexample
  1417. %a @r{annotation, normalement le lien créé avec @code{org-store-link}}
  1418. %i @r{contenu initial, la région lorsque la capture est appelée avec C-u.}
  1419. %t, %T @r{horodatage, date seulement}
  1420. %u, %U @r{horodatage avec date et heure}
  1421. @end smallexample
  1422. @node Sauver et copier, Archivage, Capture, Capturer - Sauver - Archiver
  1423. @section Sauver et copier
  1424. Lors du revisionnage de données capturées, vous pouvez souhaiter les déposer
  1425. à nouveau ou les copier certaines des entrées dans une liste différente, par
  1426. exemple dans un projet. Couper, trouver le bon emplacement, et ensuite coller
  1427. la note est fastidieux. Afin de simplifier ce processus, vous pouvez utiliser
  1428. les commandes spéciales suivantes :
  1429. @table @kbd
  1430. @item C-c M-x
  1431. Copier l'entrée ou la région au point. Cette commande se comporte comme
  1432. @code{org-refile}, sauf que la note originale ne sera pas effacée.
  1433. @item C-c C-w
  1434. Dépose à nouveau l'entrée ou la région au point. Cette
  1435. commande offre des emplacements possibles pour le dépôt et
  1436. vous laisse en choisir un avec la complétion. L'item (ou tous
  1437. les items dans la région) est déposée sous l'en-tête cible
  1438. en tant que sous-item.@*
  1439. Par défaut, tous les en-tête de niveau 1 dans le tampon actuel
  1440. sont considérés comme des cibles, mais vous pouvez avoir des
  1441. définitions plus complexes à travers un nombre de fichiers.
  1442. Voir la variable @code{org-refile-targets} pour les details.
  1443. @item C-u C-c C-w
  1444. Utilise l'interface de dépôt pour sauter vers l'en-tête.
  1445. @item C-u C-u C-c C-w
  1446. Sauter vers l'emplacement où @code{org-refile} dernier mouvement d'une
  1447. arborescence.
  1448. @end table
  1449. @node Archivage, , Sauver et copier, Capturer - Sauver - Archiver
  1450. @section Archivage
  1451. Lorsqu'un projet est représenté par un (sous)arbre est fini, vous pouvez
  1452. vouloir déplacer l'arbre en dehors de la voie et arrêter sa contribution à
  1453. l'agenda. L'archivage est important pour garder vos fichiers travail compact
  1454. et les recherches globales comme la construction des vues d'un agenda rapides.
  1455. L'action d'archivage la plus commune est de déplacer une arborescence de
  1456. projet vers un autre fichier, le fichier d'archive.
  1457. @table @kbd
  1458. @item C-c C-x C-a
  1459. Archive l'entrée actuelle en utilisant la commande spécifiée
  1460. dans la variable @code{org-archive-default-command}.
  1461. @item C-c C-x C-s@ @r{ou version courte} @ C-c $
  1462. Archive le sous-arbre démarrant à la position du curseur
  1463. jusqu'à l'emplacement donné par @code{org-archive-location}.
  1464. @end table
  1465. L'emplacement de l'archive par défaut est un fichier dans le même répertoire
  1466. que le fichier courant, avec le même nom dérivé suivi de @file{_archive} Pour
  1467. des informations et des exemples sur comment changer cela, voir la documentation
  1468. de la variable @code{org-archive-location}. Il y a aussi une option de tampon
  1469. pour configurer cette variable, par exemple
  1470. @smallexample
  1471. #+ARCHIVE: %s_done::
  1472. @end smallexample
  1473. @seealso{
  1474. @uref{http://orgmode.org/manual/Capture-_002d-Refile-_002d-Archive.html#Capture-_002d-Refile-_002d-Archive,
  1475. Chapter 9 of the manual}@*
  1476. @uref{http://orgmode.org/worg/org-tutorials/org-protocol-custom-handler.php,
  1477. Sebastian Rose's tutorial for capturing from a web browser}}@uref{}@*
  1478. @node Vues de l'agenda, Markup, Capturer - Sauver - Archiver, Top
  1479. @chapter Vues de l'agenda
  1480. En raison de la façon dont fonctionne Org, éléments TODO, items horodatés, et
  1481. en-tête balisées peuvent dispersés dans un fichier ou même un certain nombre
  1482. de fichiers. Pour obtenir un aperçu des items ouverts en action, ou
  1483. d'événements qui sont importants pour une date donnée, ces informations
  1484. doivent être collectées, triées et affichées d'une manière organisée. Il y a
  1485. plusieurs points de vue différents, voir ci-dessous.
  1486. Les informations extraites sont affichées dans un tampon spécial agenda. Ce
  1487. tampon est en lecture seule, mais fournit des commandes pour visiter les
  1488. emplacements correspondants dans les fichiers Org originaux, et même d'éditer
  1489. ces fichiers à distance. Montage à distance du tampon agenda signifie, par
  1490. exemple, que vous pouvez modifier les dates de délais et de rendez-vous depuis
  1491. le tampon agenda. Les commandes disponibles dans le tampon agenda sont listées
  1492. dans @ref{Commandes de l'agenda}.
  1493. @menu
  1494. * Fichiers de l'agenda:: Fichiers recherchés pour les informations de l'agenda
  1495. * Répartiteur de l'agenda:: Accès clavier de l'agenda
  1496. * Les vues intégrées dans l'agenda:: Ce qui est disponible hors de la boîte ?
  1497. * Commandes de l'agenda:: Montage à distance des arbres Org
  1498. * Personnaliser les vues de l'agenda:: Définition de recherches spéciales et vues
  1499. @end menu
  1500. @node Fichiers de l'agenda, Répartiteur de l'agenda, Vues de l'agenda, Vues de l'agenda
  1501. @section Fichiers de l'agenda
  1502. L'information qui doit être montrée est normalement collectée depuis tous les
  1503. @emph{fichiers agenda}, les fichiers listés dans la variable
  1504. @code{org-agenda-files}.
  1505. @table @kbd
  1506. @item C-c [
  1507. Ajouter le fichier courant à la liste des fichiers agenda.
  1508. Le fichier est ajouté en début de liste. Si il était déjà dans
  1509. la liste, il est déplacée en tête. Avec un argument préfixé,
  1510. le fichier est ajouté/déplacé à la fin.
  1511. @item C-c ]
  1512. Efface le fichier courant depuis la liste des fichiers agenda.
  1513. @item C-,
  1514. Cycle à travers la liste de fichier de l'agenda, visite un fichier après
  1515. l'autre.
  1516. @end table
  1517. @node Répartiteur de l'agenda, Vues intégrées de l'agenda, Fichiers de l'agenda, Vues de l'agenda
  1518. @section Le répartiteur de l'agenda
  1519. Les vues sont créées à travers le répartiteur, qui devrait être lié à la
  1520. touche globale---par exemple @kbd{C-c a} (@pxref{Installation}). Après la
  1521. frappe de @kbd{C-c a}, une lettre supplémentaire est requise
  1522. pour exécuter une commande :
  1523. @table @kbd
  1524. @item a
  1525. Le calendrier de l'agenda (@pxref{L'agenda hebdomadaire/quotidien}).
  1526. @item t @r{/} T
  1527. Une liste de tous les items TODO (@pxref{Liste TODO globale}).
  1528. @item m @r{/} M
  1529. Une liste d'en-tête correspondantes à une expression balisée (@pxref{Matching
  1530. tags and properties}).
  1531. @item L
  1532. La chronologie pour le tampon courant (@pxref{Chronologie}).
  1533. @item s
  1534. Une liste des entrées sélectionnées par une expression booléenne
  1535. de mots-clés et/ou des expressions régulières qui doivent ou ne
  1536. doivent pas apparaître dans l'entrée.
  1537. @end table
  1538. @node Vues intégrées de l'agenda, Commandes de l'agenda, Répartiteur de l'agenda, Vues de l'agenda
  1539. @section Les vues intégrées de l'agenda
  1540. @menu
  1541. * L'agenda quotidien/hebdomadaire:: La page du calendrier avec les tâches actuelles
  1542. * Liste TODO globale:: Tous les éléments d'action inachevées
  1543. * Correspondance balises et propriétés:: Informations structurées avec recherche affinée
  1544. * Chronologie:: Vue chronologique pour un fichier unique
  1545. * Vue de recherche:: Trouver des entrées par recherche de texte
  1546. @end menu
  1547. @node L'agenda hebdomadaire/quotidien, Liste TODO globale, Vues intégrées de l'agenda, Vues intégrées de l'agenda
  1548. @subsection L'agenda hebdomadaire/quotidien
  1549. Le but de l'@emph{agenda} hebdomadaire/quotidien est d'agir comme une page
  1550. d'un agenda de papier, montrant toutes les tâches pour la semaine ou le
  1551. jour en cours.
  1552. @table @kbd
  1553. @item C-c a a
  1554. Compile un agenda pour la semaine en cours depuis une liste de fichiers Org.
  1555. L'agenda montre les entrées pour chaque jour.
  1556. @end table
  1557. Emacs contient le calendrier et le journal de Edward M. Reingold. Le mode
  1558. Org comprend la syntaxe du journal et vous permet d'utiliser les entrées
  1559. sexp du journal directement dans les fichiers Org:
  1560. @smallexample
  1561. * Anniversaire et trucs du genre
  1562. #+CATEGORY: Vacances
  1563. %%(org-calendar-holiday) ; fonction spéciale pour les noms de vacances
  1564. #+CATEGORY: Ann
  1565. %%(diary-anniversary 5 14 1956)@footnote{Notez que le ordre des arguments (mois, jour, années) dépend de la configuration de @code{calendar-date-style}.} Arthur Dent a %d ans
  1566. %%(diary-anniversary 10 2 1869) Mahatma Gandhi aurait %d ans
  1567. @end smallexample
  1568. Org peut intéragir avec les notifications de rendez-vous Emacs. Pour ajouter
  1569. tous les rendez-vous de vos fichiers agenda, utiliser la commande
  1570. @code{org-agenda-to-appt}. Voir la documentation pour les détails.
  1571. @node Liste TODO globale, Correspondance balises et propriétés, L'agenda hebdomadaire/quotidien, Vues intégrées de l'agenda
  1572. @subsection La liste TODO globale
  1573. La liste TODO globale contient tous les items TODO non terminés formatés et
  1574. collectés en un seul endroit. L'édition d'items TODO à distance vous permet
  1575. de modifier une entrée TODO avec une seule frappe de touche. Les commandes
  1576. disponibles dans la liste TODO sont décrites dans @ref{Commandes de l'agenda}.
  1577. @table @kbd
  1578. @item C-c a t
  1579. Montre la liste TODO globale. Cela collecte les items TODO
  1580. depuis tous les fichiers d'agenda (@pxref{Vues de l'agenda}) dans un seul
  1581. tampon.
  1582. @item C-c a T
  1583. Comme ci-dessus, mais permet une sélection de mots-clés spécifiques TODO.
  1584. @end table
  1585. @node Correspondance balises et propriétés, Chronologie, Liste TODO globale, Vues intégrées de l'agenda
  1586. @subsection Correspondance balises et propriétés
  1587. Si les en-tête dans les fichiers de l'agenda sont marqués avec des
  1588. @emph{balises} (@pxref{Balises}), ou ont des propriétés (@pxref{Propriétés}),
  1589. vous pouvez sélectionner les en-tête basée sur cette méta-donnée et les
  1590. collecter dans un tampon agenda. La syntaxe de correspondance décrite ici
  1591. s'applique aussi lors de la création d'arbres clairsemés avec @kbd{C-c /
  1592. m}. Les commandes disponible dans la liste de balises sont décrites dans
  1593. @ref{Commandes de l'agenda}.
  1594. @table @kbd
  1595. @item C-c a m
  1596. Produit une liste de tous les en-tête qui correspondent à un
  1597. ensemble de balises. La commande invite à saisir une
  1598. sélection de critères, qui sont des expressions de logique
  1599. booléenne avec des balises, comme @samp{+work+urgent-withboss} ou
  1600. @samp{work|home} (@pxref{Balises}). Si vous avez souvent besoin d'une
  1601. recherche spécifique, définit une commande personnalisée pour ça
  1602. (@pxref{Répartiteur de l'agenda}).
  1603. @item C-c a M
  1604. Comme @kbd{C-c a m}, mais sélectionne seulement les en-tête qui sont aussi des
  1605. items TODO.
  1606. @end table
  1607. @subsubheading Syntaxe de correspondance
  1608. Une recherche de chaîne peut utiliser des opérateurs booléens @samp{&} pour ET
  1609. et @samp{|} pour OU. @samp{&} lie plus fortement que @samp{|}. Les parenthèses
  1610. ne sont couramment pas implémentées. Chaque élément dans la recherche est soit
  1611. une balise, une expression régulière correspondante à des balises, ou une
  1612. expression comme @code{PROPERTY OPERATOR VALUE} avec un opérateur de
  1613. comparaison, l'accès à une valeur de propriété. Chaque élément peut être
  1614. précédé par @samp{-}, pour le sélectionner, et @samp{+} est du sucre syntaxique
  1615. pour une sélection positive. L'opérateur ET @samp{&} est optionnel lorsque
  1616. @samp{+} ou @samp{-} est présent. Voici quelques exemples, utilisant seulement
  1617. les balises.
  1618. @table @samp
  1619. @item +work-boss
  1620. Sélectionne les lignes d'en-tête balisées @samp{:work:}, mais rejette aussi
  1621. celles qui sont balisées @samp{:boss:}.
  1622. @item work|laptop
  1623. Sélectionne les lignes balisées @samp{:work:} ou @samp{:laptop:}.
  1624. @item work|laptop+night
  1625. Comme avant, mais requiert que les lignes @samp{:laptop:} soient aussi balisées
  1626. @samp{:night:}.
  1627. @end table
  1628. Vous pouvez aussi tester des propriétés en même temps que des correspondances
  1629. de balises, voir le manuel pour plus d'informations.
  1630. @node Chronologie, Vue de recherche, Correspondance balises et propriétés, Vues intégrées de l'agenda
  1631. @subsection Chronologie pour un fichier unique
  1632. La chronologie résume tous les éléments horodatés à partir d'un fichier en mode
  1633. Org un @emph{temps trié prévu}. Le but principal de cette commande est de donner
  1634. un aperçu sur les événements dans un projet.
  1635. @table @kbd
  1636. @item C-c a L
  1637. Montre un temps trié prévu du fichier Org, avec des items horodatés. Lorsqu'appelé avec
  1638. un argument préfixé @kbd{C-u} toutes les entrées TODO non terminées (programmées ou pas)
  1639. sont aussi listées sous la date courante.
  1640. @end table
  1641. @node Vue de recherche, , Chronologie, Vues intégrées de l'agenda
  1642. @subsection Vue de recherche
  1643. Cette vue d'agenda est une facilité de recherche générale de texte pour les
  1644. entrées en mode Org. C'est particulièrement utile pour trouver des notes.
  1645. @table @kbd
  1646. @item C-c a s
  1647. C'est une recherche spéciale qui vous permet de sélectionner des entrées par
  1648. correspondance d'une sous-chaîne ou mots spécifiques utilisant une logique
  1649. booléenne.
  1650. @end table
  1651. Par exemple, la recherche de la chaîne @samp{computer equipment} trouvera des
  1652. entrées contenant @samp{computer equipment} comme sous-chaîne.
  1653. La vue de recherche peut aussi chercher des mots-clés spécifiques dans l'entrée,
  1654. utilisant la logique booléenne. La recherche de la chaîne
  1655. @samp{+computer +wifi -ethernet -@{8\.11[bg]@}} cherchera les entrées qui
  1656. contiennent les mots-clés @code{computer} et @code{wifi}, mais pas le mot-clé
  1657. @code{ethernet}, et qui ne sont pas aussi associés à l'expression régulière
  1658. @code{8\.11[bg]}, signifiant d'exclure à la fois 8.11b et 8.11g.
  1659. Notez qu'en supplément des fichiers d'agenda, cette commande cherchera aussi
  1660. les fichiers listés dans @code{org-agenda-text-search-extra-files}.
  1661. @node Commandes de l'agenda, Custom agenda views, Vues intégrées de l'agenda, Vues de l'agenda
  1662. @section Commandes dans le tampon agenda
  1663. Les entrées du tampon agenda sont liées au fichier Org ou au journal dont ils
  1664. proviennent. Les commandes sont fournies pour montrer et sauter vers
  1665. l'emplacement l'entrée originale, et pour éditer les fichiers Org <<à
  1666. distance>> depuis le tampon agenda. C'est juste une sélection des nombreuses
  1667. commandes, qui explorez le menu @code{Agenda} et le manuel pour une liste complète.
  1668. @table @kbd
  1669. @tsubheading{Mouvement}
  1670. @item n
  1671. Ligne suivante (comme @key{haut} et @kbd{C-p}).
  1672. @item p
  1673. Ligne précédente (comme @key{bas} et @kbd{C-n}).
  1674. @tsubheading{Voir/Aller vers un fichier Org}
  1675. @item mouse-3
  1676. @itemx @key{SPC}
  1677. Affiche l'emplacement original de l'item dans une autre fenêtre.
  1678. Avec un argument préfixé, s'assure que l'entrée est visible
  1679. dans les grandes lignes, pas seulement l'en-tête.
  1680. @c
  1681. @itemx @key{TAB}
  1682. Va à l'emplacement original de l'item dans une autre fenêtre. Sous Emacs
  1683. 22, @kbd{mouse-1} fonctionnera aussi pour ça.
  1684. @c
  1685. @itemx @key{RET}
  1686. Va à l'emplacement original de l'item et détruit l'autre fenêtre.
  1687. @c
  1688. @tsubheading{Modifier l'affichage}
  1689. @item o
  1690. Détruit les autres fenêtres.
  1691. @c
  1692. @item d @r{/} w
  1693. Permute vers la vue jour/semaine
  1694. @c
  1695. @item f @r{et} b
  1696. Va en avant/en arrière dans le temps pour affihcer les jours suivants
  1697. @code{org-agenda-current-span}. Par exemple, si l'affichage couvre une semaine,
  1698. permute à la prochaine/précédente semaine.
  1699. @c
  1700. @item .
  1701. Va à aujourd'hui.
  1702. @c
  1703. @item j
  1704. Invite à saisir une date et y va.
  1705. @c
  1706. @item v l @ @r{ou version courte} @ l
  1707. Bascule en mode Logbook. En mode Logbook, les entrées qui étaient
  1708. marquées DONE tandis que logging était activé (variable @code{org-log-done}) sont
  1709. montrées dans l'agenda, comme entrées qui ont été chronométrées ce jour-là.
  1710. Lorsqu'appelée avec un argument préfixé @kbd{C-u} montre toutes les entrées
  1711. logbook possible, incluant les changements d'états.
  1712. @c
  1713. @item r @r{ou} g
  1714. Recrée le tampon agenda, pour refléter les changements.
  1715. @item s
  1716. Sauvegarde tous les tampons Org dans la session Emacs en cours, et aussi les
  1717. emplacements des IDs.
  1718. @tsubheading{Secondary filtering and query editing}
  1719. @item /
  1720. Filter the current agenda view with respect to a tag. You are prompted for a
  1721. letter to select a tag. Press @samp{-} first to select against the tag.
  1722. @item \
  1723. Narrow the current agenda filter by an additional condition.
  1724. @tsubheading{Remote editing (see the manual for many more commands)}
  1725. @item 0--9
  1726. Digit argument.
  1727. @c
  1728. @item t
  1729. Change the TODO state of the item, in the agenda and in the
  1730. org file.
  1731. @c
  1732. @item C-k
  1733. Delete the current agenda item along with the entire subtree belonging
  1734. to it in the original Org file.
  1735. @c
  1736. @item C-c C-w
  1737. Refile the entry at point.
  1738. @c
  1739. @item C-c C-x C-a @ @r{or short} @ a
  1740. Archive the subtree corresponding to the entry at point using the default
  1741. archiving command set in @code{org-archive-default-command}.
  1742. @c
  1743. @item C-c C-x C-s @ @r{or short} @ $
  1744. Archive the subtree corresponding to the current headline.
  1745. @c
  1746. @item C-c C-s
  1747. Schedule this item, with prefix arg remove the scheduling timestamp
  1748. @c
  1749. @item C-c C-d
  1750. Set a deadline for this item, with prefix arg remove the deadline.
  1751. @c
  1752. @item S-@key{right} @r{and} S-@key{left}
  1753. Change the timestamp associated with the current line by one day.
  1754. @c
  1755. @item I
  1756. Start the clock on the current item.
  1757. @c
  1758. @item O / X
  1759. Stop/cancel the previously started clock.
  1760. @item J
  1761. Jump to the running clock in another window.
  1762. @end table
  1763. @node Custom agenda views, , Commandes de l'agenda, Vues de l'agenda
  1764. @section Custom agenda views
  1765. The main application of custom searches is the definition of keyboard
  1766. shortcuts for frequently used searches, either creating an agenda
  1767. buffer, or a sparse tree (the latter covering of course only the current
  1768. buffer).
  1769. Custom commands are configured in the variable
  1770. @code{org-agenda-custom-commands}. You can customize this variable, for
  1771. example by pressing @kbd{C-c a C}. You can also directly set it with
  1772. Emacs Lisp in @file{.emacs}. The following example contains all valid
  1773. search types:
  1774. @smalllisp
  1775. @group
  1776. (setq org-agenda-custom-commands
  1777. '(("w" todo "WAITING")
  1778. ("u" tags "+boss-urgent")
  1779. ("v" tags-todo "+boss-urgent")))
  1780. @end group
  1781. @end smalllisp
  1782. @noindent
  1783. The initial string in each entry defines the keys you have to press after the
  1784. dispatcher command @kbd{C-c a} in order to access the command. Usually this
  1785. will be just a single character. The second parameter is the search type,
  1786. followed by the string or regular expression to be used for the matching.
  1787. The example above will therefore define:
  1788. @table @kbd
  1789. @item C-c a w
  1790. as a global search for TODO entries with @samp{WAITING} as the TODO
  1791. keyword
  1792. @item C-c a u
  1793. as a global tags search for headlines marked @samp{:boss:} but not
  1794. @samp{:urgent:}
  1795. @item C-c a v
  1796. as the same search as @kbd{C-c a u}, but limiting the search to
  1797. headlines that are also Listes TODO
  1798. @end table
  1799. @seealso{
  1800. @uref{http://orgmode.org/manual/Agenda-Views.html#Agenda-Views, Chapter 10 of
  1801. the manual}@*
  1802. @uref{http://orgmode.org/worg/org-tutorials/org-custom-agenda-commands.php,
  1803. Mat Lundin's tutorial about custom agenda commands}@*
  1804. @uref{http://www.newartisans.com/2007/08/using-org-mode-as-a-day-planner.html,
  1805. John Wiegley's setup}}
  1806. @node Markup, Exporting, Vues de l'agenda, Top
  1807. @chapter Markup for rich export
  1808. When exporting Org-mode documents, the exporter tries to reflect the
  1809. structure of the document as accurately as possible in the backend. Since
  1810. export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
  1811. Org mode has rules on how to prepare text for rich export. This section
  1812. summarizes the markup rules used in an Org-mode buffer.
  1813. @menu
  1814. * Structural markup elements:: The basic structure as seen by the exporter
  1815. * Images and tables:: Images, tables and caption mechanism
  1816. * Literal examples:: Source code examples with special formatting
  1817. * Include files:: Include additional files into a document
  1818. * Embedded @LaTeX{}:: @LaTeX{} can be freely used inside Org documents
  1819. @end menu
  1820. @node Structural markup elements, Images and tables, Markup, Markup
  1821. @section Structural markup elements
  1822. @menu
  1823. * Document title:: Where the title is taken from
  1824. * Headings and sections:: The document structure as seen by the exporter
  1825. * Table of contents:: The if and where of the table of contents
  1826. * Paragraphs:: Paragraphs
  1827. * Emphasis and monospace:: Bold, italic, etc.
  1828. * Comment lines:: What will *not* be exported
  1829. @end menu
  1830. @node Document title, Headings and sections, Structural markup elements, Structural markup elements
  1831. @subheading Document title
  1832. @noindent
  1833. The title of the exported document is taken from the special line
  1834. @smallexample
  1835. #+TITLE: This is the title of the document
  1836. @end smallexample
  1837. @node Headings and sections, Table of contents, Document title, Structural markup elements
  1838. @subheading Headings and sections
  1839. The outline structure of the document as described in @ref{Document
  1840. Structure}, forms the basis for defining sections of the exported document.
  1841. However, since the outline structure is also used for (for example) lists of
  1842. tasks, only the first three outline levels will be used as headings. Deeper
  1843. levels will become itemized lists. You can change the location of this
  1844. switch globally by setting the variable @code{org-export-headline-levels}, or on a
  1845. per-file basis with a line
  1846. @smallexample
  1847. #+OPTIONS: H:4
  1848. @end smallexample
  1849. @node Table of contents, Paragraphs, Headings and sections, Structural markup elements
  1850. @subheading Table of contents
  1851. The table of contents is normally inserted directly before the first headline
  1852. of the file.
  1853. @smallexample
  1854. #+OPTIONS: toc:2 (only to two levels in TOC)
  1855. #+OPTIONS: toc:nil (no TOC at all)
  1856. @end smallexample
  1857. @node Paragraphs, Emphasis and monospace, Table of contents, Structural markup elements
  1858. @subheading Paragraphs, line breaks, and quoting
  1859. Paragraphs are separated by at least one empty line. If you need to enforce
  1860. a line break within a paragraph, use @samp{\\} at the end of a line.
  1861. To keep the line breaks in a region, but otherwise use normal formatting, you
  1862. can use this construct, which can also be used to format poetry.
  1863. @smallexample
  1864. #+BEGIN_VERSE
  1865. Great clouds overhead
  1866. Tiny black birds rise and fall
  1867. Snow covers Emacs
  1868. -- AlexSchroeder
  1869. #+END_VERSE
  1870. @end smallexample
  1871. When quoting a passage from another document, it is customary to format this
  1872. as a paragraph that is indented on both the left and the right margin. You
  1873. can include quotations in Org-mode documents like this:
  1874. @smallexample
  1875. #+BEGIN_QUOTE
  1876. Everything should be made as simple as possible,
  1877. but not any simpler -- Albert Einstein
  1878. #+END_QUOTE
  1879. @end smallexample
  1880. If you would like to center some text, do it like this:
  1881. @smallexample
  1882. #+BEGIN_CENTER
  1883. Everything should be made as simple as possible, \\
  1884. but not any simpler
  1885. #+END_CENTER
  1886. @end smallexample
  1887. @node Emphasis and monospace, Comment lines, Paragraphs, Structural markup elements
  1888. @subheading Emphasis and monospace
  1889. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  1890. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  1891. in the code and verbatim string is not processed for Org-mode specific
  1892. syntax, it is exported verbatim. To insert a horizontal rules, use a line
  1893. consisting of only dashes, and at least 5 of them.
  1894. @node Comment lines, , Emphasis and monospace, Structural markup elements
  1895. @subheading Comment lines
  1896. Lines starting with zero or more whitespace characters followed by @samp{#}
  1897. and a whitespace are treated as comments and, as such, are not exported.
  1898. Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
  1899. ... @samp{#+END_COMMENT} are not exported.
  1900. Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
  1901. other keyword or priority cookie, comments out the entire subtree. The
  1902. command below helps changing the comment status of a headline.
  1903. @table @kbd
  1904. @item C-c ;
  1905. Toggle the COMMENT keyword at the beginning of an entry.
  1906. @end table
  1907. @node Images and tables, Literal examples, Structural markup elements, Markup
  1908. @section Images and Tables
  1909. For Org mode tables, the lines before the first horizontal separator line
  1910. will become table header lines. You can use the following lines somewhere
  1911. before the table to assign a caption and a label for cross references, and in
  1912. the text you can refer to the object with @code{[[tab:basic-data]]}:
  1913. @smallexample
  1914. #+CAPTION: This is the caption for the next table (or link)
  1915. #+NAME: tbl:basic-data
  1916. | ... | ...|
  1917. |-----|----|
  1918. @end smallexample
  1919. Some backends allow you to directly include images into the exported
  1920. document. Org does this, if a link to an image files does not have
  1921. a description part, for example @code{[[./img/a.jpg]]}. If you wish to
  1922. define a caption for the image and maybe a label for internal cross
  1923. references, you sure that the link is on a line by itself precede it with:
  1924. @smallexample
  1925. #+CAPTION: This is the caption for the next figure link (or table)
  1926. #+NAME: fig:SED-HR4049
  1927. [[./img/a.jpg]]
  1928. @end smallexample
  1929. The same caption mechanism applies to other structures than images and tables
  1930. (e.g., @LaTeX{} equations, source code blocks), provided the chosen export
  1931. back-end supports them.
  1932. @node Literal examples, Include files, Images and tables, Markup
  1933. @section Literal examples
  1934. You can include literal examples that should not be subjected to
  1935. markup. Such examples will be typeset in monospace, so this is well suited
  1936. for source code and similar examples.
  1937. @smallexample
  1938. #+BEGIN_EXAMPLE
  1939. Some example from a text file.
  1940. #+END_EXAMPLE
  1941. @end smallexample
  1942. For simplicity when using small examples, you can also start the example
  1943. lines with a colon followed by a space. There may also be additional
  1944. whitespace before the colon:
  1945. @smallexample
  1946. Here is an example
  1947. : Some example from a text file.
  1948. @end smallexample
  1949. For source code from a programming language, or any other text
  1950. that can be marked up by font-lock in Emacs, you can ask for it to
  1951. look like the fontified Emacs buffer
  1952. @smallexample
  1953. #+BEGIN_SRC emacs-lisp
  1954. (defun org-xor (a b)
  1955. "Exclusive or."
  1956. (if a (not b) b))
  1957. #+END_SRC
  1958. @end smallexample
  1959. To edit the example in a special buffer supporting this language, use
  1960. @kbd{C-c '} to both enter and leave the editing buffer.
  1961. @node Include files, Embedded @LaTeX{}, Literal examples, Markup
  1962. @section Include files
  1963. During export, you can include the content of another file. For example, to
  1964. include your @file{.emacs} file, you could use:
  1965. @smallexample
  1966. #+INCLUDE: "~/.emacs" src emacs-lisp
  1967. @end smallexample
  1968. @noindent
  1969. The optional second and third parameter are the markup (i.e., @samp{example}
  1970. or @samp{src}), and, if the markup is @samp{src}, the language for formatting
  1971. the contents. The markup is optional, if it is not given, the text will be
  1972. assumed to be in Org mode format and will be processed normally. File-links
  1973. will be interpreted as well:
  1974. @smallexample
  1975. #+INCLUDE: "./otherfile.org::#my_custom_id" :only-contents t
  1976. @end smallexample
  1977. @noindent
  1978. @kbd{C-c '} will visit the included file.
  1979. @node Embedded @LaTeX{}, , Include files, Markup
  1980. @section Embedded @LaTeX{}
  1981. For scientific notes which need to be able to contain mathematical symbols
  1982. and the occasional formula, Org-mode supports embedding @LaTeX{} code into
  1983. its files. You can directly use TeX-like syntax for special symbols, enter
  1984. formulas and entire @LaTeX{} environments.
  1985. @smallexample
  1986. Angles are written as Greek letters \alpha, \beta and \gamma. The mass if
  1987. the sun is M_sun = 1.989 x 10^30 kg. The radius of the sun is R_@{sun@} =
  1988. 6.96 x 10^8 m. If $a^2=b$ and $b=2$, then the solution must be either
  1989. $a=+\sqrt@{2@}$ or $a=-\sqrt@{2@}$.
  1990. \begin@{equation@}
  1991. x=\sqrt@{b@}
  1992. \end@{equation@}
  1993. @end smallexample
  1994. @noindent
  1995. With
  1996. @uref{http://orgmode.org/manual/LaTeX-fragments.html#LaTeX-fragments,special
  1997. setup}, @LaTeX{} snippets will be included as images when exporting to HTML.
  1998. @seealso{
  1999. @uref{http://orgmode.org/manual/Markup.html#Markup, Chapter 11 of the manual}}
  2000. @node Exporting, Publishing, Markup, Top
  2001. @chapter Exporting
  2002. Org-mode documents can be exported into a variety of other formats: ASCII
  2003. export for inclusion into emails, HTML to publish on the web, @LaTeX{}/PDF
  2004. for beautiful printed documents and DocBook to enter the world of many other
  2005. formats using DocBook tools. There is also export to iCalendar format so
  2006. that planning information can be incorporated into desktop calendars.
  2007. @menu
  2008. * Export options:: Per-file export settings
  2009. * The export dispatcher:: How to access exporter commands
  2010. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  2011. * HTML export:: Exporting to HTML
  2012. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  2013. * iCalendar export:: Exporting to iCalendar
  2014. @end menu
  2015. @node Export options, The export dispatcher, Exporting, Exporting
  2016. @section Export options
  2017. The exporter recognizes special lines in the buffer which provide additional
  2018. information. These lines may be put anywhere in the file. The whole set of
  2019. lines can be inserted into the buffer with @kbd{C-c C-e #}.
  2020. @table @kbd
  2021. @item C-c C-e #
  2022. Insert template with export options, see example below.
  2023. @end table
  2024. @smallexample
  2025. #+TITLE: the title to be shown
  2026. #+AUTHOR: the author (default taken from @code{user-full-name})
  2027. #+DATE: a date, fixed, or an Org timestamp
  2028. #+EMAIL: his/her email address (default from @code{user-mail-address})
  2029. #+LANGUAGE: language, e.g.@: @samp{en} (@code{org-export-default-language})
  2030. #+OPTIONS: H:2 num:t toc:t \n:nil ::t |:t ^:t f:t tex:t ...
  2031. @end smallexample
  2032. @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
  2033. @section The export dispatcher
  2034. All export commands can be reached using the export dispatcher, which is
  2035. a prefix key that prompts for an additional key specifying the command.
  2036. Normally the entire file is exported, but if a region is active, it will be
  2037. exported instead.
  2038. @table @kbd
  2039. @item C-c C-e
  2040. Dispatcher for export and publishing commands.
  2041. @end table
  2042. @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
  2043. @section ASCII/Latin-1/UTF-8 export
  2044. ASCII export produces a simple and very readable version of an Org-mode
  2045. file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
  2046. with special characters and symbols available in these encodings.
  2047. @table @kbd
  2048. @item C-c C-e t a @ @ @r{and} @ @ C-c C-e t A
  2049. Export as ASCII file or temporary buffer.
  2050. @item C-c C-e t n @ @ @r{and} @ @ C-c C-e t N
  2051. Like the above commands, but use Latin-1 encoding.
  2052. @item C-c C-e t u @ @ @r{and} @ @ C-c C-e t U
  2053. Like the above commands, but use UTF-8 encoding.
  2054. @end table
  2055. @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
  2056. @section HTML export
  2057. @table @kbd
  2058. @item C-c C-e h h
  2059. Export as HTML file @file{myfile.html}.
  2060. @item C-c C-e h o
  2061. Export as HTML file and immediately open it with a browser.
  2062. @end table
  2063. To insert HTML that should be copied verbatim to
  2064. the exported file use either
  2065. @smallexample
  2066. #+HTML: Literal HTML code for export
  2067. @end smallexample
  2068. @noindent
  2069. or
  2070. @smallexample
  2071. #+BEGIN_HTML
  2072. All lines between these markers are exported literally
  2073. #+END_HTML
  2074. @end smallexample
  2075. @node @LaTeX{} and PDF export, iCalendar export, HTML export, Exporting
  2076. @section @LaTeX{} and PDF export
  2077. @table @kbd
  2078. @item C-c C-e l l
  2079. Export as @LaTeX{} file @file{myfile.tex}.
  2080. @item C-c C-e l p
  2081. Export as @LaTeX{} and then process to PDF.
  2082. @item C-c C-e l o
  2083. Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
  2084. @end table
  2085. By default, the @LaTeX{} output uses the class @code{article}. You can
  2086. change this by adding an option like @code{#+LATEX_CLASS: myclass} in your
  2087. file. The class must be listed in @code{org-latex-classes}.
  2088. Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
  2089. inserted into the @LaTeX{} file. Similarly to the HTML exporter, you can use
  2090. @code{#+LATEX:} and @code{#+BEGIN_LATEX ... #+END_LATEX} construct to add
  2091. verbatim @LaTeX{} code.
  2092. @node iCalendar export, , @LaTeX{} and PDF export, Exporting
  2093. @section iCalendar export
  2094. @table @kbd
  2095. @item C-c C-e c f
  2096. Create iCalendar entries for the current file in a @file{.ics} file.
  2097. @item C-c C-e c c
  2098. Create a single large iCalendar file from all files in
  2099. @code{org-agenda-files} and write it to the file given by
  2100. @code{org-icalendar-combined-agenda-file}.
  2101. @end table
  2102. @seealso{
  2103. @uref{http://orgmode.org/manual/Exporting.html#Exporting, Chapter 12 of the manual}@*
  2104. @uref{http://orgmode.org/worg/org-tutorials/images-and-xhtml-export.php,
  2105. Sebastian Rose's image handling tutorial}@*
  2106. @uref{http://orgmode.org/worg/org-tutorials/org-latex-export.php, Thomas
  2107. Dye's LaTeX export tutorial}
  2108. @uref{http://orgmode.org/worg/org-tutorials/org-beamer/tutorial.php, Eric
  2109. Fraga's BEAMER presentation tutorial}}
  2110. @node Publishing, Working With Source Code, Exporting, Top
  2111. @chapter Publishing
  2112. Org includes a publishing management system that allows you to configure
  2113. automatic HTML conversion of @emph{projects} composed of interlinked org
  2114. files. You can also configure Org to automatically upload your exported HTML
  2115. pages and related attachments, such as images and source code files, to a web
  2116. server. For detailed instructions about setup, see the manual.
  2117. Here is an example:
  2118. @smalllisp
  2119. (setq org-publish-project-alist
  2120. '(("org"
  2121. :base-directory "~/org/"
  2122. :publishing-directory "~/public_html"
  2123. :section-numbers nil
  2124. :table-of-contents nil
  2125. :style "<link rel=\"stylesheet\"
  2126. href=\"../other/mystyle.css\"
  2127. type=\"text/css\"/>")))
  2128. @end smalllisp
  2129. @table @kbd
  2130. @item C-c C-e P x
  2131. Prompt for a specific project and publish all files that belong to it.
  2132. @item C-c C-e P p
  2133. Publish the project containing the current file.
  2134. @item C-c C-e P f
  2135. Publish only the current file.
  2136. @item C-c C-e P a
  2137. Publish every project.
  2138. @end table
  2139. Org uses timestamps to track when a file has changed. The above functions
  2140. normally only publish changed files. You can override this and force
  2141. publishing of all files by giving a prefix argument to any of the commands
  2142. above.
  2143. @seealso{
  2144. @uref{http://orgmode.org/manual/Publishing.html#Publishing, Chapter 13 of the
  2145. manual}@*
  2146. @uref{http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php,
  2147. Sebastian Rose's publishing tutorial}@*
  2148. @uref{http://orgmode.org/worg/org-tutorials/org-jekyll.php, Ian Barton's
  2149. Jekyll/blogging setup}}
  2150. @node Working With Source Code, Miscellaneous, Publishing, Top
  2151. @chapter Working with source code
  2152. Org-mode provides a number of features for working with source code,
  2153. including editing of code blocks in their native major-mode, evaluation of
  2154. code blocks, tangling of code blocks, and exporting code blocks and their
  2155. results in several formats.
  2156. @subheading Structure of Code Blocks
  2157. The structure of code blocks is as follows:
  2158. @example
  2159. #+NAME: <name>
  2160. #+BEGIN_SRC <language> <switches> <header arguments>
  2161. <body>
  2162. #+END_SRC
  2163. @end example
  2164. Where @code{<name>} is a string used to name the code block,
  2165. @code{<language>} specifies the language of the code block
  2166. (e.g.@: @code{emacs-lisp}, @code{shell}, @code{R}, @code{python}, etc...),
  2167. @code{<switches>} can be used to control export of the code block,
  2168. @code{<header arguments>} can be used to control many aspects of code block
  2169. behavior as demonstrated below, and @code{<body>} contains the actual source
  2170. code.
  2171. @subheading Editing source code
  2172. Use @kbd{C-c '} to edit the current code block. This brings up a language
  2173. major-mode edit buffer containing the body of the code block. Saving this
  2174. buffer will write the new contents back to the Org buffer. Use @kbd{C-c '}
  2175. again to exit the edit buffer.
  2176. @subheading Evaluating code blocks
  2177. Use @kbd{C-c C-c} to evaluate the current code block and insert its results
  2178. in the Org-mode buffer. By default, evaluation is only turned on for
  2179. @code{emacs-lisp} code blocks, however support exists for evaluating blocks
  2180. in many languages. For a complete list of supported languages see the
  2181. manual. The following shows a code block and its results.
  2182. @example
  2183. #+BEGIN_SRC emacs-lisp
  2184. (+ 1 2 3 4)
  2185. #+END_SRC
  2186. #+RESULTS:
  2187. : 10
  2188. @end example
  2189. @subheading Extracting source code
  2190. Use @kbd{C-c C-v t} to create pure source code files by extracting code from
  2191. source blocks in the current buffer. This is referred to as ``tangling''---a
  2192. term adopted from the literate programming community. During ``tangling'' of
  2193. code blocks their bodies are expanded using @code{org-babel-expand-src-block}
  2194. which can expand both variable and ``noweb'' style references. In order to
  2195. tangle a code block it must have a @code{:tangle} header argument, see the
  2196. manual for details.
  2197. @subheading Library of Babel
  2198. Use @kbd{C-c C-v l} to load the code blocks from an Org-mode files into the
  2199. ``Library of Babel'', these blocks can then be evaluated from any Org-mode
  2200. buffer. A collection of generally useful code blocks is distributed with
  2201. Org-mode in @code{contrib/library-of-babel.org}.
  2202. @subheading Header Arguments
  2203. Many aspects of the evaluation and export of code blocks are controlled
  2204. through header arguments. These can be specified globally, at the file
  2205. level, at the outline subtree level, and at the individual code block level.
  2206. The following describes some of the header arguments.
  2207. @table @code
  2208. @item :var
  2209. The @code{:var} header argument is used to pass arguments to code blocks.
  2210. The values passed to arguments can be literal values, values from org-mode
  2211. tables and literal example blocks, or the results of other named code blocks.
  2212. @item :results
  2213. The @code{:results} header argument controls the @emph{collection},
  2214. @emph{type}, and @emph{handling} of code block results. Values of
  2215. @code{output} or @code{value} (the default) specify how results are collected
  2216. from a code block's evaluation. Values of @code{vector}, @code{scalar}
  2217. @code{file} @code{raw} @code{html} @code{latex} and @code{code} specify the
  2218. type of the results of the code block which dictates how they will be
  2219. incorporated into the Org-mode buffer. Values of @code{silent},
  2220. @code{replace}, @code{prepend}, and @code{append} specify handling of code
  2221. block results, specifically if and how the results should be inserted into
  2222. the Org-mode buffer.
  2223. @item :session
  2224. A header argument of @code{:session} will cause the code block to be
  2225. evaluated in a persistent interactive inferior process in Emacs. This allows
  2226. for persisting state between code block evaluations, and for manual
  2227. inspection of the results of evaluation.
  2228. @item :exports
  2229. Any combination of the @emph{code} or the @emph{results} of a block can be
  2230. retained on export, this is specified by setting the @code{:results} header
  2231. argument to @code{code} @code{results} @code{none} or @code{both}.
  2232. @item :tangle
  2233. A header argument of @code{:tangle yes} will cause a code block's contents to
  2234. be tangled to a file named after the filename of the Org-mode buffer. An
  2235. alternate file name can be specified with @code{:tangle filename}.
  2236. @item :cache
  2237. A header argument of @code{:cache yes} will cause associate a hash of the
  2238. expanded code block with the results, ensuring that code blocks are only
  2239. re-run when their inputs have changed.
  2240. @item :noweb
  2241. A header argument of @code{:noweb yes} will expand ``noweb'' style references
  2242. on evaluation and tangling.
  2243. @item :file
  2244. Code blocks which output results to files (e.g.@: graphs, diagrams and figures)
  2245. can accept a @code{:file filename} header argument in which case the results
  2246. are saved to the named file, and a link to the file is inserted into the
  2247. Org-mode buffer.
  2248. @end table
  2249. @seealso{
  2250. @uref{http://orgmode.org/manual/Literal-examples.html#Literal-examples,
  2251. Chapter 11.3 of the manual}@*
  2252. @uref{http://orgmode.org/worg/org-contrib/babel/index.php,
  2253. The Babel site on Worg}}
  2254. @node Miscellaneous, GNU Free Documentation License, Working With Source Code, Top
  2255. @chapter Miscellaneous
  2256. @menu
  2257. * Completion:: M-TAB knows what you need
  2258. * Clean view:: Getting rid of leading stars in the outline
  2259. * MobileOrg:: Org-mode on the iPhone
  2260. @end menu
  2261. @node Completion, Clean view, Miscellaneous, Miscellaneous
  2262. @section Completion
  2263. Org supports in-buffer completion with @kbd{M-@key{TAB}}. This type of
  2264. completion does not make use of the minibuffer. You simply type a few
  2265. letters into the buffer and use the key to complete text right there. For
  2266. example, this command will complete @TeX{} symbols after @samp{\}, TODO
  2267. keywords at the beginning of a headline, and tags after @samp{:} in a
  2268. headline.
  2269. @node Clean view, MobileOrg, Completion, Miscellaneous
  2270. @section A cleaner outline view
  2271. Some people find it noisy and distracting that the Org headlines start with a
  2272. potentially large number of stars, and that text below the headlines is not
  2273. indented. While this is no problem when writing a @emph{book-like} document
  2274. where the outline headings are really section headings, in a more
  2275. @emph{list-oriented} outline, indented structure is a lot cleaner:
  2276. @smallexample
  2277. @group
  2278. * Top level headline | * Top level headline
  2279. ** Second level | * Second level
  2280. *** 3rd level | * 3rd level
  2281. some text | some text
  2282. *** 3rd level | * 3rd level
  2283. more text | more text
  2284. * Another top level headline | * Another top level headline
  2285. @end group
  2286. @end smallexample
  2287. @noindent
  2288. If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind
  2289. of view can be achieved dynamically at display time using
  2290. @code{org-indent-mode}, which will prepend intangible space to each line.
  2291. You can turn on @code{org-indent-mode} for all files by customizing the
  2292. variable @code{org-startup-indented}, or you can turn it on for individual
  2293. files using
  2294. @smallexample
  2295. #+STARTUP: indent
  2296. @end smallexample
  2297. If you want a similar effect in earlier version of Emacs and/or Org, or if
  2298. you want the indentation to be hard space characters so that the plain text
  2299. file looks as similar as possible to the Emacs display, Org supports you by
  2300. helping to indent (with @key{TAB}) text below each headline, by hiding
  2301. leading stars, and by only using levels 1, 3, etc to get two characters
  2302. indentation for each level. To get this support in a file, use
  2303. @smallexample
  2304. #+STARTUP: hidestars odd
  2305. @end smallexample
  2306. @node MobileOrg, , Clean view, Miscellaneous
  2307. @section MobileOrg
  2308. @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
  2309. available for iOS and for Android. @i{MobileOrg} offers offline viewing and
  2310. capture support for an Org mode system rooted on a ``real'' computer. It
  2311. does also allow you to record changes to existing entries.
  2312. The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
  2313. @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
  2314. Moreland. Android users should check out
  2315. @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
  2316. by Matt Jones. The two implementations are not identical but offer similar
  2317. features.
  2318. @seealso{
  2319. @uref{http://orgmode.org/manual/Miscellaneous.html#Miscellaneous, Chapter 15
  2320. of the manual}@*
  2321. @uref{http://orgmode.org/manual/MobileOrg.html#MobileOrg, Appendix B of the
  2322. manual}@*
  2323. @uref{http://orgmode.org/orgcard.pdf,Key reference card}}
  2324. @c @node GNU Free Documentation License, , Miscellaneous, Top
  2325. @c @appendix GNU Free Documentation License
  2326. @c @include doclicense.texi
  2327. @bye
  2328. @c Local variables:
  2329. @c fill-column: 77
  2330. @c End:
  2331. @c LocalWords: webdavhost pre