├── LICENSE.org ├── README.html ├── README.org └── images ├── Rplot.png ├── fig.png ├── org-mode-unicorn.png └── test.pdf /LICENSE.org: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | SQLTestDB 635 | Copyright (C) 2019 Fab Rice 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | SQLTestDB Copyright (C) 2019 Fab Rice 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.html: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 7 | 8 | Org mode syntax 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 45 | 46 | 51 | 52 | 53 |
54 | UP 55 | | 56 | HOME 57 |
58 |

Org mode syntax 59 |
60 | Quick reference card 61 |

62 |
63 |

Table of Contents

64 |
65 | 224 |
225 |
226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 |
FrameworkOrg mode 9
Bug trackerhttps://github.com/fniessen/refcard-org-mode/issues
Sourcehttps://github.com/fniessen/refcard-org-mode
251 | 252 |
253 |

Summary

254 |
255 |

256 | You will learn to: 257 |

258 | 259 |
    260 |
  • write your docs in Org mode
    • 261 |
  • create tables
    • 262 |
  • create custom code blocks
    • 263 |
  • and much more!
    • 264 |
265 | 266 |

267 | This is an Org mode document, using the .org extension (supported by GitHub). 268 |

269 | 270 |

271 | Org mode is an easy-to-write plain text formatting syntax for authoring notes, 272 | articles, LaTeX documents, books, Web pages, Beamer slide decks and much more! 273 |

274 | 275 |

276 | This is a cheat sheet for Org mode 8 (because of some markup syntax changes 277 | since Org mode 7), using ReadTheOrg CSS. 278 |

279 | 280 |

281 | Reading through all the documentation is highly recommended, but for the truly 282 | impatient, following are some quick steps to get started. 283 |

284 |
285 |
286 | 287 |
288 |

ADVERT: Elevate your Emacs skills in Paris, Utrecht, Leuven or Valencia!

289 |
290 |

291 | Unlock the power of Emacs! Join my next exclusive “Emacs Boost” course! 292 |

293 | 294 |

295 | Ready to supercharge your productivity and become an Emacs ninja? Look no 296 | further! 297 |

298 | 299 |

300 | What you’ll learn: 301 |

302 |
    303 |
  • Master Emacs from the basics to advanced tricks.
    • 304 |
  • Boost your editing efficiency and streamline your workflow.
    • 305 |
  • Customize Emacs to fit your unique needs.
    • 306 |
  • And much more!
    • 307 |
308 | 309 |

310 | Audience: Open to anyone interested in Emacs, from beginners to advanced 311 | users. 312 |

313 | 314 |

315 | Why choose my course? 316 |

317 |
    318 |
  • Expert instructor with 25 years of Emacs experience.
    • 319 |
  • Hands-on exercises to reinforce your learning.
    • 320 |
  • Networking opportunities with like-minded Emacs enthusiasts.
    • 321 |
  • Personalized attention.
    • 322 |
323 | 324 |

325 | Don’t miss this opportunity to take your Emacs skills to the next level!
326 |

327 | 328 |

329 | Visit https://emacsboost.com/en/ for more information, dates and locations, and 330 | to reserve your seat. 331 |

332 |
333 |
334 | 335 |
336 |

Reference card

337 |
338 |
339 |

Table of Contents

340 |
341 | 500 |
501 |
502 |
503 |
504 | 505 |
506 |

Document header

507 |
508 |

509 | Title and author line: 510 |

511 | 512 |
513 | 
#+TITLE:     Org mode syntax examples
 514 | #+AUTHOR:    Fabrice Niessen
 515 | 
 516 | My document provides...
 517 |
518 |
519 | 520 |

521 | It’s a good practice to also include an email line following the author line. 522 |

523 | 524 |
525 | 
#+EMAIL:     john.doe@example.com
 526 |
527 |
528 |
529 |
530 | 531 |
532 |

Document settings

533 |
534 |
535 |
536 |

Document description

537 |
538 |
539 | 
#+DESCRIPTION: This document catalogs a set of tips and tricks for composing documents in Org mode.
 540 | #+KEYWORDS:  org-mode, syntax, quick reference, cheat sheet, recommended practices, latex, beamer, html
 541 | #+LANGUAGE:  en
 542 |
543 |
544 |
545 |
546 | 547 |
548 |

Section numbering

549 |
550 |
551 | 
#+OPTIONS:   H:4
 552 |
553 |
554 | 555 |
556 | 
#+OPTIONS:   num:nil
 557 |
558 |
559 |
560 |
561 | 562 |
563 |

Table of contents

564 |
565 |

566 | Set the toc attribute to activate an auto-generated table of contents (limited 567 | to its 2 first levels) at the top of document. 568 |

569 | 570 |
571 | 
#+OPTIONS:   toc:2
 572 |
573 |
574 | 575 |
576 | 
#+OPTIONS:   p:t
 577 |
578 |
579 | 580 |
581 |

582 | The ALT_TITLE property allows to set an alternate title (shorter, for example) 583 | for a given headline in the table of contents and other running heads. 584 |

585 | 586 |
587 | 588 |

589 | To locally insert the TOC at some random place, use the #+TOC: headlines [n] 590 | feature; for example: 591 |

592 | 593 |
594 | 
#+TOC: headlines 2
 595 |
596 |
597 |
598 |
599 | 600 |
601 |

List of figures

602 |
603 |

604 | #+TOC: figures is not implemented yet in the HTML backend. 605 |

606 |
607 |
608 | 609 |
610 |

List of tables

611 |
612 |

613 | #+TOC: tables is already implemented in the HTML backend. 614 |

615 |
616 |
617 | 618 |
619 |

List of equations

620 |
621 |
622 | 623 |
624 |

Section titles (headings)

625 |
626 |
627 | 
* Biggest heading (level 1)
 628 | 
 629 | New chapter.
 630 |
631 |
632 | 633 |
634 | 
** Bigger heading (level 2)
 635 | 
 636 | New section.
 637 | 
 638 | *** Big heading (level 3)
 639 | 
 640 | New sub-section.
 641 | 
 642 | **** Heading (level 4)
 643 | 
 644 | New sub-sub-section.
 645 |
646 |
647 |
648 |
649 |

Bigger heading (level 2)

650 |
651 |

652 | New section. 653 |

654 |
655 | 656 |
657 |

Big heading (level 3)

658 |
659 |

660 | New sub-section. 661 |

662 |
663 | 664 |
665 |
Heading (level 4)
666 |
667 |

668 | New sub-sub-section. 669 |

670 |
671 |
672 |
673 |
674 | 675 |
676 |

Numbered headings

677 |
678 |

679 | You can create numbered headings up to a certain level by setting an option: 680 |

681 | 682 |
683 | 
#+OPTIONS: H:4
 684 |
685 |
686 |
687 |
688 |
689 | 690 |
691 |

Paragraphs

692 |
693 |
694 |
695 |

Normal

696 |
697 |
698 | 
A single newline has no effect.
 699 | This line is part of the same paragraph.
 700 | 
 701 | But an empty line
 702 | 
 703 | demarcates paragraphs.
 704 |
705 |
706 | 707 |

708 | A single newline has no effect. 709 | This line is part of the same paragraph. 710 |

711 | 712 |

713 | But an empty line 714 |

715 | 716 |

717 | demarcates paragraphs. 718 |

719 |
720 |
721 | 722 |
723 |

Line breaks

724 |
725 |
726 | 
By entering two consecutive backslashes, \\
 727 | you can force a line break
 728 | without starting a new paragraph.
 729 |
730 |
731 | 732 |

733 | By entering two consecutive backslashes,
734 | you can force a line break 735 | without starting a new paragraph. 736 |

737 |
738 |
739 | 740 |
741 |

Horizontal rules

742 |
743 |
744 | 
For an horizontal line, insert at least 5 dashes: this is some text above an
 745 | horizontal rule
 746 | -----
 747 | and some text below it.
 748 |
749 |
750 | 751 |

752 | For an horizontal line, insert at least 5 dashes: this is some text above an 753 | horizontal rule 754 |

755 |
756 |

757 | and some text below it. 758 |

759 |
760 |
761 | 762 |
763 |

Text width

764 |
765 |

766 | One morning, when Gregor Samsa woke from troubled dreams, he found himself 767 | transformed in his bed into a horrible vermin. He lay on his armour-like back, 768 | and if he lifted his head a little he could see his brown belly, slightly domed 769 | and divided by arches into stiff sections. The bedding was hardly able to cover 770 | it and seemed ready to slide off any moment. His many legs, pitifully thin 771 | compared with the size of the rest of him, waved about helplessly as he looked. 772 |

773 |
774 |
775 |
776 | 777 |
778 |

Formatting text

779 |
780 |

781 | Text effects. 782 |

783 |
784 | 785 |
786 |

Bold and italic

787 |
788 |
789 | 
Emphasize (italics), strongly (bold), and /very strongly/ (bold italics).
 790 |
791 |
792 | 793 |

794 | Emphasize (italics), strongly (bold), and very strongly (bold italics). 795 |

796 | 797 |

798 | Markup elements can be nested: 799 |

800 | 801 |
802 | 
This is italic text which contains underlined text within it, whereas this is
 803 | normal underlined text.
 804 |
805 |
806 | 807 |

808 | This is italic text which contains underlined text within it, whereas this is 809 | normal underlined text. 810 |

811 | 812 |

813 | Markup can span across multiple lines, by default no more than 2: 814 |

815 | 816 |
817 | 
*This
 818 | is not
 819 | bold.*
 820 |
821 |
822 | 823 |

824 | This 825 | is not 826 | bold. 827 |

828 | 829 |

830 | Org mode does not interpret a marker surrounded by alphanumeric characters as an 831 | emphasis marker. So, you can’t (easily) emphasize just part of a word: 832 |

833 | 834 |
835 | 
Not feas*ible*.
 836 |
837 |
838 | 839 |

840 | Not feas*ible*. 841 |

842 |
843 |
844 | 845 |
846 |

Monospace, superscript and subscript

847 |
848 |

849 | Other elements to use sparingly are: 850 |

851 | 852 |
853 | 
- monospaced typewriter font for inline code
 854 | - monospaced typewriter font for verbatim text
 855 | - deleted text (vs. inserted text)
 856 | - text with superscript, such as 210
 857 | - text with subscript, such as H2O
 858 |
859 |
860 | 861 |
    862 |
  • monospaced typewriter font for inline code
    • 863 |
  • monospaced typewriter font for verbatim text
    • 864 |
  • deleted text (vs. inserted text)
    • 865 |
  • text with superscript, such as 210
    • 866 |
  • text with subscript, such as H2O
    • 867 |
868 |
869 |
870 | 871 |
872 |

Smart punctuation

873 |
874 |

875 | If the XXX option is specified, Org mode will produce typographically correct 876 | output, converting straight quotes to curly quotes, --- to em-dashes, -- to 877 | en-dashes, and ... to ellipses. 878 |

879 |
880 |
881 |
882 | 883 |
884 |

Lists

885 |
886 |

887 | Org markup allows you to create bulleted or numbered lists. It allows any 888 | combination of the two list types. 889 |

890 |
891 | 892 |
893 |

Unordered lists

894 |
895 |

896 | Itemized lists are marked with bullets. Create them with a minus or a plus sign. 897 |

898 | 899 |

900 | They are convenient to organize data, and make the document prettier, and easier 901 | to read. 902 |

903 | 904 |
905 | 
- Item with some lengthy text wrapping hopefully across several lines. We add
 906 |   a few words to really show the line wrapping.
 907 | - Bullet.
 908 |   + Bullet.
 909 |     * Bullet.
 910 |
911 |
912 | 913 |
    914 |
  • Item with some lengthy text wrapping hopefully across several lines. We add 915 | a few words to really show the line wrapping.
    • 916 |
  • Bullet. 917 |
      918 |
    • Bullet. 919 |
        920 |
      • Bullet.
        • 921 |
      • 922 |
    • 923 |
924 |
925 |
926 | 927 |
928 |

Checklists

929 |
930 |
931 | 
- [X] Checked.
 932 | - [-] Half-checked.
 933 | - [ ] Not checked.
 934 | - Normal list item.
 935 |
936 |
937 | 938 |
    939 |
  • ☑ Checked.
    • 940 |
  • ☐ Half-checked.
    • 941 |
  • ☐ Not checked.
    • 942 |
  • Normal list item.
    • 943 |
944 |
945 |
946 | 947 |
948 |

Ordered lists

949 |
950 |

951 | Enumerated lists are marked with numbers or letters: 952 |

953 | 954 |
955 | 
1. Arabic (decimal) numbered list item. We add a few words to show the line
 956 |    wrapping.
 957 |    A. Upper case alpha (letter) numbered list item.
 958 |       a. Lower alpha.
 959 |       b. Lower alpha.
 960 |    B. Upper alpha.
 961 | 2. Number.
 962 |
963 |
964 | 965 |
    966 |
  1. Arabic (decimal) numbered list item. We add a few words to show the line 967 | wrapping. 968 |
      969 |
    1. Upper case alpha (letter) numbered list item. 970 |
        971 |
      1. Lower alpha.
        2. 972 |
      2. Lower alpha.
        3. 973 |
      2. 974 |
    2. Upper alpha.
      3. 975 |
    2. 976 |
  2. Number.
    3. 977 |
978 | 979 |

980 | You can have ordered lists with jumping numbers: 981 |

982 | 983 |
984 | 
2. [@2] We start with point number 2.
 985 | 3. Automatically numbered item.
 986 |
987 |
988 | 989 |
    990 |
  1. We start with point number 2.
    2. 991 |
  2. Automatically numbered item.
    3. 992 |
993 |
994 |
995 | 996 |
997 |

Definition lists

998 |
999 |

1000 | Labeled, multi-line lists. 1001 |

1002 | 1003 |
1004 | 
- First term to define ::
1005 |      Definition of the first term. We add a few words to show the line wrapping,
1006 |      to see what happens when you have long lines.
1007 | 
1008 | - Second term ::
1009 |      Explication of the second term with inline markup.
1010 | 
1011 |      In many paragraphs.
1012 |
1013 |
1014 | 1015 |
1016 |
First term to define
Definition of the first term. We add a few words to show the line wrapping, 1017 | to see what happens when you have long lines.
1018 | 1019 |
Second term

1020 | Explication of the second term with inline markup. 1021 |

1022 | 1023 |

1024 | In many paragraphs. 1025 |

1026 |
1027 |
1028 |
1029 | 1030 |
1031 |

Separating lists

1032 |
1033 |

1034 | Adjacent lists sometimes like to fuse. To force the start of a new list, offset 1035 | the two lists by an empty line comment: 1036 |

1037 | 1038 |
1039 | 
- apples
1040 | - oranges
1041 | - bananas
1042 | 
1043 | # Comment.
1044 | 
1045 | - carrots
1046 | - tomatoes
1047 | - celery
1048 |
1049 |
1050 | 1051 |
    1052 |
  • apples
    • 1053 |
  • oranges
    • 1054 |
  • bananas
    • 1055 |
1056 | 1057 |
    1058 |
  • carrots
    • 1059 |
  • tomatoes
    • 1060 |
  • celery
    • 1061 |
1062 |
1063 |
1064 |
1065 | 1066 |
1067 |

Tables

1068 |
1069 |

1070 | Tables are one of the most refined areas of the Org mode syntax. They are very easy 1071 | to create and to read. 1072 |

1073 |
1074 | 1075 |
1076 |

Simple table

1077 |
1078 |
1079 | 
| Cell in column 1, row 1 | Cell in column 2, row 1 |
1080 | | Cell in column 1, row 2 | Cell in column 2, row 2 |
1081 |
1082 |
1083 | 1084 | 1085 | 1086 | 1087 | 1088 | 1089 | 1090 | 1091 | 1092 | 1093 | 1094 | 1095 | 1096 | 1097 | 1098 | 1099 | 1100 | 1101 | 1102 | 1103 |
Cell in column 1, row 1Cell in column 2, row 1
Cell in column 1, row 2Cell in column 2, row 2
1104 | 1105 |

1106 | Org tables have cells of at most one line long: there is no such thing as 1107 | a multi-line table cell in Org. 1108 |

1109 |
1110 |
1111 | 1112 |
1113 |

Column formatting

1114 |
1115 |

1116 | Columns are automatically aligned: 1117 |

1118 | 1119 |
    1120 |
  • Number-rich columns to the right, and
    • 1121 |
  • String-rich columns to the left.
    • 1122 |
1123 |
1124 | 1125 |
1126 |

Table with aligned cells

1127 |
1128 |

1129 | If you want to override the automatic alignment, use <r>, <c> or <l>. 1130 |

1131 | 1132 |
1133 | 
#+CAPTION: Table with aligned columns
1134 | |          <r> | <c>          | <l>          |
1135 | |            1 | 2            | 3            |
1136 | |        Right | Center       | Left         |
1137 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
1138 |
1139 |
1140 | 1141 | 1142 | 1143 | 1144 | 1145 | 1146 | 1147 | 1148 | 1149 | 1150 | 1151 | 1152 | 1153 | 1154 | 1155 | 1156 | 1157 | 1158 | 1159 | 1160 | 1161 | 1162 | 1163 | 1164 | 1165 | 1166 | 1167 | 1168 | 1169 | 1170 |
Table 1: Table with aligned columns
123
RightCenterLeft
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
1171 |
1172 |
1173 | 1174 |
1175 |

Table with column size adjusted

1176 |
1177 |
1178 | 1179 |
1180 |

Header row

1181 |
1182 |

1183 | You can create tables with an header row (by using an horizontal line of dashes 1184 | to separate it from the rest of the table). 1185 |

1186 | 1187 |
1188 | 
#+CAPTION: Table with an header row
1189 | | Name of column 1 | Name of column 2 | Name of column 3 |
1190 | |------------------+------------------+------------------|
1191 | | Top left         | Top middle       |                  |
1192 | |                  |                  | Right            |
1193 | | Bottom left      | Bottom middle    |                  |
1194 |
1195 |
1196 | 1197 | 1198 | 1199 | 1200 | 1201 | 1202 | 1203 | 1204 | 1205 | 1206 | 1207 | 1208 | 1209 | 1210 | 1211 | 1212 | 1213 | 1214 | 1215 | 1216 | 1217 | 1218 | 1219 | 1220 | 1221 | 1222 | 1223 | 1224 | 1225 | 1226 | 1227 | 1228 | 1229 | 1230 | 1231 | 1232 | 1233 |
Table 2: Table with an header row
Name of column 1Name of column 2Name of column 3
Top leftTop middle 
  Right
Bottom leftBottom middle 
1234 |
1235 |
1236 | 1237 |
1238 |

A very long table

1239 |
1240 |

1241 | To test “sticky table headers”… 1242 |

1243 | 1244 | 1245 | 1246 | 1247 | 1248 | 1249 | 1250 | 1251 | 1252 | 1253 | 1254 | 1255 | 1256 | 1257 | 1258 | 1259 | 1260 | 1261 | 1262 | 1263 | 1264 | 1265 | 1266 | 1267 | 1268 | 1269 | 1270 | 1271 | 1272 | 1273 | 1274 | 1275 | 1276 | 1277 | 1278 | 1279 | 1280 | 1281 | 1282 | 1283 | 1284 | 1285 | 1286 | 1287 | 1288 | 1289 | 1290 | 1291 | 1292 | 1293 | 1294 | 1295 | 1296 | 1297 | 1298 | 1299 | 1300 | 1301 | 1302 | 1303 | 1304 | 1305 | 1306 | 1307 | 1308 | 1309 | 1310 | 1311 | 1312 | 1313 | 1314 | 1315 | 1316 | 1317 | 1318 | 1319 | 1320 | 1321 | 1322 | 1323 | 1324 | 1325 | 1326 | 1327 | 1328 | 1329 | 1330 | 1331 | 1332 | 1333 | 1334 | 1335 | 1336 | 1337 | 1338 | 1339 | 1340 | 1341 | 1342 | 1343 | 1344 | 1345 | 1346 | 1347 | 1348 | 1349 | 1350 | 1351 | 1352 | 1353 | 1354 | 1355 | 1356 | 1357 | 1358 | 1359 | 1360 | 1361 | 1362 | 1363 | 1364 | 1365 | 1366 | 1367 | 1368 | 1369 | 1370 | 1371 | 1372 | 1373 | 1374 | 1375 | 1376 | 1377 | 1378 | 1379 | 1380 | 1381 | 1382 | 1383 | 1384 | 1385 | 1386 | 1387 | 1388 | 1389 | 1390 | 1391 | 1392 | 1393 | 1394 | 1395 | 1396 | 1397 | 1398 | 1399 | 1400 | 1401 | 1402 | 1403 | 1404 | 1405 | 1406 | 1407 | 1408 | 1409 | 1410 | 1411 | 1412 | 1413 | 1414 | 1415 | 1416 | 1417 | 1418 | 1419 | 1420 | 1421 | 1422 | 1423 | 1424 | 1425 | 1426 | 1427 | 1428 | 1429 | 1430 | 1431 | 1432 | 1433 | 1434 | 1435 | 1436 | 1437 | 1438 | 1439 | 1440 | 1441 | 1442 |
Name of column 1Name of column 2Name of column 3
Top leftTop middle 
2  
3  
4  
5  
6  
7  
8  
9  
10  
11  
12  
13  
14  
15 Right
16  
17  
18  
19  
20  
21  
22  
23  
24  
25  
26  
27  
28  
29  
Bottom leftBottom middle 
1443 |
1444 |
1445 | 1446 |
1447 |

Table placement

1448 |
1449 |
1450 | 
#+ATTR_LATEX: :center nil
1451 | | a | b |
1452 | | 1 | 2 |
1453 |
1454 |
1455 | 1456 | 1457 | 1458 | 1459 | 1460 | 1461 | 1462 | 1463 | 1464 | 1465 | 1466 | 1467 | 1468 | 1469 | 1470 | 1471 | 1472 | 1473 | 1474 | 1475 |
ab
12
1476 | 1477 |

1478 | XXX Different from the following: 1479 |

1480 | 1481 |
1482 | 
| a | b |
1483 | | 1 | 2 |
1484 |
1485 |
1486 | 1487 | 1488 | 1489 | 1490 | 1491 | 1492 | 1493 | 1494 | 1495 | 1496 | 1497 | 1498 | 1499 | 1500 | 1501 | 1502 | 1503 | 1504 | 1505 | 1506 |
ab
12
1507 |
1508 |
1509 | 1510 |
1511 |

Align tables on the page

1512 |
1513 |
1514 |
1515 |

Left

1516 |
1517 |

1518 | Here is a table on the left side: 1519 |

1520 | 1521 |
1522 | 
#+LATEX: \noindent
1523 | #+ATTR_LATEX: :center nil
1524 | | a | b | c |
1525 | |---+---+---|
1526 | | 1 | 2 | 3 |
1527 | | 4 | 5 | 6 |
1528 | #+LATEX: \hfill
1529 |
1530 |
1531 | 1532 | 1533 | 1534 | 1535 | 1536 | 1537 | 1538 | 1539 | 1540 | 1541 | 1542 | 1543 | 1544 | 1545 | 1546 | 1547 | 1548 | 1549 | 1550 | 1551 | 1552 | 1553 | 1554 | 1555 | 1556 | 1557 | 1558 | 1559 | 1560 | 1561 | 1562 |
abc
123
456
1563 |

1564 | The noindent just gets rid of the indentation of the first line of a paragraph 1565 | which in this case is the table. The hfill adds infinite stretch after the 1566 | table, so it pushes the table to the left. 1567 |

1568 |
1569 |
1570 | 1571 |
1572 |

Center

1573 |
1574 |

1575 | Here is a centered table: 1576 |

1577 | 1578 |
1579 | 
| a | b | c |
1580 | |---+---+---|
1581 | | 1 | 2 | 3 |
1582 | | 4 | 5 | 6 |
1583 |
1584 |
1585 | 1586 | 1587 | 1588 | 1589 | 1590 | 1591 | 1592 | 1593 | 1594 | 1595 | 1596 | 1597 | 1598 | 1599 | 1600 | 1601 | 1602 | 1603 | 1604 | 1605 | 1606 | 1607 | 1608 | 1609 | 1610 | 1611 | 1612 | 1613 | 1614 | 1615 | 1616 |
abc
123
456
1617 |
1618 |
1619 | 1620 |
1621 |

Right

1622 |
1623 |

1624 | And here’s a table on the right side: 1625 |

1626 | 1627 |
1628 | 
#+LATEX: \hfill
1629 | #+ATTR_LATEX: :center nil
1630 | | a | b | c |
1631 | |---+---+---|
1632 | | 1 | 2 | 3 |
1633 | | 4 | 5 | 6 |
1634 |
1635 |
1636 | 1637 | 1638 | 1639 | 1640 | 1641 | 1642 | 1643 | 1644 | 1645 | 1646 | 1647 | 1648 | 1649 | 1650 | 1651 | 1652 | 1653 | 1654 | 1655 | 1656 | 1657 | 1658 | 1659 | 1660 | 1661 | 1662 | 1663 | 1664 | 1665 | 1666 | 1667 |
abc
123
456
1668 | 1669 |

1670 | Here the hfill adds infinite stretch before the table, so it pushes the table 1671 | to the right. 1672 |

1673 |
1674 |
1675 |
1676 | 1677 |
1678 |

Table size

1679 |
1680 |
1681 | 
#+ATTR_HTML: :width 100%
1682 | | Cell in column 1, row 1 | Cell in column 2, row 1 |
1683 | | Cell in column 1, row 2 | Cell in column 2, row 2 |
1684 |
1685 |
1686 | 1687 | 1688 | 1689 | 1690 | 1691 | 1692 | 1693 | 1694 | 1695 | 1696 | 1697 | 1698 | 1699 | 1700 | 1701 | 1702 | 1703 | 1704 | 1705 | 1706 |
Cell in column 1, row 1Cell in column 2, row 1
Cell in column 1, row 2Cell in column 2, row 2
1707 |
1708 |
1709 | 1710 |
1711 |

CSV

1712 |
1713 |

1714 | You can fill a table from a CSV file using R commands. 1715 |

1716 |
1717 |
1718 |
1719 | 1720 | 1894 | 1895 |
1896 |

Images

1897 |
1898 |

1899 | You can insert image files of different formats to a document: 1900 |

1901 | 1902 | 1903 | 1904 | 1905 | 1906 | 1907 | 1908 | 1909 | 1910 | 1911 | 1912 | 1913 | 1914 | 1915 | 1916 | 1917 | 1918 | 1919 | 1920 | 1921 | 1922 | 1923 | 1924 | 1925 | 1926 | 1927 | 1928 | 1929 | 1930 | 1931 | 1932 | 1933 | 1934 | 1935 | 1936 | 1937 | 1938 | 1939 | 1940 | 1941 | 1942 | 1943 | 1944 |
 HTMLPDF
gifyes 
jpegyes 
pngyes 
bmp(depends on browser support) 
1945 |
1946 | 1947 |
1948 |

Inline picture

1949 |
1950 |
1951 | 
#+caption: Org mode logo
1952 | file:images/org-mode-unicorn.png
1953 |
1954 |
1955 | 1956 | 1957 |
1958 |

org-mode-unicorn.png 1959 |

1960 |

Figure 2: Org mode logo

1961 |
1962 | 1963 |
1964 | 
Click to see the Unicorn picture.
1965 |
1966 |
1967 | 1968 |

1969 | Click to see the Unicorn picture. 1970 |

1971 |
1972 |
1973 | 1974 |
1975 |

Image alignment (using positioning)

1976 |
1977 |

1978 | Books usually align/float images on the right/left of the contents. 1979 |

1980 |
1981 | 1982 |
1983 |

Image is left aligned

1984 |
1985 | 1986 |
1987 |

Image is right aligned

1988 |
1989 | 1990 |
1991 |

Image is centered

1992 |
1993 |
1994 |
1995 |
1996 | 1997 |
1998 |

Image attributes and values

1999 |
2000 |

2001 | XXX Available HTML image tags include … 2002 |

2003 | 2004 | 2005 | 2006 | 2007 | 2008 | 2009 | 2010 | 2011 | 2012 | 2013 | 2014 | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | 2026 | 2027 | 2028 | 2029 | 2030 | 2031 | 2032 | 2033 | 2034 | 2035 | 2036 | 2037 | 2038 | 2039 | 2040 | 2041 | 2042 | 2043 | 2044 | 2045 | 2046 | 2047 | 2048 | 2049 | 2050 | 2051 | 2052 | 2053 | 2054 | 2055 | 2056 | 2057 | 2058 | 2059 | 2060 | 2061 | 2062 | 2063 | 2064 |
AttributeValue(s)
:altAlternate text
:height 
:widthUser defined size in pixels
:align 
:border 
:bordercolor 
:hspace 
:vspace 
:titleUser defined text
2065 | 2066 |
2067 | 
#+ATTR_LaTeX: :width 0.25\linewidth
2068 | file:images/org-mode-unicorn.png
2069 |
2070 |
2071 | 2072 | 2073 |
2074 |

org-mode-unicorn.png 2075 |

2076 |
2077 | 2078 |

2079 | Place images side by side: XXX 2080 |

2081 |
2082 |
2083 | 2084 |
2085 |

Figures

2086 |
2087 |

2088 | To define images that will be treated as book illustrations (figures) and 2089 | automatically labeled and numbered, use XXX. 2090 |

2091 |
2092 |
2093 |
2094 | 2095 |
2096 |

Videos

2097 |
2098 |

2099 | Videos can’t be added directly. 2100 |

2101 | 2102 |

2103 | Though, you can add an image with a link to the video like this: 2104 |

2105 | 2106 |
2107 | 
file:../bigblow.png
2108 |
2109 |
2110 | 2111 | 2112 |
2113 |

bigblow.png 2114 |

2115 |
2116 |
2117 |
2118 | 2119 |
2120 |

Admonitions

2121 |
2122 |

2123 | Admonitions (contextual backgrounds) are statements taken out of the content’s 2124 | flow and labeled with a title. 2125 |

2126 | 2127 |

2128 | Common admonitions are: 2129 |

2130 | 2131 |
    2132 |
  1. note
    2. 2133 |
  2. warning
    3. 2134 |
  3. tip
    4. 2135 |
  4. caution
    5. 2136 |
  5. important
    6. 2137 |
2138 | 2139 |

2140 | (Most themes style only note and warning specially.) 2141 |

2142 |
2143 | 2144 |
2145 |

Base admonitions

2146 |
2147 |
2148 |
2149 |

Note

2150 |
2151 |

2152 | A note box is displayed as follows: 2153 |

2154 | 2155 |
2156 | 
#+begin_note
2157 | This is a useful note.
2158 | #+end_note
2159 |
2160 |
2161 | 2162 |
2163 |

2164 | This is a useful note. 2165 |

2166 | 2167 |
2168 |
2169 |
2170 | 2171 |
2172 |

Warning

2173 |
2174 |

2175 | A warning box is displayed as follows: 2176 |

2177 | 2178 |
2179 | 
#+begin_warning
2180 | Be careful!  Check that you have...
2181 | #+end_warning
2182 |
2183 |
2184 | 2185 |
2186 |

2187 | Be careful! Check that you have… 2188 |

2189 | 2190 |
2191 |
2192 |
2193 | 2194 |
2195 |

Tip

2196 |
2197 |

2198 | A tip box is displayed as follows: 2199 |

2200 | 2201 |
2202 | 
#+begin_tip
2203 | Try doing it this way...
2204 | #+end_tip
2205 |
2206 |
2207 | 2208 |
2209 |

2210 | Try doing it this way… 2211 |

2212 | 2213 |
2214 |
2215 |
2216 | 2217 |
2218 |

Caution

2219 |
2220 |
2221 | 
#+begin_caution
2222 | Caution
2223 | #+end_caution
2224 |
2225 |
2226 | 2227 |
2228 |

2229 | Caution 2230 |

2231 | 2232 |
2233 |
2234 |
2235 | 2236 |
2237 |

Important

2238 |
2239 |
2240 | 
#+begin_important
2241 | Important
2242 | #+end_important
2243 |
2244 |
2245 | 2246 |
2247 |

2248 | Important 2249 |

2250 | 2251 |
2252 |
2253 |
2254 |
2255 | 2256 |
2257 |

Additional admonitions

2258 |
2259 |
2260 |
2261 |

Attention

2262 |
2263 |
2264 | 
#+begin_attention
2265 | Attention
2266 | #+end_attention
2267 |
2268 |
2269 | 2270 |
2271 |

2272 | Attention 2273 |

2274 | 2275 |
2276 |
2277 |
2278 | 2279 |
2280 |

Hint

2281 |
2282 |
2283 | 
#+begin_hint
2284 | Hint
2285 | #+end_hint
2286 |
2287 |
2288 | 2289 |
2290 |

2291 | Hint 2292 |

2293 | 2294 |
2295 |
2296 |
2297 | 2298 |
2299 |

Error

2300 |
2301 |
2302 | 
#+begin_error
2303 | Error
2304 | #+end_error
2305 |
2306 |
2307 | 2308 |
2309 |

2310 | Error 2311 |

2312 | 2313 |
2314 |
2315 |
2316 | 2317 |
2318 |

Danger

2319 |
2320 |
2321 | 
#+begin_danger
2322 | Danger
2323 | #+end_danger
2324 |
2325 |
2326 | 2327 |
2328 |

2329 | Danger 2330 |

2331 | 2332 |
2333 |
2334 |
2335 | 2336 |
2337 |

SeeAlso (Sphinx additional)

2338 |
2339 |
2340 | 
#+begin_seealso
2341 | - Apples ::
2342 |      A kind of fruit.
2343 | #+end_seealso
2344 |
2345 |
2346 | 2347 |
2348 |
2349 |
Apples
A kind of fruit.
2350 |
2351 | 2352 |
2353 |
2354 |
2355 |
2356 | 2357 |
2358 |

Todo admonition

2359 |
2360 |

2361 | Simple box (“inline task”): 2362 |

2363 | 2364 |
2365 | 
*************** TODO Do this task
2366 | Description of inline task.
2367 | *************** END
2368 |
2369 |
2370 | 2371 |

2372 | * TODO Do this task 2373 | Description of inline task. 2374 |

2375 |
2376 | END
2377 | nil
2378 | 2379 |
2380 | TODO Do this task
2381 |

2382 | Description of inline task. 2383 |

2384 |
2385 |

2386 | or: 2387 |

2388 | 2389 |
2390 | 
*************** WAIT [#B] Do also this other task                        :phone:
2391 | *************** END
2392 |
2393 |
2394 | 2395 |

2396 | * WAIT [#B] Do also this other task :phone: 2397 |

2398 |
2399 | END
2400 | nil
2401 | 2402 |
2403 |

2404 | Admonitiontodo 2405 |

2406 | 2407 |
2408 | 2409 |

2410 | Alternatively to the inline tasks (for creating “TODO” annotations), if you want 2411 | such notes not to show up in the published version, drawers may also do the job, 2412 | e.g.: 2413 |

2414 | 2415 |

2416 | … 2417 |

2418 | 2419 |

2420 | You can then control what drawers are exported with 2421 | org-export-with-drawers (or per document with d OPTIONS item). 2422 |

2423 |
2424 |
2425 |
2426 | 2427 |
2428 |

Centered text

2429 |
2430 |
2431 | 
#+begin_left
2432 | This text is \\
2433 | aligned to the left!
2434 | #+end_left
2435 | 
2436 | #+begin_center
2437 | This text is \\
2438 | centered!
2439 | #+end_center
2440 | 
2441 | #+begin_right
2442 | This text is \\
2443 | aligned to the right!
2444 | #+end_right
2445 |
2446 |
2447 | 2448 |
2449 |

2450 | This text is
2451 | aligned to the left! 2452 |

2453 | 2454 |
2455 | 2456 |
2457 |

2458 | This text is
2459 | centered! 2460 |

2461 |
2462 | 2463 |
2464 |

2465 | This text is
2466 | aligned to the right! 2467 |

2468 | 2469 |
2470 |
2471 |
2472 | 2473 |
2474 |

Sidebar

2475 |
2476 |
2477 | 
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
2478 | tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
2479 | quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
2480 | consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
2481 | cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
2482 | proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
2483 | 
2484 | #+begin_sidebar
2485 | Org mode was first released by Carsten Dominik in 2004 as an outlining and
2486 | project planning tool.  Further development turned it into a general tool that
2487 | can be used to author professional documents like LaTeX.
2488 | #+end_sidebar
2489 | 
2490 | Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac
2491 | turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor
2492 | sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies
2493 | mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien
2494 | ullamcorper pharetra. Vestibulum erat wisi...
2495 | 
2496 | Phasellus ut libero. Nulla in libero non enim tristique sollicitudin. Ut
2497 | tempor. Phasellus pellentesque augue eget ante. Mauris malesuada. Donec sit
2498 | amet diam sit amet dolor placerat blandit. Morbi enim purus, imperdiet in,
2499 | molestie sit amet, pellentesque eu, mauris. In vel erat vel ipsum bibendum
2500 | commodo. Curabitur accumsan. Nam sed metus. Etiam tristique bibendum justo.
2501 |
2502 |
2503 | 2504 |

2505 | Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod 2506 | tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, 2507 | quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 2508 | consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse 2509 | cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non 2510 | proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 2511 |

2512 | 2513 | 2521 | 2522 |

2523 | Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac 2524 | turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor 2525 | sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies 2526 | mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien 2527 | ullamcorper pharetra. Vestibulum erat wisi… 2528 |

2529 | 2530 |

2531 | Phasellus ut libero. Nulla in libero non enim tristique sollicitudin. Ut 2532 | tempor. Phasellus pellentesque augue eget ante. Mauris malesuada. Donec sit 2533 | amet diam sit amet dolor placerat blandit. Morbi enim purus, imperdiet in, 2534 | molestie sit amet, pellentesque eu, mauris. In vel erat vel ipsum bibendum 2535 | commodo. Curabitur accumsan. Nam sed metus. Etiam tristique bibendum justo. 2536 |

2537 |
2538 |
2539 | 2540 |
2541 |

Example

2542 |
2543 |

2544 | You can have example blocks. 2545 |

2546 | 2547 |
2548 | 
: 10/17/97   9:04         <DIR>    bin
2549 | : 10/16/97  14:11         <DIR>    DOS
2550 | : 10/16/97  14:46         <DIR>    TEMP
2551 | : 10/16/97  14:37         <DIR>    WINNT
2552 | : 10/16/97  14:25             119  AUTOEXEC.BAT
2553 | :  2/13/94   6:21          54,619  COMMAND.COM
2554 |
2555 |
2556 | 2557 | 
2558 | 10/17/97   9:04         <DIR>    bin
2559 | 10/16/97  14:11         <DIR>    DOS
2560 | 10/16/97  14:46         <DIR>    TEMP
2561 | 10/16/97  14:37         <DIR>    WINNT
2562 | 10/16/97  14:25             119  AUTOEXEC.BAT
2563 |  2/13/94   6:21          54,619  COMMAND.COM
2564 |
2565 | 2566 | 2567 |

2568 | or 2569 |

2570 | 2571 |
2572 | 
#+begin_example
2573 | 10/17/97   9:04         <DIR>    bin
2574 | 10/16/97  14:11         <DIR>    DOS
2575 | 10/16/97  14:46         <DIR>    TEMP
2576 | 10/16/97  14:37         <DIR>    WINNT
2577 | 10/16/97  14:25             119  AUTOEXEC.BAT
2578 |  2/13/94   6:21          54,619  COMMAND.COM
2579 | #+end_example
2580 |
2581 |
2582 | 2583 | 
2584 | 10/17/97   9:04         <DIR>    bin
2585 | 10/16/97  14:11         <DIR>    DOS
2586 | 10/16/97  14:46         <DIR>    TEMP
2587 | 10/16/97  14:37         <DIR>    WINNT
2588 | 10/16/97  14:25             119  AUTOEXEC.BAT
2589 |  2/13/94   6:21          54,619  COMMAND.COM
2590 |
2591 |
2592 |
2593 | 2594 |
2595 |

Prose excerpts

2596 |
2597 |
2598 |
2599 |

Quote

2600 |
2601 |

2602 | Use the quote block for content that doesn’t require the preservation of line 2603 | breaks. 2604 |

2605 | 2606 |
2607 | 
#+begin_quote
2608 | Let us change our traditional attitude to the construction of programs:
2609 | Instead of imagining that our main task is to instruct a computer what to do,
2610 | let us concentrate rather on explaining to human beings what we want a
2611 | computer to do.
2612 | 
2613 | The practitioner of literate programming can be regarded as an essayist, whose
2614 | main concern is with exposition and excellence of style. Such an author, with
2615 | thesaurus in hand, chooses the names of variables carefully and explains what
2616 | each variable means. He or she strives for a program that is comprehensible
2617 | because its concepts have been introduced in an order that is best for human
2618 | understanding, using a mixture of formal and informal methods that reinforce
2619 | each other.
2620 | 
2621 | -- Donald Knuth
2622 | #+end_quote
2623 |
2624 |
2625 | 2626 |
2627 |

2628 | Let us change our traditional attitude to the construction of programs: 2629 | Instead of imagining that our main task is to instruct a computer what to do, 2630 | let us concentrate rather on explaining to human beings what we want a 2631 | computer to do. 2632 |

2633 | 2634 |

2635 | The practitioner of literate programming can be regarded as an essayist, whose 2636 | main concern is with exposition and excellence of style. Such an author, with 2637 | thesaurus in hand, chooses the names of variables carefully and explains what 2638 | each variable means. He or she strives for a program that is comprehensible 2639 | because its concepts have been introduced in an order that is best for human 2640 | understanding, using a mixture of formal and informal methods that reinforce 2641 | each other. 2642 |

2643 | 2644 |

2645 | – Donald Knuth 2646 |

2647 |
2648 | 2649 |

2650 | A short one: 2651 |

2652 | 2653 |
2654 | 
#+begin_quote
2655 | Everything should be made as simple as possible,
2656 | but not any simpler. -- Albert Einstein
2657 | #+end_quote
2658 |
2659 |
2660 | 2661 |
2662 |

2663 | Everything should be made as simple as possible, 2664 | but not any simpler. – Albert Einstein 2665 |

2666 |
2667 |
2668 |
2669 | 2670 |
2671 |

Verse

2672 |
2673 |

2674 | In a verse environment, there is an implicit line break at the end of each line, 2675 | and indentation is preserved: 2676 |

2677 | 2678 |
2679 | 
#+begin_verse
2680 | Everything should be made as simple as possible,
2681 | but not any simpler. -- Albert Einstein
2682 | #+end_verse
2683 |
2684 |
2685 | 2686 |

2687 | Everything should be made as simple as possible,
2688 | but not any simpler. – Albert Einstein
2689 |

2690 | 2691 |

2692 | Typically used for quoting passages of an email message: 2693 |

2694 | 2695 |
2696 | 
#+begin_verse
2697 | >>  The meeting has been postponed to next Friday.
2698 | >
2699 | > Has the deadline for the report been moved too?
2700 | 
2701 | Yes.  And chekout http://www.doodle.com/ for rescheduling the meeting.
2702 | 
2703 | In the text body,
2704 |    indentation is
2705 | preserved.
2706 | #+end_verse
2707 |
2708 |
2709 | 2710 |

2711 | >> The meeting has been postponed to next Friday.
2712 | >
2713 | > Has the deadline for the report been moved too?
2714 |
2715 | Yes. And chekout http://www.doodle.com/ for rescheduling the meeting.
2716 |
2717 | In the text body,
2718 |    indentation is
2719 | preserved.
2720 |

2721 |
2722 |
2723 | 2724 |
2725 |

Block quote with optional attribution line

2726 |
2727 |
2728 |

2729 | epigraph 2730 |

2731 | 2732 |
2733 |
2734 |
2735 | 2736 |
2737 |

Block quotes with their own class attribute

2738 |
2739 |
2740 |

2741 | highlights 2742 |

2743 | 2744 |
2745 | 2746 |
2747 |

2748 | pull-quote 2749 |

2750 | 2751 |
2752 | 2753 |
2754 |

2755 | Blockquote 2756 |

2757 | 2758 |
2759 |
2760 |
2761 | 2762 |
2763 |

Non-breaking space

2764 |
2765 |

2766 | Insert the Unicode character 00A0 to add a non-breaking space. 2767 |

2768 | 2769 |

2770 | FIXME Or add/use an Org entity? Or use tilde? 2771 |

2772 |
2773 |
2774 |
2775 | 2776 |
2777 |

Comments

2778 |
2779 |
2780 | 
It's possible to add comments in the document.
2781 | 
2782 | # This Org comment here won't be displayed.
2783 |
2784 |
2785 | 2786 |

2787 | It’s possible to add comments in the document. 2788 |

2789 | 2790 |
2791 |

2792 | Org doesn’t support comments inside paragraphs since a comment ends 2793 | a paragraph. However, you can mimic inline comments with export snippets, e.g., 2794 | @@comment:...@@. 2795 |

2796 | 2797 |
2798 | 2799 |
2800 |

2801 | If you have tables (for example) that you want to ignore during export, one possibility 2802 | is to use comment blocks or :noexport: subtrees. Another possibility is to 2803 | use non-exported drawers (see #+OPTIONS: d:). 2804 |

2805 | 2806 |
2807 | 2808 |

2809 | If you want to ignore that part only during export, but still want to 2810 | use keep it active in the buffer, I suggest to use a drawer, with an 2811 | appropriate `org-export-with-drawers’ value, e.g., 2812 |

2813 | 2814 |
2815 | 
#+OPTIONS: d:(not "NOEXPORT")
2816 |
2817 |
2818 |
2819 |
2820 | 2821 |
2822 |

Substitutions

2823 |
2824 |
2825 |
2826 |

General replacements

2827 |
2828 |
2829 | 
#+MACRO: longtext this very very long text
2830 | 
2831 | Insert longtext wherever required.
2832 |
2833 |
2834 | 2835 |

2836 | Insert this very very long text wherever required. 2837 |

2838 |
2839 |
2840 | 2841 |
2842 |

Styled references

2843 |
2844 |
2845 | 
#+MACRO: color @@html:<span style="color: $1">$2</span>@@
2846 | 
2847 | color(blue, This text is colored in blue.)
2848 | 
2849 | color(red, This other text is in red.)
2850 |
2851 |
2852 | 2853 |

2854 | This text is colored in blue. 2855 |

2856 | 2857 |

2858 | This other text is in red. 2859 |

2860 | 2861 |

2862 | Find more macros on GitHub. 2863 |

2864 |
2865 |
2866 | 2867 |
2868 |

Special characters

2869 |
2870 |

2871 | We also use substitutions to include some of the widely used Unicode characters 2872 | (like ©, converted from text characters to its typographically correct entity). 2873 |

2874 |
2875 | 2876 |
2877 |

Accents

2878 |
2879 |
2880 | 
- \Agrave \Aacute
2881 |
2882 |
2883 | 2884 |
    2885 |
  • À Á
    • 2886 |
2887 |
2888 |
2889 | 2890 |
2891 |

Punctuation

2892 |
2893 |
2894 | 
- Dash: \ndash \mdash
2895 | - Marks: \iexcl \iquest
2896 | - Quotations: \laquo \raquo
2897 | - Miscellaneous: \para \ordf
2898 |
2899 |
2900 | 2901 |
    2902 |
  • Dash: – —
    • 2903 |
  • Marks: ¡ ¿
    • 2904 |
  • Quotations: « »
    • 2905 |
  • Miscellaneous: ¶ ª
    • 2906 |
2907 |
2908 |
2909 | 2910 |
2911 |

Commercial symbols

2912 |
2913 |
2914 | 
- Property marks: \copy \reg
2915 | - Currency: \cent \EUR \yen \pound
2916 |
2917 |
2918 | 2919 |
    2920 |
  • Property marks: © ®
    • 2921 |
  • Currency: ¢ € ¥ £
    • 2922 |
2923 |
2924 |
2925 | 2926 |
2927 |

Greek characters

2928 |
2929 |
2930 | 
The Greek letters \alpha, \beta, and \gamma are used to denote angles.
2931 |
2932 |
2933 | 2934 |

2935 | The Greek letters α, β, and γ are used to denote angles. 2936 |

2937 |
2938 |
2939 | 2940 |
2941 |

Math characters

2942 |
2943 |
2944 | 
- Science: \pm \div
2945 | - Arrows: \to \rarr \larr \harr \rArr \lArr \hArr
2946 | - Function names: \arccos \cos
2947 | - Signs and symbols: \bull \star
2948 |
2949 |
2950 | 2951 |
    2952 |
  • Science: ± ÷
    • 2953 |
  • Arrows: → → ← ↔ ⇒ ⇐ ⇔
    • 2954 |
  • Function names: arccos cos
    • 2955 |
  • Signs and symbols: • *
    • 2956 |
2957 |
2958 |
2959 | 2960 |
2961 |

Misc

2962 |
2963 |
2964 | 
- Zero-width non-joiner: \zwnj
2965 | # Smilies: \smiley \sad
2966 | - Suits: \clubs \spades
2967 |
2968 |
2969 | 2970 |
    2971 |
  • Zero-width non-joiner: ‌
    • 2972 |
2973 | 2974 |
    2975 |
  • Suits: ♣ ♠
    • 2976 |
2977 | 2978 |
2979 |

2980 | You can insert a real “zero-width space” Unicode character by pressing 2981 | C-x 8 RET zero width space RET or C-x 8 RET 200b RET. 2982 |

2983 | 2984 |
2985 |
2986 |
2987 |
2988 |
2989 | 2990 |
2991 |

Source code

2992 |
2993 |
2994 |
2995 |

Inline code

2996 |
2997 |
2998 | 
Reference code like variables or functions inline.
2999 |
3000 |
3001 | 3002 |

3003 | Reference code like variables or functions inline. 3004 |

3005 | 3006 |

3007 | You can also evaluate code inline as follows: 1 + 1 is 1 + 1 2. 3008 |

3009 |
3010 |
3011 | 3012 |
3013 |

Code blocks (with syntax highlighting)

3014 |
3015 |

3016 | The source code blocks support syntax highlighting: 3017 |

3018 | 3019 |
3020 | 
/*
3021 |  * Application that displays a "Hello" message to the standard output.
3022 |  */
3023 | int main(int arc, char **argv)
3024 | {
3025 |   printf("Hello, %s!\n", (argc>1) ? argv[1] : "World");
3026 |   return 0;
3027 | }
3028 |
3029 |
3030 | 3031 |
3032 | 
(defvar hello "Hello")
3033 | 
3034 | (defun hello (name &optional greeting)
3035 |   (message "%s %s" (or greeting "Hello") name))
3036 | 
3037 | (setq tab-width 4)
3038 |
3039 |
3040 | 3041 |
3042 |

3043 | You need htmlize.el in your load-path, for the HTML export. 3044 |

3045 | 3046 |
3047 |
3048 |
3049 | 3050 |
3051 |

Source mode

3052 |
3053 |

3054 | The following language strings are currently recognized: 3055 |

3056 | 3057 |

3058 | Awk, C, D, C++, and cpp, R, Calc, Clojure and ClojureScript, CSS, Ditaa, Dot, Emacs Lisp, Eshell, Forth, Fortran, GnuPlot, Groovy, Haskell, Java, JavaScript, Julia, LaTeX, LilyPond, Lisp, Lua, Makefile, Maxima, OCaml, Octave and MatLab, Org, Perl, Processing, PlantUML, Python, Ruby, Sass, Scheme, Screen, Sed, Shell Script, Sql, Sqlite. 3059 |

3060 |
3061 |
3062 | 3063 |
3064 |

Line break

3065 |
3066 |

3067 | Code block with long lines: 3068 |

3069 | 3070 |
3071 | 
testing testing testing testing testing testing testing testing testing testing
3072 | 0        1         2         3         4         5         6         7         8         9
3073 | 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456
3074 |
3075 |
3076 | 3077 |

3078 | For PDF (LaTeX), one solution is to surround the code block such as: 3079 |

3080 | 3081 |
3082 | 
print("This block is in scriptsize")
3083 |
3084 |
3085 | 3086 | 
3087 | This block is in scriptsize
3088 |
3089 |
3090 |
3091 | 3092 |
3093 |

Line numbers

3094 |
3095 |

3096 | Both in example and in src snippets, you can add a -n switch to the end of the 3097 | begin line to get the lines numbered: 3098 |

3099 | 3100 |
3101 | 
1: (defun org-xor (a b)
3102 | 2:   "Exclusive or."
3103 |
3104 |
3105 | 3106 |

3107 | If you use a +n switch, the numbering from the previous numbered snippet will 3108 | be continued in the current one: 3109 |

3110 | 3111 |
3112 | 
3:   (if a (not b) b))
3113 |
3114 |
3115 |
3116 |
3117 | 3118 |
3119 |

Callouts

3120 |
3121 |

3122 | In literal examples, Org will interpret strings like (ref:name) as labels, and 3123 | use them as targets for special hyperlinks like [[(name)]] (i.e., the reference 3124 | name enclosed in single parenthesis). In HTML, hovering the mouse over such 3125 | a link will remote-highlight the corresponding code line, which is kind of 3126 | cool. 3127 |

3128 | 3129 |

3130 | You can also add a -r switch which removes the labels from the source code. 3131 | With the -n switch, links to these references will be labeled by the line 3132 | numbers from the code listing, otherwise links will use the labels with no 3133 | parentheses. Here is an example: 3134 |

3135 | 3136 |
3137 | 
1: (save-excursion                  ;
3138 | 2:   (goto-char (point-min)))       ;
3139 |
3140 |
3141 | 3142 |

3143 | In line 1, we remember the current position. Line 2 jumps to 3144 | point-min. 3145 |

3146 |
3147 |
3148 |
3149 | 3150 |
3151 |

Math

3152 |
3153 |

3154 | You can embed LaTeX math formatting in Org mode files. 3155 |

3156 |
3157 | 3158 |
3159 |

Inline math expressions

3160 |
3161 |

3162 | For inline math expressions, use the parentheses notation \(...\): 3163 |

3164 | 3165 |
3166 | 
The formula \(a^2 + b^2 = c^2\) has been discovered by Pythagoras.
3167 | 
3168 | Let \(a=\sin(x) + \cos(x)\). Then \(a^2 = 2\sin(x)\cos(x)\) because \(\sin^2x +
3169 | \cos^2x = 1\).
3170 |
3171 |
3172 | 3173 |

3174 | The formula \(a^2 + b^2 = c^2\) has been discovered by Pythagoras. 3175 |

3176 | 3177 |

3178 | Let \(a=\sin(x) + \cos(x)\). Then \(a^2 = 2\sin(x)\cos(x)\) because \(\sin^2x + 3179 | \cos^2x = 1\). 3180 |

3181 | 3182 |
3183 |

3184 | It’s not advised to use the $...$ construct (both for Org and for MathJax). 3185 |

3186 | 3187 |

3188 | Don’t forget that $ is also a valid currency symbol! 3189 |

3190 | 3191 |
3192 |
3193 |
3194 | 3195 |
3196 |

Math expressions in display mode

3197 |
3198 |

3199 | For mathematical expressions which you want to make stand out, centered on their 3200 | own lines, use \[...\]: 3201 |

3202 | 3203 |
3204 | 
The Euler theorem:
3205 | 
3206 | \[
3207 | \int_0^\infty e-x^2 dx = {{\sqrt{\pi}} \over {2}}
3208 | \]
3209 | 
3210 | LaTeX allows to inline such \[...\] constructs (quadratic formula):
3211 | \[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \]
3212 |
3213 |
3214 | 3215 |

3216 | The Euler theorem: 3217 |

3218 | 3219 |

3220 | \[ 3221 | \int_0^\infty e^{-x^2} dx = {{\sqrt{\pi}} \over {2}} 3222 | \] 3223 |

3224 | 3225 |

3226 | LaTeX allows to inline such \[...\] constructs (quadratic formula): 3227 | \[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \] 3228 |

3229 | 3230 |
3231 |

3232 | Double dollar signs ($$) should not be used. 3233 |

3234 | 3235 |
3236 | 3237 |
3238 | 
\[
3239 | \left( \int0\infty \frac{\sin x}{\sqrt x}\,\mathrm{d}x \
3240 | right)2 -
3241 | \prodk=1\infty \frac{4k2}{4k2-1} +
3242 | \frac{\lambda}{2n}\sumk=1 ^{n} \thetak ^{2} xn = 0
3243 | \]
3244 |
3245 |
3246 | 3247 |

3248 | \[ 3249 | \left( \int_{0}^{\infty} \frac{\sin x}{\sqrt x}\,\mathrm{d}x \ 3250 | right)^{2} - 3251 | \prod_{k=1}^{\infty} \frac{4k^{2}}{4k^{2}-1} + 3252 | \frac{\lambda}{2n}\sum_{k=1} ^{n} \theta_{k} ^{2} x^{n} = 0 3253 | \] 3254 |

3255 | 3256 |

3257 | The equation may be wrong, but it’s a nice one! 3258 |

3259 |
3260 |
3261 | 3262 |
3263 |

Equation numbers

3264 |
3265 |

3266 | Differently from $...$ and \(...\), an equation environment produces a numbered 3267 | equation to which you can add a label and reference the equation by (label) name 3268 | in other parts of the text. This is not possibly with unnumbered math 3269 | environments ($$, …). 3270 |

3271 | 3272 |
3273 | 
The Pythagoras theorem:
3274 | 
3275 | #+name: pythag
3276 | \begin{equation}
3277 | a^2 + b^2 = c^2
3278 | \end{equation}
3279 | 
3280 | See equation pythag.
3281 | 
3282 | # The /sinus theorem/ can be written as the equation:
3283 | #
3284 | # \begin{equation}
3285 | # \label{eqn:sinalpha}
3286 | # \frac{\sin\alpha}{a}=\frac{\sin\beta}{b}
3287 | # \end{equation}
3288 | #
3289 | # See equation eqn:sinalpha.
3290 |
3291 |
3292 | 3293 |

3294 | The Pythagoras theorem: 3295 |

3296 | 3297 | \begin{equation} 3298 | \label{orgf69bb91} 3299 | a^2 + b^2 = c^2 3300 | \end{equation} 3301 | 3302 |

3303 | See equation \eqref{orgf69bb91}. 3304 |

3305 | 3306 |

3307 | Only captioned equations are numbered. 3308 |

3309 | 3310 |

3311 | Other alternatives: use 3312 |

3313 |
    3314 |
  • \begin{equation*} or
    • 3315 |
  • \begin{displaymath} (= the verbose form of the \[...\] construct).
    • 3316 |
3317 | 3318 |

3319 | M-q does not fill those. 3320 |

3321 |
3322 |
3323 |
3324 | 3325 |
3326 |

Miscellaneous effects

3327 |
3328 |
3329 |
3330 |

Include Org files

3331 |
3332 |

3333 | You can include another Org file and skip its title by using the :lines argument 3334 | to #+INCLUDE: 3335 |

3336 | 3337 |
3338 | 
#+INCLUDE: "chapter1.org" :lines "2-"
3339 |
3340 |
3341 | 3342 |
3343 |

3344 | File inclusion, through INCLUDE keywords, is an export-only feature. 3345 |

3346 | 3347 |
3348 |
3349 |
3350 | 3351 |
3352 |

Raw HTML

3353 |
3354 |

3355 | You can include raw HTML in your Org documents and it will get kept as HTML 3356 | when it’s exported. 3357 |

3358 | 3359 |

3360 | Text can be preformatted (in a fixed-width font). 3361 |

3362 |

3363 | It is especially useful for more advanced stuff like images or tables where you 3364 | need more control of the HTML options than Org mode actually gives you. 3365 |

3366 | 3367 |

3368 | Similarly, you can incorporate JS or do anything else you can do in a Web page 3369 | (such as importing a CSS file). 3370 |

3371 |
3372 | 3373 |
3374 |

Native DIV blocks

3375 |
3376 |

3377 | You can create named classes (to get style control from your CSS) with: 3378 |

3379 | 3380 | 
3381 | #+begin_myclass
3382 | This text is wrapped in a myclass DIV...
3383 | #+end_myclass
3384 |
3385 | 3386 |

3387 | You can also add interactive elements to the HTML such as interactive R plots. 3388 |

3389 | 3390 |

3391 | Finally, you can include an HTML file verbatim (during export) with: 3392 |

3393 | 3394 |
3395 | 
#+INCLUDE: "file.html" export html
3396 |
3397 |
3398 | 3399 |

3400 | Don’t edit the exported HTML file! 3401 |

3402 |
3403 |
3404 |
3405 | 3406 |
3407 |

Raw LaTeX

3408 |
3409 |

3410 | You can also use raw LaTeX. XXX 3411 |

3412 | 3413 |

3414 | Text can be preformatted (in a fixed-width font). 3415 |

3416 |
3417 |
3418 |
3419 | 3420 |
3421 |

Footnotes 

3422 |
3423 |
3424 | 
It is possible to define named footnotes[fn:myfootnote], or ones with automatic
3425 | anchors[fn:2].
3426 |
3427 |
3428 | 3429 |

3430 | It is possible to define named footnotes1, or ones with automatic 3431 | anchors2. 3432 | It is possible to define named footnotes1, or ones with automatic 3433 | anchors2. 3434 |

3435 |
3436 |
3437 | 3438 |
3439 |

Useful extensions

3440 |
3441 |
3442 |
3443 |

Todo extension

3444 |
3445 |
3446 |
3447 |

Dates

3448 |
3449 |

3450 | Timestamps: [2014-01-16 Thu] and <2014-01-16 Thu>. 3451 |

3452 |
3453 |
3454 | 3455 |
3456 |

TODO We need to achieve…

3457 |
3458 | 3459 |
3460 |

DONE [A] Buy GTD book   online

3461 |
3462 |
    3463 |
  • State “TODO” -> “DONE” [2014-01-16 Thu 09:52]
    • 3464 |
3465 | 3466 |

3467 | By default, DONE actions will be collapsed. 3468 |

3469 | 3470 |

3471 | Note that I should probably implement that default behavior only for ARCHIVE’d 3472 | items. 3473 |

3474 |
3475 |
3476 | 3477 |
3478 |

TODO [A] Read GTD book

3479 |
3480 |

SCHEDULED: <2014-09-11 Thu>

3481 | 3482 |

3483 | By default, all (active) entries will be expanded at page load, so that their 3484 | contents is visible. 3485 |

3486 | 3487 |

3488 | That can be changed by adding such a line (into your Org document): 3489 |

3490 | 3491 |
3492 | 
#+HTML_HEAD: <script> var HS_STARTUP_FOLDED = true; </script>
3493 |
3494 |
3495 |
3496 |
3497 | 3498 |
3499 |

TODO [B] Apply GTD methodoloy

3500 |
3501 |

DEADLINE: <2014-12-01 Mon>

3502 |

3503 | This section will be collapsed when loading the page because the entry has the 3504 | value hsCollapsed for the property :HTML_CONTAINER_CLASS:. 3505 |

3506 | 3507 |

3508 | Powerful, no? 3509 |

3510 |
3511 |
3512 | 3513 |
3514 |

Some note   computer write

3515 |
3516 |

3517 | You can add tags to any entry, and hightlight all entries having some specific 3518 | tag by clicking on the buttons made accessible to you in the “Dashboard”. 3519 |

3520 |
3521 |
3522 | 3523 |
3524 |

Weekly review   computer

3525 |
3526 |

3527 | Now, you can even make your weekly review in the HTML export… Press the r key 3528 | to start entering the “review mode” where all but one active entry are 3529 | collapsed, so that you can really focus on one item at a time! 3530 |

3531 |
3532 |
3533 |
3534 | 3535 |
3536 |

Bigblow extension

3537 |
3538 |

3539 | The string fixme (in upper case) gets replaced by a “Fix Me!” image: 3540 |

3541 | 3542 |
3543 | 
FIXME Delete this...
3544 |
3545 |
3546 | 3547 |

3548 | FIXME Delete this… 3549 |

3550 |
3551 |
3552 |
3553 | 3554 |
3555 |

Graphs with Graphviz

3556 |
3557 |

3558 | To enable the Graphviz extension, we have to add it to the extensions list in 3559 | the org-babel-load-languages variable. 3560 |

3561 | 3562 |
3563 | 
(add-to-list 'org-babel-load-languages '(dot . t))
3564 | (org-babel-do-load-languages 'org-babel-load-languages org-babel-load-languages)
3565 |
3566 |
3567 | 3568 |

3569 | It uses directly the dot command to process DOT language. 3570 |

3571 |
3572 | 3573 |
3574 |

Undirected

3575 |
3576 |
3577 | 
#+begin_src dot :file images/graph.png :cmdline -Tpng
3578 | graph foo {
3579 |         "bar" -- "baz";
3580 | }
3581 | #+end_src
3582 |
3583 |
3584 | 3585 |
3586 | 
graph foo {
3587 |         "bar" -- "baz";
3588 | }
3589 |
3590 |
3591 | 3592 | 3593 |
3594 |

graph.png 3595 |

3596 |
3597 |
3598 |
3599 | 3600 |
3601 |

Directed

3602 |
3603 |
3604 | 
digraph foo {
3605 |         "bar" -> "baz";
3606 | }
3607 |
3608 |
3609 | 3610 | 3611 |
3612 |

digraph.png 3613 |

3614 |
3615 |
3616 |
3617 |
3618 | 3619 |
3620 |

Graphs with R

3621 |
3622 |

3623 | The output from the execution of programs, scripts or commands can be inserted 3624 | in the document itself, allowing you to work in the reproducible research 3625 | mindset. 3626 |

3627 | 3628 |

3629 | To enable the Graphviz extension, we have to add it to the extensions list in 3630 | the org-babel-load-languages variable. 3631 |

3632 | 3633 |
3634 | 
(add-to-list 'org-babel-load-languages '(R . t)) ; Requires R and ess-mode.
3635 | (org-babel-do-load-languages 'org-babel-load-languages org-babel-load-languages)
3636 |
3637 |
3638 | 3639 |

3640 | It uses directly the R command to process R language. 3641 |

3642 |
3643 | 3644 |
3645 |

Example

3646 |
3647 |

3648 | Data to be charted: 3649 |

3650 | 3651 | 3652 | 3653 | 3654 | 3655 | 3656 | 3657 | 3658 | 3659 | 3660 | 3661 | 3662 | 3663 | 3664 | 3665 | 3666 | 3667 | 3668 | 3669 | 3670 | 3671 | 3672 | 3673 | 3674 | 3675 | 3676 | 3677 | 3678 | 3679 | 3680 | 3681 | 3682 | 3683 | 3684 | 3685 | 3686 | 3687 | 3688 | 3689 | 3690 | 3691 | 3692 | 3693 | 3694 | 3695 | 3696 | 3697 | 3698 | 3699 | 3700 | 3701 | 3702 | 3703 | 3704 | 3705 | 3706 | 3707 | 3708 | 3709 | 3710 | 3711 | 3712 | 3713 | 3714 | 3715 | 3716 | 3717 | 3718 | 3719 | 3720 | 3721 | 3722 | 3723 | 3724 | 3725 | 3726 |
MonthDegrees
013.8
024.1
036.3
049.0
0511.9
0615.1
0717.1
0817.4
0915.7
1011.8
117.7
124.8
3727 | 3728 |

3729 | Code: 3730 |

3731 | 3732 |
3733 | 
plot(data, type="b", bty="l", col=c("#ABD249"), las=1, lwd=4)
3734 | grid(nx=NULL, ny=NULL, col=c("#E8E8E8"), lwd=1)
3735 | legend("bottom", legend=c("Degrees"), col=c("#ABD249"), pch=c(19))
3736 |
3737 |
3738 | 3739 |

3740 | The resulting chart: 3741 |

3742 |
3743 |
3744 |
3745 | 3746 |
3747 |

Citations

3748 |
3749 |

3750 | Cross-referenced to bibliography. 3751 |

3752 |
3753 |
3754 | 3755 |
3756 |

Appendix

3757 |
3758 |

3759 | Special sections. 3760 |

3761 |
3762 | 3763 |
3764 |

Index

3765 |
3766 |

3767 | Index (or list of acronyms). 3768 |

3769 | 3770 |
    3771 |
  • Write index entries
    • 3772 |
3773 | 3774 |

3775 | Note that multi-entry terms generate separate index entries. 3776 |

3777 | 3778 |
    3779 |
  • Place the index at the desired location
    • 3780 | 3781 |
  • Produce the index by updating org-latex-pdf-process
    • 3782 |
3783 |
3784 |
3785 | 3786 |
3787 |

Bibliography

3788 |
3789 |

3790 | The bibliography… 3791 |

3792 | 3793 |
    3794 |
  • Eric Steven Raymond. The Art of Unix Programming. Addison-Wesley. ISBN 3795 | 0-13-142901-9.
    • 3796 |
3797 |
3798 |
3799 | 3800 |
3801 |

Glossary

3802 |
3803 |

3804 | Glossaries are optional. Glossaries entries are an example of definition lists. 3805 |

3806 | 3807 |
3808 |
A glossary term
The corresponding (indented) definition.
3809 | 3810 |
A second glossary term
The corresponding (indented) definition.
3811 |
3812 |
3813 |
3814 |
3815 | 3816 |
3817 |

Contributing

3818 |
3819 |
3820 |
3821 |

Issues

3822 |
3823 |

3824 | Report issues and suggest features and improvements on the GitHub issue tracker. 3825 |

3826 |
3827 |
3828 | 3829 |
3830 |

Patches

3831 |
3832 |

3833 | I love contributions! Patches under any form are always welcome! 3834 |

3835 |
3836 |
3837 | 3838 |
3839 |

Donations

3840 |
3841 |

3842 | If you use the refcard-org-mode project and feel it is making your life better 3843 | and easier, you can show your appreciation and help support future development 3844 | by making a donation through PayPal. Thank you! 3845 |

3846 | 3847 |

3848 | Regardless of the donations, refcard-org-mode will always be free both as in 3849 | beer and as in speech. 3850 |

3851 |
3852 |
3853 |
3854 | 3855 |
3856 |

License

3857 |
3858 |

3859 | Copyright (C) 2014-2024 Fabrice Niessen. All rights reserved. 3860 |

3861 | 3862 |

3863 | Author: Fabrice Niessen
3864 | Keywords: org-mode refcard 3865 |

3866 | 3867 |

3868 | This program is free software; you can redistribute it and/or modify it under 3869 | the terms of the GNU General Public License as published by the Free Software 3870 | Foundation, either version 3 of the License, or (at your option) any later 3871 | version. 3872 |

3873 | 3874 |

3875 | This program is distributed in the hope that it will be useful, but WITHOUT ANY 3876 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 3877 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 3878 |

3879 | 3880 |

3881 | You should have received a copy of the GNU General Public License along with 3882 | this program. If not, see http://www.gnu.org/licenses/. 3883 |

3884 | 3885 | 3886 | :license-gpl-blue.svg 3887 | 3888 | 3889 | btn_donate_LG.gif 3890 | 3891 |
3892 |
3893 |
3894 |

Footnotes:

3895 |
3896 | 3897 |
1

3898 | Extensively used in large documents. 3899 |

3900 | 3901 |
2

3902 | Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do 3903 | eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim 3904 | veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea 3905 | commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit 3906 | esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat 3907 | non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 3908 |

3909 | 3910 | 3911 |
3912 |
3913 |
3914 |

Author: Fabrice Niessen

3915 |
3916 | 3917 | 3918 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: Org mode syntax 2 | #+SUBTITLE: Quick reference card 3 | #+AUTHOR: Fabrice Niessen 4 | #+EMAIL: (concat "fniessen" at-sign "pirilampo.org") 5 | #+DESCRIPTION: Org mode syntax example 6 | #+KEYWORDS: org-mode, syntax, quick reference, cheat sheet, recommended practices, latex, beamer, html 7 | #+LANGUAGE: en 8 | #+OPTIONS: H:4 num:nil toc:2 p:t 9 | 10 | #+HTML_LINK_HOME: http://www.google.com 11 | #+HTML_LINK_UP: http://www.bing.com 12 | 13 | #+SETUPFILE: ~/org/theme-readtheorg.setup 14 | 15 | #+PROPERTY: header-args :eval yes :exports both :results replace 16 | 17 | # #+MACRO: longtext this is a very very long text to include 18 | 19 | | *Framework* | Org mode 9 | 20 | | *Bug tracker* | https://github.com/fniessen/refcard-org-mode/issues | 21 | | *Source* | https://github.com/fniessen/refcard-org-mode | 22 | # | *Documentation* | http://refcard-org-mode.readthedocs.org/ | 23 | 24 | #+begin_quote 25 | [!TIP] 26 | 27 | *** Elevate your Emacs skills in Paris, Utrecht, Leuven or Valencia! 28 | *Unlock the power of Emacs! Join my next exclusive "Emacs Boost" course!* 29 | 30 | Ready to /supercharge your productivity/ and become an Emacs ninja? Look no 31 | further! 32 | 33 | *What you'll learn:* 34 | - Master Emacs from the basics to advanced tricks. 35 | - /Boost your editing efficiency/ and streamline your workflow. 36 | - Customize Emacs to fit your unique needs. 37 | - And much more! 38 | 39 | *Audience:* 40 | 41 | Open to anyone interested in Emacs, from beginners to advanced 42 | users. 43 | 44 | *Why choose my course?* 45 | - Expert instructor with 25 years of Emacs experience. 46 | - /Hands-on exercises/ to reinforce your learning. 47 | - /Networking opportunities/ with like-minded Emacs enthusiasts. 48 | - Personalized attention. 49 | 50 | Don't miss this opportunity to take your Emacs skills to the next level! \\ 51 | 52 | Visit https://emacsboost.com/en/ for more information, dates and locations, and 53 | to /reserve your seat/. 54 | #+end_quote 55 | 56 | * Summary 57 | 58 | # See https://tutorialtodoapp.readthedocs.org/en/latest/ for nice home page! 59 | 60 | *You will learn to:* 61 | 62 | - write your docs in Org mode 63 | - create tables 64 | - create custom code blocks 65 | - and much more! 66 | 67 | This is an Org mode document, using the ~.org~ extension (supported by GitHub). 68 | 69 | *Org mode* is an easy-to-write /plain text/ formatting syntax for authoring notes, 70 | articles, LaTeX documents, books, Web pages, Beamer slide decks and much more! 71 | 72 | This is a cheat sheet for *Org mode 8* (because of some markup syntax changes 73 | since Org mode 7), using [[https://github.com/fniessen/org-html-themes][ReadTheOrg CSS]]. 74 | 75 | Reading through all the [[http://orgmode.org/org.pdf][documentation]] is highly recommended, but for the truly 76 | impatient, following are some quick steps to get started. 77 | 78 | # #+begin_abstract 79 | # This paper talks about... 80 | # #+end_abstract 81 | 82 | # See http://asciidoctor.org/docs/user-manual/#the-big-picture 83 | 84 | # See http://home.fnal.gov/~neilsen/notebook/orgExamples/org-examples.html. 85 | 86 | * Reference card 87 | 88 | #+TOC: headlines 2 89 | 90 | * Document header 91 | 92 | Title and author line: 93 | 94 | #+begin_src org :eval never-export 95 | ,#+TITLE: Org mode syntax examples 96 | ,#+AUTHOR: Fabrice Niessen 97 | 98 | My document provides... 99 | #+end_src 100 | 101 | It's a good practice to also include an email line following the author line. 102 | 103 | #+begin_src org :eval never-export 104 | ,#+EMAIL: john.doe@example.com 105 | #+end_src 106 | 107 | * Document settings 108 | 109 | ** Document description 110 | 111 | #+begin_src org :eval never-export 112 | #+DESCRIPTION: This document catalogs a set of tips and tricks for composing documents in Org mode. 113 | #+KEYWORDS: org-mode, syntax, quick reference, cheat sheet, recommended practices, latex, beamer, html 114 | #+LANGUAGE: en 115 | #+end_src 116 | 117 | ** Section numbering 118 | 119 | #+begin_src org :eval never-export 120 | #+OPTIONS: H:4 121 | #+end_src 122 | 123 | #+begin_src org :eval never-export 124 | #+OPTIONS: num:nil 125 | #+end_src 126 | 127 | ** Table of contents 128 | 129 | Set the ~toc~ attribute to activate an auto-generated table of contents (limited 130 | to its 2 first levels) at the top of document. 131 | 132 | #+begin_src org :eval never-export 133 | #+OPTIONS: toc:2 134 | #+end_src 135 | 136 | #+begin_src org :eval never-export 137 | #+OPTIONS: p:t 138 | #+end_src 139 | 140 | #+begin_note 141 | The ~ALT_TITLE~ property allows to set an alternate title (shorter, for example) 142 | for a given headline in the table of contents and other running heads. 143 | #+end_note 144 | 145 | To locally insert the TOC at some random place, use the ~#+TOC: headlines [n]~ 146 | feature; for example: 147 | 148 | #+begin_src org :eval never-export 149 | ,#+TOC: headlines 2 150 | #+end_src 151 | 152 | ** List of figures 153 | 154 | ~#+TOC: figures~ is not implemented yet in the HTML backend. 155 | 156 | ** List of tables 157 | 158 | ~#+TOC: tables~ is already implemented in the HTML backend. 159 | 160 | ** List of equations 161 | 162 | * Section titles (headings) 163 | 164 | #+begin_src org :eval no 165 | ,* Biggest heading (level 1) 166 | 167 | New chapter. 168 | #+end_src 169 | 170 | #+begin_src org 171 | ,** Bigger heading (level 2) 172 | 173 | New section. 174 | 175 | ,*** Big heading (level 3) 176 | 177 | New sub-section. 178 | 179 | ,**** Heading (level 4) 180 | 181 | New sub-sub-section. 182 | #+end_src 183 | 184 | ** Numbered headings 185 | 186 | You can create numbered headings up to a certain level by setting an option: 187 | 188 | #+begin_src org 189 | ,#+OPTIONS: H:4 190 | #+end_src 191 | 192 | * Paragraphs 193 | 194 | ** Normal 195 | 196 | #+begin_src org 197 | A single newline has no effect. 198 | This line is part of the same paragraph. 199 | 200 | But an empty line 201 | 202 | demarcates paragraphs. 203 | #+end_src 204 | 205 | ** Line breaks 206 | 207 | #+begin_src org 208 | By entering two consecutive backslashes, \\ 209 | you can force a line break 210 | without starting a new paragraph. 211 | #+end_src 212 | 213 | ** Horizontal rules 214 | 215 | #+begin_src org 216 | For an horizontal line, insert at least 5 dashes: this is some text above an 217 | horizontal rule 218 | ----- 219 | and some text below it. 220 | #+end_src 221 | 222 | ** Text width 223 | 224 | # Premiere Elements, page 111 225 | # 226 | # Vous pouvez créer ces objets en cliquant sur le bouton Nouvel| élément de le 227 | # fenêtre Média. (Le Chapitre 14 explique comment créer| des titres ; le 228 | # Chapitre 15 montre l'utilisation des barres et ton, de la| vidéo noir et de 229 | # l'amorce SMPTE.) 230 | # 231 | # The principles of beautiful Web design, page 6 232 | # 233 | # In a figurative sense, the concept of visual balance is similar to that of 234 | # physical balance| illustrated by a seesaw. Just as physical objects have 235 | # weight, so do the elements of a layout.| If the elements on either side of a 236 | # layout are of equal weight, they balance one another.| There are two main forms 237 | # of visual balance: symmetrical and asymmetrical. 238 | 239 | One morning, when Gregor Samsa woke from troubled dreams, he found himself 240 | transformed in his bed into a horrible vermin. He lay on his armour-like back, 241 | and if he lifted his head a little he could see his brown belly, slightly domed 242 | and divided by arches into stiff sections. The bedding was hardly able to cover 243 | it and seemed ready to slide off any moment. His many legs, pitifully thin 244 | compared with the size of the rest of him, waved about helplessly as he looked. 245 | 246 | * Formatting text 247 | 248 | Text effects. 249 | 250 | ** Bold and italic 251 | 252 | #+begin_src org 253 | /Emphasize/ (italics), *strongly* (bold), and */very strongly/* (bold italics). 254 | #+end_src 255 | 256 | Markup elements can be nested: 257 | 258 | #+begin_src org 259 | This is /italic text which contains _underlined text_ within it/, whereas _this is 260 | normal underlined text_. 261 | #+end_src 262 | 263 | Markup can span across multiple lines, by default *no more than 2*: 264 | 265 | #+begin_src org 266 | *This 267 | is not 268 | bold.* 269 | #+end_src 270 | 271 | Org mode does not interpret a marker surrounded by alphanumeric characters as an 272 | emphasis marker. So, you can't (easily) emphasize just part of a word: 273 | 274 | #+begin_src org 275 | Not feas*ible*. 276 | #+end_src 277 | 278 | ** Monospace, superscript and subscript 279 | 280 | Other elements to use sparingly are: 281 | 282 | #+begin_src org 283 | - monospaced typewriter font for ~inline code~ 284 | - monospaced typewriter font for =verbatim text= 285 | - +deleted text+ (vs. _inserted text_) 286 | - text with super^{script}, such as 2^{10} 287 | - text with sub_{script}, such as H_{2}O 288 | #+end_src 289 | 290 | ** Smart punctuation 291 | 292 | If the XXX option is specified, Org mode will produce typographically correct 293 | output, converting straight quotes to curly quotes, ~---~ to em-dashes, ~--~ to 294 | en-dashes, and ~...~ to ellipses. 295 | 296 | * Lists 297 | 298 | Org markup allows you to create *bulleted* or *numbered* lists. It allows any 299 | combination of the two list types. 300 | 301 | ** Unordered lists 302 | 303 | Itemized lists are marked with bullets. Create them with a minus or a plus sign. 304 | 305 | They are convenient to organize data, and make the document prettier, and easier 306 | to read. 307 | 308 | #+begin_src org 309 | - Item with some lengthy text wrapping hopefully across several lines. We add 310 | a few words to really show the line wrapping. 311 | - Bullet. 312 | + Bullet. 313 | * Bullet. 314 | #+end_src 315 | 316 | ** Checklists 317 | 318 | #+begin_src org 319 | - [X] Checked. 320 | - [-] Half-checked. 321 | - [ ] Not checked. 322 | - Normal list item. 323 | #+end_src 324 | 325 | ** Ordered lists 326 | 327 | Enumerated lists are marked with numbers or letters: 328 | 329 | #+begin_src org 330 | 1. Arabic (decimal) numbered list item. We add a few words to show the line 331 | wrapping. 332 | A. Upper case alpha (letter) numbered list item. 333 | a. Lower alpha. 334 | b. Lower alpha. 335 | B. Upper alpha. 336 | 2. Number. 337 | #+end_src 338 | 339 | You can have ordered lists with jumping numbers: 340 | 341 | #+begin_src org 342 | 2. [@2] We start with point number 2. 343 | 3. Automatically numbered item. 344 | #+end_src 345 | 346 | ** Definition lists 347 | :PROPERTIES: 348 | :ID: f1a4a242-755b-4c38-9280-ee3f60e2b29a 349 | :END: 350 | 351 | Labeled, multi-line lists. 352 | 353 | #+begin_src org 354 | - First term to define :: 355 | Definition of the first term. We add a few words to show the line wrapping, 356 | to see what happens when you have long lines. 357 | 358 | - Second term :: 359 | Explication of the second term with *inline markup*. 360 | 361 | In many paragraphs. 362 | #+end_src 363 | 364 | ** Separating lists 365 | 366 | Adjacent lists sometimes like to fuse. To force the start of a new list, offset 367 | the two lists by an empty line comment: 368 | 369 | #+begin_src org 370 | - apples 371 | - oranges 372 | - bananas 373 | 374 | # Comment. 375 | 376 | - carrots 377 | - tomatoes 378 | - celery 379 | #+end_src 380 | 381 | * Tables 382 | 383 | Tables are one of the most refined areas of the Org mode syntax. They are very easy 384 | to create and to read. 385 | 386 | ** Simple table 387 | 388 | #+begin_src org 389 | | Cell in column 1, row 1 | Cell in column 2, row 1 | 390 | | Cell in column 1, row 2 | Cell in column 2, row 2 | 391 | #+end_src 392 | 393 | Org tables have cells of at most one line long: there is no such thing as 394 | a multi-line table cell in Org. 395 | 396 | ** Column formatting 397 | 398 | Columns are automatically aligned: 399 | 400 | - Number-rich columns to the right, and 401 | - String-rich columns to the left. 402 | 403 | *** Table with aligned cells 404 | 405 | If you want to override the automatic alignment, use ~~, ~~ or ~~. 406 | 407 | #+begin_src org 408 | ,#+caption: Table with aligned columns 409 | | | | | 410 | | 1 | 2 | 3 | 411 | | Right | Center | Left | 412 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 413 | #+end_src 414 | 415 | *** Table with column size adjusted 416 | 417 | ** Header row 418 | 419 | You can create tables with an header row (by using an horizontal line of dashes 420 | to separate it from the rest of the table). 421 | 422 | #+begin_src org 423 | #+caption: Table with an header row 424 | | Name of column 1 | Name of column 2 | Name of column 3 | 425 | |------------------+------------------+------------------| 426 | | Top left | Top middle | | 427 | | | | Right | 428 | | Bottom left | Bottom middle | | 429 | #+end_src 430 | 431 | ** A very long table 432 | 433 | To test "sticky table headers"... 434 | 435 | | Name of column 1 | Name of column 2 | Name of column 3 | 436 | |------------------+------------------+------------------| 437 | | Top left | Top middle | | 438 | | 2 | | | 439 | | 3 | | | 440 | | 4 | | | 441 | | 5 | | | 442 | | 6 | | | 443 | | 7 | | | 444 | | 8 | | | 445 | | 9 | | | 446 | | 10 | | | 447 | | 11 | | | 448 | | 12 | | | 449 | | 13 | | | 450 | | 14 | | | 451 | | 15 | | Right | 452 | | 16 | | | 453 | | 17 | | | 454 | | 18 | | | 455 | | 19 | | | 456 | | 20 | | | 457 | | 21 | | | 458 | | 22 | | | 459 | | 23 | | | 460 | | 24 | | | 461 | | 25 | | | 462 | | 26 | | | 463 | | 27 | | | 464 | | 28 | | | 465 | | 29 | | | 466 | | Bottom left | Bottom middle | | 467 | 468 | ** Table placement 469 | 470 | #+begin_src org 471 | #+ATTR_LATEX: :center nil 472 | | a | b | 473 | | 1 | 2 | 474 | #+end_src 475 | 476 | XXX Different from the following: 477 | 478 | #+begin_src org 479 | | a | b | 480 | | 1 | 2 | 481 | #+end_src 482 | 483 | ** Align tables on the page 484 | 485 | *** Left 486 | 487 | Here is a table on the left side: 488 | 489 | #+begin_src org 490 | ,#+LATEX: \noindent 491 | ,#+ATTR_LATEX: :center nil 492 | | a | b | c | 493 | |---+---+---| 494 | | 1 | 2 | 3 | 495 | | 4 | 5 | 6 | 496 | ,#+LATEX: \hfill 497 | #+end_src 498 | 499 | The ~noindent~ just gets rid of the indentation of the first line of a paragraph 500 | which in this case is the table. The ~hfill~ adds infinite stretch after the 501 | table, so it pushes the table to the left. 502 | 503 | *** Center 504 | 505 | Here is a centered table: 506 | 507 | #+begin_src org 508 | | a | b | c | 509 | |---+---+---| 510 | | 1 | 2 | 3 | 511 | | 4 | 5 | 6 | 512 | #+end_src 513 | 514 | *** Right 515 | 516 | And here's a table on the right side: 517 | 518 | #+begin_src org 519 | #+LATEX: \hfill 520 | #+ATTR_LATEX: :center nil 521 | | a | b | c | 522 | |---+---+---| 523 | | 1 | 2 | 3 | 524 | | 4 | 5 | 6 | 525 | #+end_src 526 | 527 | Here the ~hfill~ adds infinite stretch before the table, so it pushes the table 528 | to the right. 529 | 530 | ** Table size 531 | 532 | #+begin_src org 533 | #+ATTR_HTML: :width 100% 534 | | Cell in column 1, row 1 | Cell in column 2, row 1 | 535 | | Cell in column 1, row 2 | Cell in column 2, row 2 | 536 | #+end_src 537 | 538 | ** CSV 539 | 540 | You can fill a table from a CSV file using R commands. 541 | 542 | * Links 543 | :PROPERTIES: 544 | :CUSTOM_ID: links 545 | :END: 546 | 547 | #+begin_src org :eval no 548 | ,* Links 549 | :PROPERTIES: 550 | :CUSTOM_ID: links 551 | :END: 552 | #+end_src 553 | 554 | This document is available in [[file:README.org][plain text]], [[file:README.html][HTML]] and [[file:README.pdf][PDF]]. 555 | 556 | The links are delimited by double square brackets. 557 | 558 | ** External links 559 | 560 | #+begin_src org 561 | See http://www.pirilampo.org (automatic!) and the 562 | [[http://orgmode.org/][Org mode Web site]]. 563 | #+end_src 564 | 565 | *** Relative links 566 | 567 | #+begin_src org 568 | [[../README.html][Home]] 569 | #+end_src 570 | 571 | *** Email links 572 | 573 | #+begin_src org 574 | [[mailto:john.doe@example.com][email John Doe]] 575 | #+end_src 576 | 577 | *** Image links 578 | 579 | To get image links, put a link to a file in the description. 580 | 581 | #+begin_src org 582 | Clicking on the image [[http://orgmode.org/][file:images/org-mode-unicorn.png]] 583 | leads to the Org mode home page. 584 | #+end_src 585 | 586 | ** Internal links 587 | :PROPERTIES: 588 | :ID: 0d2b0cb2-116c-4a61-a076-4c641faf4346 589 | :END: 590 | 591 | *** Inline anchors 592 | 593 | Anchors are used to specify hypertext link targets. 594 | 595 | #+begin_src org 596 | <> Inline anchors make arbitrary content referenceable. 597 | #+end_src 598 | 599 | *** Internal cross references 600 | 601 | Links generally point to an headline. 602 | 603 | #+begin_src org 604 | See chapter [[#links][Links]]. 605 | #+end_src 606 | 607 | To add a link to a figure (e.g., "See Figure 1"), just do: 608 | 609 | #+begin_src org 610 | ,#+caption: caption 611 | ,#+name: fig 612 | [[file:fig.png]] 613 | 614 | See figure [[fig]]. 615 | #+end_src 616 | 617 | You can also create a hypertext link to a document anchor in the current 618 | document /or in another document/. 619 | 620 | #+begin_src org 621 | See: 622 | - Location [[anchor][cross reference]]. 623 | - Section [[id:0d2b0cb2-116c-4a61-a076-4c641faf4346][Internal links]] 624 | #+end_src 625 | 626 | ** Extensions that define new hyperlinks targets 627 | 628 | * Images 629 | 630 | You can insert *image* files of different *formats* to a document: 631 | 632 | | | HTML | PDF | 633 | |------+------------------------------+-----| 634 | | gif | yes | | 635 | | jpeg | yes | | 636 | | png | yes | | 637 | | bmp | (depends on browser support) | | 638 | 639 | ** Inline picture 640 | 641 | #+begin_src org 642 | #+caption: Org mode logo 643 | [[file:images/org-mode-unicorn.png]] 644 | #+end_src 645 | 646 | #+begin_src org 647 | Click to see the [[file:images/org-mode-unicorn.png][Unicorn picture]]. 648 | #+end_src 649 | 650 | ** Image alignment (using positioning) 651 | 652 | Books usually align/float images on the right/left of the contents. 653 | 654 | *** Image is left aligned 655 | 656 | *** Image is right aligned 657 | 658 | *** Image is centered 659 | 660 | #+name: test 661 | #+begin_src R :exports results :file images/test.pdf :results graphics :width 8 :height 3 662 | plot(runif(100)) 663 | #+end_src 664 | 665 | #+attr_latex: :float t :placement [b] 666 | #+results: test 667 | [[file:images/test.pdf]] 668 | 669 | ** Image attributes and values 670 | 671 | XXX Available HTML image tags include ... 672 | 673 | | Attribute | Value(s) | 674 | |----------------+-----------------------------| 675 | | ~:alt~ | Alternate text | 676 | | ~:height~ | | 677 | | ~:width~ | User defined size in pixels | 678 | | ~:align~ | | 679 | | ~:border~ | | 680 | | ~:bordercolor~ | | 681 | | ~:hspace~ | | 682 | | ~:vspace~ | | 683 | | ~:title~ | User defined text | 684 | 685 | #+begin_src org 686 | #+ATTR_LaTeX: :width 0.25\linewidth 687 | [[file:images/org-mode-unicorn.png]] 688 | #+end_src 689 | 690 | Place images side by side: XXX 691 | 692 | ** Figures 693 | 694 | To define images that will be *treated as book illustrations* (figures) and 695 | automatically labeled and numbered, use XXX. 696 | 697 | * Videos 698 | 699 | Videos can't be added directly. 700 | 701 | Though, you can add an image with a link to the video like this: 702 | 703 | #+begin_src org 704 | [[http://www.youtube.com/watch?v=DnSGSiXYuOk][file:../bigblow.png]] 705 | #+end_src 706 | 707 | * Admonitions 708 | 709 | Admonitions (contextual backgrounds) are statements taken out of the content's 710 | flow and labeled with a title. 711 | 712 | Common admonitions are: 713 | 714 | 1. ~note~ 715 | 2. ~warning~ 716 | 3. ~tip~ 717 | 4. ~caution~ 718 | 5. ~important~ 719 | 720 | (Most themes style only ~note~ and ~warning~ specially.) 721 | 722 | ** List of supported admonitions :noexport: 723 | 724 | | Total | | GitHub | docutils | rST | RTD | AsciiDoc | DocBook | MoinMoin (Modern) | Bootstrap | DocOnce | Confluence | SuperCollider | 725 | |--------+-----------+--------+----------+-----+-----+----------+---------+-------------------+-----------+---------+------------+---------------| 726 | | 9 | note | 1 | 1 | 1 | 1 | 1 | 1 | 1 | | | 1 | 1 | 727 | | 11 | warning | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 728 | | 8 | tip | 1 | 1 | 1 | 1 | 1 | 1 | 1 | | | 1 | | 729 | |--------+-----------+--------+----------+-----+-----+----------+---------+-------------------+-----------+---------+------------+---------------| 730 | | 7 | caution | 1 | 1 | 1 | 1 | 1 | 1 | 1 | | | | | 731 | | 7 | important | 1 | 1 | 1 | 1 | 1 | 1 | 1 | | | | | 732 | |--------+-----------+--------+----------+-----+-----+----------+---------+-------------------+-----------+---------+------------+---------------| 733 | | 3 | attention | | 1 | 1 | 1 | | | | | | | | 734 | | 3 | hint | | 1 | 1 | 1 | | | | | | | | 735 | | 3 | error | | 1 | 1 | 1 | | | | | | | | 736 | | 4 | danger | | 1 | 1 | 1 | | | | 1 | | | | 737 | |--------+-----------+--------+----------+-----+-----+----------+---------+-------------------+-----------+---------+------------+---------------| 738 | | #ERROR | seealso | | | | ? | | | | | | | | 739 | | #ERROR | todo | | | | ? | | | | | | | | 740 | |--------+-----------+--------+----------+-----+-----+----------+---------+-------------------+-----------+---------+------------+---------------| 741 | | 2 | info | | | | | | | | 1 | | 1 | | 742 | | 1 | notice | | | | | | | | | 1 | | | 743 | | 1 | question | | | | | | | | | 1 | | | 744 | | 1 | summary | | | | | | | | | 1 | | | 745 | | 1 | success | | | | | | | | 1 | | | | 746 | #+TBLFM: $1=vsum($4..$12) 747 | 748 | ** Base admonitions 749 | 750 | #+begin_quote 751 | [!TIP] 752 | NEW on Github: An option to highlight a "Note" and "Warning" using blockquote 753 | https://github.com/orgs/community/discussions/16925 754 | #+end_quote 755 | 756 | #+begin_src org 757 | ,#+begin_quote 758 | [!TIP] 759 | Try doing it this way... 760 | ,#+end_quote 761 | #+end_src 762 | 763 | *** Note 764 | 765 | A note box is displayed as follows: 766 | 767 | #+begin_src org 768 | ,#+begin_note 769 | This is a useful note. 770 | ,#+end_note 771 | #+end_src 772 | 773 | # #+attr_html: :options [By the way...] 774 | # #+attr_latex: :options Test 775 | # #+begin_note 776 | # This is a useful note (with a title). 777 | # #+end_note 778 | 779 | *** Warning 780 | 781 | A warning box is displayed as follows: 782 | 783 | #+begin_src org 784 | ,#+begin_warning 785 | Be careful! Check that you have... 786 | ,#+end_warning 787 | #+end_src 788 | 789 | *** Tip 790 | 791 | A tip box is displayed as follows: 792 | 793 | #+begin_src org 794 | ,#+begin_tip 795 | Try doing it this way... 796 | ,#+end_tip 797 | #+end_src 798 | 799 | *** Caution 800 | 801 | #+begin_src org 802 | ,#+begin_caution 803 | Caution 804 | ,#+end_caution 805 | #+end_src 806 | 807 | *** Important 808 | 809 | #+begin_src org 810 | ,#+begin_important 811 | Important 812 | ,#+end_important 813 | #+end_src 814 | 815 | ** Additional admonitions 816 | 817 | *** Attention 818 | 819 | #+begin_src org 820 | ,#+begin_attention 821 | Attention 822 | ,#+end_attention 823 | #+end_src 824 | 825 | *** Hint 826 | 827 | #+begin_src org 828 | ,#+begin_hint 829 | Hint 830 | ,#+end_hint 831 | #+end_src 832 | 833 | *** Error 834 | 835 | #+begin_src org 836 | ,#+begin_error 837 | Error 838 | ,#+end_error 839 | #+end_src 840 | 841 | *** Danger 842 | 843 | #+begin_src org 844 | ,#+begin_danger 845 | Danger 846 | ,#+end_danger 847 | #+end_src 848 | 849 | *** SeeAlso (Sphinx additional) 850 | 851 | #+begin_src org 852 | ,#+begin_seealso 853 | - [[http://en.wikipedia.org/wiki/Apple][Apples]] :: 854 | A kind of [[http://en.wikipedia.org/wiki/Fruit][fruit]]. 855 | ,#+end_seealso 856 | #+end_src 857 | 858 | ** Todo admonition 859 | 860 | # See example at http://docs.ckan.org/en/latest/contributing/python.html 861 | # or http://wsgiservice.readthedocs.org/en/latest/todo.html 862 | 863 | Simple box ("inline task"): 864 | 865 | #+begin_src org 866 | *************** TODO Do this task 867 | Description of inline task. 868 | *************** END 869 | #+end_src 870 | 871 | *************** TODO Do this task 872 | Description of inline task. 873 | *************** END 874 | or: 875 | 876 | #+begin_src org 877 | *************** WAIT [#B] Do also this other task :phone: 878 | *************** END 879 | #+end_src 880 | 881 | #+begin_admonitiontodo 882 | Admonitiontodo 883 | #+end_admonitiontodo 884 | 885 | Alternatively to the inline tasks (for creating "TODO" annotations), if you want 886 | such notes not to show up in the published version, drawers may also do the job, 887 | e.g.: 888 | 889 | :FIXME: 890 | ... 891 | :END: 892 | 893 | You can then control what drawers are exported with 894 | ~org-export-with-drawers~ (or per document with d OPTIONS item). 895 | 896 | * Centered text 897 | 898 | #+begin_src org 899 | ,#+begin_left 900 | This text is \\ 901 | aligned to the left! 902 | ,#+end_left 903 | 904 | ,#+begin_center 905 | This text is \\ 906 | centered! 907 | ,#+end_center 908 | 909 | ,#+begin_right 910 | This text is \\ 911 | aligned to the right! 912 | ,#+end_right 913 | #+end_src 914 | 915 | * Sidebar 916 | 917 | #+begin_src org 918 | Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod 919 | tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, 920 | quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 921 | consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse 922 | cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non 923 | proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 924 | 925 | ,#+begin_sidebar 926 | Org mode was first released by Carsten Dominik in 2004 as an outlining and 927 | project planning tool. Further development turned it into a general tool that 928 | can be used to author professional documents like LaTeX. 929 | ,#+end_sidebar 930 | 931 | Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac 932 | turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor 933 | sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies 934 | mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien 935 | ullamcorper pharetra. Vestibulum erat wisi... 936 | 937 | Phasellus ut libero. Nulla in libero non enim tristique sollicitudin. Ut 938 | tempor. Phasellus pellentesque augue eget ante. Mauris malesuada. Donec sit 939 | amet diam sit amet dolor placerat blandit. Morbi enim purus, imperdiet in, 940 | molestie sit amet, pellentesque eu, mauris. In vel erat vel ipsum bibendum 941 | commodo. Curabitur accumsan. Nam sed metus. Etiam tristique bibendum justo. 942 | #+end_src 943 | 944 | * Example 945 | 946 | You can have ~example~ blocks. 947 | 948 | #+begin_src org 949 | : 10/17/97 9:04 bin 950 | : 10/16/97 14:11 DOS 951 | : 10/16/97 14:46 TEMP 952 | : 10/16/97 14:37 WINNT 953 | : 10/16/97 14:25 119 AUTOEXEC.BAT 954 | : 2/13/94 6:21 54,619 COMMAND.COM 955 | #+end_src 956 | 957 | or 958 | 959 | #+begin_src org 960 | ,#+begin_example 961 | 10/17/97 9:04 bin 962 | 10/16/97 14:11 DOS 963 | 10/16/97 14:46 TEMP 964 | 10/16/97 14:37 WINNT 965 | 10/16/97 14:25 119 AUTOEXEC.BAT 966 | 2/13/94 6:21 54,619 COMMAND.COM 967 | ,#+end_example 968 | #+end_src 969 | 970 | * Prose excerpts 971 | 972 | ** Quote 973 | 974 | Use the ~quote~ block for content that *doesn't require the preservation of line 975 | breaks*. 976 | 977 | #+begin_src org 978 | ,#+begin_quote 979 | Let us change our traditional attitude to the construction of programs: 980 | Instead of imagining that our main task is to instruct a computer what to do, 981 | let us concentrate rather on explaining to human beings what we want a 982 | computer to do. 983 | 984 | The practitioner of literate programming can be regarded as an essayist, whose 985 | main concern is with exposition and excellence of style. Such an author, with 986 | thesaurus in hand, chooses the names of variables carefully and explains what 987 | each variable means. He or she strives for a program that is comprehensible 988 | because its concepts have been introduced in an order that is best for human 989 | understanding, using a mixture of formal and informal methods that reinforce 990 | each other. 991 | 992 | -- Donald Knuth 993 | ,#+end_quote 994 | #+end_src 995 | 996 | A short one: 997 | 998 | #+begin_src org 999 | ,#+begin_quote 1000 | Everything should be made as simple as possible, 1001 | but not any simpler. -- Albert Einstein 1002 | ,#+end_quote 1003 | #+end_src 1004 | 1005 | ** Verse 1006 | 1007 | In a ~verse~ environment, there is an *implicit line break at the end of each line*, 1008 | and *indentation* is preserved: 1009 | 1010 | #+begin_src org 1011 | ,#+begin_verse 1012 | Everything should be made as simple as possible, 1013 | but not any simpler. -- Albert Einstein 1014 | ,#+end_verse 1015 | #+end_src 1016 | 1017 | Typically used for quoting passages of an email message: 1018 | 1019 | #+begin_src org 1020 | ,#+begin_verse 1021 | >> The meeting has been postponed to next Friday. 1022 | > 1023 | > Has the deadline for the report been moved too? 1024 | 1025 | Yes. And chekout http://www.doodle.com/ for rescheduling the meeting. 1026 | 1027 | In the text body, 1028 | indentation is 1029 | preserved. 1030 | ,#+end_verse 1031 | #+end_src 1032 | 1033 | ** Block quote with optional attribution line 1034 | 1035 | #+begin_epigraph 1036 | epigraph 1037 | #+end_epigraph 1038 | 1039 | ** Block quotes with their own class attribute 1040 | 1041 | #+begin_highlights 1042 | highlights 1043 | #+end_highlights 1044 | 1045 | #+begin_pull-quote 1046 | pull-quote 1047 | #+end_pull-quote 1048 | 1049 | #+begin_blockquote 1050 | Blockquote 1051 | #+end_blockquote 1052 | 1053 | ** Non-breaking space 1054 | 1055 | Insert the Unicode character ~00A0~ to add a non-breaking space. 1056 | 1057 | FIXME Or add/use an Org entity? Or use tilde? 1058 | 1059 | * Comments 1060 | 1061 | #+begin_src org 1062 | It's possible to add comments in the document. 1063 | 1064 | # This Org comment here won't be displayed. 1065 | #+end_src 1066 | 1067 | #+begin_note 1068 | Org doesn't support *comments inside paragraphs* since a comment ends 1069 | a paragraph. However, you can mimic inline comments with export snippets, e.g., 1070 | ~@@comment:...@@~. 1071 | #+end_note 1072 | 1073 | #+begin_tip 1074 | If you have tables (for example) that you want to ignore during export, one possibility 1075 | is to use *comment blocks* or ~:noexport:~ subtrees. Another possibility is to 1076 | *use* non-exported *drawers* (see #+OPTIONS: d:). 1077 | #+end_tip 1078 | 1079 | If you want to ignore that part only during export, but still want to 1080 | use keep it active in the buffer, I suggest to use a drawer, with an 1081 | appropriate `org-export-with-drawers' value, e.g., 1082 | 1083 | #+begin_src org 1084 | ,#+OPTIONS: d:(not "NOEXPORT") 1085 | #+end_src 1086 | 1087 | * Substitutions 1088 | 1089 | ** General replacements 1090 | 1091 | #+begin_src org :eval no 1092 | ,#+MACRO: longtext this very very long text 1093 | 1094 | Insert {{{longtext}}} wherever required. 1095 | #+end_src 1096 | 1097 | #+MACRO: longtext this very very long text 1098 | 1099 | Insert {{{longtext}}} wherever required. 1100 | 1101 | ** Styled references 1102 | 1103 | #+BEGIN_SRC org :eval no 1104 | ,#+MACRO: color @@html:$2@@ 1105 | 1106 | {{{color(blue, This text is colored in blue.)}}} 1107 | 1108 | {{{color(red, This other text is in red.)}}} 1109 | #+END_SRC 1110 | 1111 | #+MACRO: color @@html:$2@@ 1112 | 1113 | {{{color(blue, This text is colored in blue.)}}} 1114 | 1115 | {{{color(red, This other text is in red.)}}} 1116 | 1117 | Find more macros on [[https://github.com/fniessen/org-macros][GitHub]]. 1118 | 1119 | ** Special characters 1120 | 1121 | We also use substitutions to include some of the widely used Unicode characters 1122 | (like ©, converted from text characters to its typographically correct entity). 1123 | 1124 | *** Accents 1125 | 1126 | #+begin_src org 1127 | - \Agrave \Aacute 1128 | #+end_src 1129 | 1130 | *** Punctuation 1131 | 1132 | #+begin_src org 1133 | - Dash: \ndash \mdash 1134 | - Marks: \iexcl \iquest 1135 | - Quotations: \laquo \raquo 1136 | - Miscellaneous: \para \ordf 1137 | #+end_src 1138 | 1139 | *** Commercial symbols 1140 | 1141 | #+begin_src org 1142 | - Property marks: \copy \reg 1143 | - Currency: \cent \EUR \yen \pound 1144 | #+end_src 1145 | 1146 | *** Greek characters 1147 | 1148 | #+begin_src org 1149 | The Greek letters \alpha, \beta, and \gamma are used to denote angles. 1150 | #+end_src 1151 | 1152 | *** Math characters 1153 | 1154 | #+begin_src org 1155 | - Science: \pm \div 1156 | - Arrows: \to \rarr \larr \harr \rArr \lArr \hArr 1157 | - Function names: \arccos \cos 1158 | - Signs and symbols: \bull \star 1159 | #+end_src 1160 | 1161 | *** Misc 1162 | 1163 | #+begin_src org 1164 | - Zero-width non-joiner: \zwnj 1165 | # Smilies: \smiley \sad 1166 | - Suits: \clubs \spades 1167 | #+end_src 1168 | 1169 | #+begin_note 1170 | You can insert a real "zero-width space" Unicode character by pressing 1171 | ~C-x 8 RET zero width space RET~ or ~C-x 8 RET 200b RET~. 1172 | #+end_note 1173 | 1174 | * Source code 1175 | 1176 | ** Inline code 1177 | 1178 | #+begin_src org 1179 | Reference code like ~variables~ or ~functions~ inline. 1180 | #+end_src 1181 | 1182 | You can also evaluate code inline as follows: 1 + 1 is src_R{1 + 1}. 1183 | 1184 | ** Code blocks (with syntax highlighting) 1185 | 1186 | The source code blocks support syntax highlighting: 1187 | 1188 | #+begin_src cpp :eval no 1189 | /* 1190 | * Application that displays a "Hello" message to the standard output. 1191 | */ 1192 | int main(int arc, char **argv) 1193 | { 1194 | printf("Hello, %s!\n", (argc>1) ? argv[1] : "World"); 1195 | return 0; 1196 | } 1197 | #+end_src 1198 | 1199 | #+begin_src emacs-lisp :eval no 1200 | (defvar hello "Hello") 1201 | 1202 | (defun hello (name &optional greeting) 1203 | (message "%s %s" (or greeting "Hello") name)) 1204 | 1205 | (setq tab-width 4) 1206 | #+end_src 1207 | 1208 | # See http://sphinxcontrib-emacs.readthedocs.org/en/latest/guide/domain.html 1209 | 1210 | #+begin_note 1211 | You need =htmlize.el= in your ~load-path~, for the HTML export. 1212 | #+end_note 1213 | 1214 | ** Source mode 1215 | 1216 | The following language strings are currently recognized: 1217 | 1218 | #+begin_src emacs-lisp :results drawer :exports results 1219 | (concat (mapconcat (lambda (widget) 1220 | (widget-get widget :tag)) 1221 | (cl-remove-if-not (lambda (it) 1222 | (and (consp it) 1223 | (eq (car it) 'const))) 1224 | (cdr 1225 | (widget-get 1226 | (get 1227 | 'org-babel-load-languages 'custom-type) 1228 | :key-type))) 1229 | ", ") 1230 | ".") 1231 | #+end_src 1232 | 1233 | #+results: 1234 | :RESULTS: 1235 | Awk, C, R, Asymptote, Calc, Clojure, CSS, Ditaa, Dot, Emacs Lisp, Fortran, Gnuplot, Haskell, IO, J, Java, Javascript, LaTeX, Ledger, Lilypond, Lisp, Makefile, Maxima, Matlab, Mscgen, Ocaml, Octave, Org, Perl, Pico Lisp, PlantUML, Python, Ruby, Sass, Scala, Scheme, Screen, Shell Script, Shen, Sql, Sqlite, ebnf2ps. 1236 | :END: 1237 | 1238 | ** Line break 1239 | 1240 | Code block with long lines: 1241 | 1242 | #+begin_src emacs-lisp :eval no 1243 | testing testing testing testing testing testing testing testing testing testing 1244 | 0 1 2 3 4 5 6 7 8 9 1245 | 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456 1246 | #+end_src 1247 | 1248 | For PDF (LaTeX), one solution is to surround the code block such as: 1249 | 1250 | #+latex: \scriptsize 1251 | #+begin_src R 1252 | print("This block is in scriptsize") 1253 | #+end_src 1254 | #+latex: \normalsize 1255 | 1256 | ** Line numbers 1257 | 1258 | Both in ~example~ and in ~src~ snippets, you can add a ~-n~ switch to the end of the 1259 | ~begin~ line to get the lines numbered: 1260 | 1261 | #+header: :eval no 1262 | #+begin_src emacs-lisp -n 1263 | (defun org-xor (a b) 1264 | "Exclusive or." 1265 | #+end_src 1266 | 1267 | If you use a ~+n~ switch, the numbering from the previous numbered snippet will 1268 | be continued in the current one: 1269 | 1270 | #+header: :eval no 1271 | #+begin_src emacs-lisp +n 1272 | (if a (not b) b)) 1273 | #+end_src 1274 | 1275 | ** Callouts 1276 | 1277 | In literal examples, Org will interpret strings like ~(ref:name)~ as labels, and 1278 | use them as targets for special hyperlinks like ~[[(name)]]~ (i.e., the reference 1279 | name enclosed in single parenthesis). In HTML, hovering the mouse over such 1280 | a link will remote-highlight the corresponding code line, which is kind of 1281 | cool. 1282 | 1283 | You can also add a ~-r~ switch which removes the labels from the source code. 1284 | With the ~-n~ switch, links to these references will be labeled by the line 1285 | numbers from the code listing, otherwise links will use the labels with no 1286 | parentheses. Here is an example: 1287 | 1288 | #+header: :eval no 1289 | #+begin_src emacs-lisp -n -r 1290 | (save-excursion ; (ref:sc) 1291 | (goto-char (point-min))) ; (ref:jump) 1292 | #+end_src 1293 | 1294 | In line [[(sc)]], we remember the current position. [[(jump)][Line (jump)]] jumps to 1295 | ~point-min~. 1296 | 1297 | * Math 1298 | 1299 | You can embed LaTeX math formatting in Org mode files. 1300 | 1301 | ** Inline math expressions 1302 | 1303 | For *inline math* expressions, use the parentheses notation ~\(...\)~: 1304 | 1305 | #+begin_src org 1306 | The formula \(a^2 + b^2 = c^2\) has been discovered by Pythagoras. 1307 | 1308 | Let \(a=\sin(x) + \cos(x)\). Then \(a^2 = 2\sin(x)\cos(x)\) because \(\sin^2x + 1309 | \cos^2x = 1\). 1310 | #+end_src 1311 | 1312 | #+begin_warning 1313 | It's /not/ advised to use the ~$...$~ construct (both for Org and for MathJax). 1314 | 1315 | Don't forget that ~$~ is also a valid currency symbol! 1316 | #+end_warning 1317 | 1318 | ** Math expressions in display mode 1319 | 1320 | For mathematical expressions which you want to make *stand out, centered on their 1321 | own lines*, use ~\[...\]~: 1322 | 1323 | #+begin_src org 1324 | The /Euler theorem/: 1325 | 1326 | \[ 1327 | \int_0^\infty e^{-x^2} dx = {{\sqrt{\pi}} \over {2}} 1328 | \] 1329 | 1330 | LaTeX allows to inline such ~\[...\]~ constructs (/quadratic formula/): 1331 | \[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \] 1332 | #+end_src 1333 | 1334 | #+begin_warning 1335 | Double dollar signs (~$$~) should not be used. 1336 | #+end_warning 1337 | 1338 | #+begin_src org 1339 | \[ 1340 | \left( \int_{0}^{\infty} \frac{\sin x}{\sqrt x}\,\mathrm{d}x \ 1341 | right)^{2} - 1342 | \prod_{k=1}^{\infty} \frac{4k^{2}}{4k^{2}-1} + 1343 | \frac{\lambda}{2n}\sum_{k=1} ^{n} \theta_{k} ^{2} x^{n} = 0 1344 | \] 1345 | #+end_src 1346 | 1347 | The equation may be wrong, but it's a nice one! 1348 | 1349 | ** Equation numbers 1350 | 1351 | Differently from ~$...$~ and ~\(...\)~, an equation environment produces a *numbered* 1352 | equation to which you can add a label and reference the equation by (label) name 1353 | in other parts of the text. This is not possibly with unnumbered math 1354 | environments (~$$~, ...). 1355 | 1356 | #+begin_src org 1357 | The /Pythagoras theorem/: 1358 | 1359 | ,#+name: pythag 1360 | \begin{equation} 1361 | a^2 + b^2 = c^2 1362 | \end{equation} 1363 | 1364 | See equation [[pythag]]. 1365 | 1366 | # The /sinus theorem/ can be written as the equation: 1367 | # 1368 | # \begin{equation} 1369 | # \label{eqn:sinalpha} 1370 | # \frac{\sin\alpha}{a}=\frac{\sin\beta}{b} 1371 | # \end{equation} 1372 | # 1373 | # See equation [[eqn:sinalpha]]. 1374 | #+end_src 1375 | 1376 | Only captioned equations are numbered. 1377 | 1378 | Other alternatives: use 1379 | - ~\begin{equation*}~ or 1380 | - ~\begin{displaymath}~ (= the verbose form of the ~\[...\]~ construct). 1381 | 1382 | ~M-q~ does not fill those. 1383 | 1384 | * Miscellaneous effects 1385 | 1386 | ** Include Org files 1387 | 1388 | You can include another Org file and skip its title by using the ~:lines~ argument 1389 | to ~#+INCLUDE~: 1390 | 1391 | #+begin_src org 1392 | ,#+INCLUDE: "chapter1.org" :lines "2-" 1393 | #+end_src 1394 | 1395 | #+begin_note 1396 | File inclusion, through INCLUDE keywords, is an *export-only feature*. 1397 | #+end_note 1398 | 1399 | ** Raw HTML 1400 | 1401 | # http://johnmacfarlane.net/pandoc/README.html 1402 | 1403 | You can include raw HTML in your Org documents and it will get kept as HTML 1404 | when it's exported. 1405 | 1406 | #+HTML_BEGIN: 
1407 | Text can be preformatted (in a fixed-width font).
1408 | #+HTML_END:
1409 | 1410 | It is especially useful for more advanced stuff like images or tables where you 1411 | need more control of the HTML options than Org mode actually gives you. 1412 | 1413 | Similarly, you can incorporate JS or do anything else you can do in a Web page 1414 | (such as importing a CSS file). 1415 | 1416 | *** Native DIV blocks 1417 | 1418 | You can create named classes (to get style control from your CSS) with: 1419 | 1420 | #+begin_example 1421 | ,#+begin_myclass 1422 | This text is wrapped in a myclass DIV... 1423 | ,#+end_myclass 1424 | #+end_example 1425 | 1426 | You can also add interactive elements to the HTML such as interactive R plots. 1427 | 1428 | Finally, you can include an HTML file verbatim (during export) with: 1429 | 1430 | #+begin_src org 1431 | ,#+INCLUDE: "file.html" export html 1432 | #+end_src 1433 | 1434 | Don't edit the exported HTML file! 1435 | 1436 | ** Raw LaTeX 1437 | 1438 | You can also use raw LaTeX. XXX 1439 | 1440 | #+LaTeX_BEGIN: \begin{verbatim} 1441 | Text can be preformatted (in a fixed-width font). 1442 | #+LaTeX_END: \end{verbatim} 1443 | 1444 | * Footnotes  1445 | 1446 | #+begin_src org 1447 | It is possible to define named footnotes[fn:myfootnote], or ones with automatic 1448 | anchors[fn:2]. 1449 | #+end_src 1450 | 1451 | #+results: 1452 | It is possible to define named footnotes[fn:myfootnote], or ones with automatic 1453 | anchors[fn:2]. 1454 | 1455 | * Useful extensions 1456 | 1457 | ** Todo extension 1458 | 1459 | *** Dates 1460 | 1461 | Timestamps: [2014-01-16 Thu] and <2014-01-16 Thu>. 1462 | 1463 | *** TODO We need to achieve... 1464 | 1465 | *** DONE [#A] Buy GTD book :online: 1466 | :LOGBOOK: 1467 | - State "TODO" -> "DONE" [2014-01-16 Thu 09:52] 1468 | :END: 1469 | 1470 | By default, ~DONE~ actions will be collapsed. 1471 | 1472 | Note that I should probably implement that default behavior only for ~ARCHIVE~'d 1473 | items. 1474 | 1475 | *** TODO [#A] Read GTD book 1476 | SCHEDULED: <2014-09-11 Thu> 1477 | 1478 | By default, *all* (active) entries will be expanded at page load, so that their 1479 | contents is visible. 1480 | 1481 | That can be changed by adding such a line (into your Org document): 1482 | 1483 | #+begin_src org :eval no 1484 | ,#+HTML_HEAD: 1485 | #+end_src 1486 | 1487 | *** TODO [#B] Apply GTD methodoloy 1488 | DEADLINE: <2014-12-01 Mon> 1489 | :PROPERTIES: 1490 | :HTML_CONTAINER_CLASS: hsCollapsed 1491 | :END: 1492 | 1493 | This section will be collapsed when loading the page because the entry has the 1494 | value ~hsCollapsed~ for the property ~:HTML_CONTAINER_CLASS:~. 1495 | 1496 | Powerful, no? 1497 | 1498 | *** Some note :computer:write: 1499 | 1500 | You can add tags to any entry, and hightlight all entries having some specific 1501 | tag by clicking on the buttons made accessible to you in the "Dashboard". 1502 | 1503 | *** Weekly review :computer: 1504 | 1505 | Now, you can even make your weekly review in the HTML export... Press the ~r~ key 1506 | to start entering the "review mode" where all but one active entry are 1507 | collapsed, so that you can really focus on one item at a time! 1508 | 1509 | ** Bigblow extension 1510 | 1511 | The string ~fixme~ (in *upper case*) gets replaced by a "Fix Me!" image: 1512 | 1513 | #+begin_src org 1514 | FIXME Delete this... 1515 | #+end_src 1516 | 1517 | * Graphs with Graphviz 1518 | 1519 | To enable the Graphviz extension, we have to add it to the extensions list in 1520 | the ~org-babel-load-languages~ variable. 1521 | 1522 | #+begin_src emacs-lisp :exports code 1523 | (add-to-list 'org-babel-load-languages '(dot . t)) 1524 | (org-babel-do-load-languages 'org-babel-load-languages org-babel-load-languages) 1525 | #+end_src 1526 | 1527 | It uses directly the ~dot~ command to process DOT language. 1528 | 1529 | ** Undirected 1530 | 1531 | #+begin_src org 1532 | ,#+begin_src dot :file images/graph.png :cmdline -Tpng 1533 | graph foo { 1534 | "bar" -- "baz"; 1535 | } 1536 | ,#+end_src 1537 | #+end_src 1538 | 1539 | ** Directed 1540 | 1541 | #+begin_src org :exports results 1542 | ,#+begin_src dot :file images/digraph.png :cmdline -Tpng 1543 | digraph foo { 1544 | "bar" -> "baz"; 1545 | } 1546 | ,#+end_src 1547 | #+end_src 1548 | 1549 | * Graphs with R 1550 | 1551 | The output from the *execution* of programs, scripts or commands can be inserted 1552 | in the document itself, allowing you to work in the /reproducible research/ 1553 | mindset. 1554 | 1555 | To enable the Graphviz extension, we have to add it to the extensions list in 1556 | the ~org-babel-load-languages~ variable. 1557 | 1558 | #+begin_src emacs-lisp :exports code 1559 | (add-to-list 'org-babel-load-languages '(R . t)) ; Requires R and ess-mode. 1560 | (org-babel-do-load-languages 'org-babel-load-languages org-babel-load-languages) 1561 | #+end_src 1562 | 1563 | It uses directly the ~R~ command to process R language. 1564 | 1565 | ** Example 1566 | 1567 | Data to be charted: 1568 | 1569 | #+name: data 1570 | | Month | Degrees | 1571 | |-------+---------| 1572 | | 01 | 3.8 | 1573 | | 02 | 4.1 | 1574 | | 03 | 6.3 | 1575 | | 04 | 9.0 | 1576 | | 05 | 11.9 | 1577 | | 06 | 15.1 | 1578 | | 07 | 17.1 | 1579 | | 08 | 17.4 | 1580 | | 09 | 15.7 | 1581 | | 10 | 11.8 | 1582 | | 11 | 7.7 | 1583 | | 12 | 4.8 | 1584 | 1585 | Code: 1586 | 1587 | #+name: R-plot 1588 | #+begin_src R :var data=data :results graphics :file images/Rplot.png :exports both 1589 | plot(data, type="b", bty="l", col=c("#ABD249"), las=1, lwd=4) 1590 | grid(nx=NULL, ny=NULL, col=c("#E8E8E8"), lwd=1) 1591 | legend("bottom", legend=c("Degrees"), col=c("#ABD249"), pch=c(19)) 1592 | #+end_src 1593 | 1594 | The resulting chart: 1595 | 1596 | #+results: R-plot 1597 | [[file:images/Rplot.png]] 1598 | 1599 | ** COMMENT ggplot2 1600 | 1601 | #+begin_src R :results output graphics :file foo.png :session *foo* 1602 | library(ggplot2) 1603 | ggplot(data.frame(x = rnorm(10), y = rnorm(10)), 1604 | aes(x = x, y = y)) + 1605 | geom_point() 1606 | #+end_src 1607 | 1608 | * Citations 1609 | 1610 | Cross-referenced to bibliography. 1611 | 1612 | * Appendix 1613 | 1614 | Special sections. 1615 | 1616 | ** Index 1617 | 1618 | Index (or list of acronyms). 1619 | 1620 | - Write index entries 1621 | 1622 | #+index: Org-mode 1623 | 1624 | Note that multi-entry terms generate separate index entries. 1625 | 1626 | #+index: Definitions!Org-mode 1627 | 1628 | - Place the index at the desired location 1629 | 1630 | - Produce the index by updating ~org-latex-pdf-process~ 1631 | 1632 | #+BIND: org-latex-pdf-process ("pdflatex %b" "bibtex %b" "pdflatex %b" "pdflatex %b") 1633 | 1634 | ** Bibliography 1635 | 1636 | The bibliography... 1637 | 1638 | - Eric Steven Raymond. The Art of Unix Programming. Addison-Wesley. ISBN 1639 | 0-13-142901-9. 1640 | 1641 | # http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html 1642 | 1643 | ** Glossary 1644 | 1645 | Glossaries are optional. Glossaries entries are an example of [[id:f1a4a242-755b-4c38-9280-ee3f60e2b29a][definition lists]]. 1646 | 1647 | - A glossary term :: 1648 | The corresponding (indented) definition. 1649 | 1650 | - A second glossary term :: 1651 | The corresponding (indented) definition. 1652 | 1653 | * Contributing 1654 | 1655 | ** Issues 1656 | 1657 | Report issues and suggest features and improvements on the [[https://github.com/fniessen/refcard-org-mode/issues/new][GitHub issue tracker]]. 1658 | 1659 | ** Patches 1660 | 1661 | I love contributions! Patches under any form are always welcome! 1662 | 1663 | ** Donations 1664 | 1665 | If you use the refcard-org-mode project and feel it is making your life better 1666 | and easier, you can show your appreciation and help support future development 1667 | by making a [[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=refcard%2dorg%2dmode¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted][donation]] through PayPal. Thank you! 1668 | 1669 | Regardless of the donations, refcard-org-mode will always be free both as in 1670 | beer and as in speech. 1671 | 1672 | * License 1673 | 1674 | Copyright (C) 2014-2025 Fabrice Niessen. All rights reserved. 1675 | 1676 | Author: Fabrice Niessen \\ 1677 | Keywords: org-mode refcard 1678 | 1679 | This program is free software; you can redistribute it and/or modify it under 1680 | the terms of the GNU General Public License as published by the Free Software 1681 | Foundation, either version 3 of the License, or (at your option) any later 1682 | version. 1683 | 1684 | This program is distributed in the hope that it will be useful, but WITHOUT ANY 1685 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 1686 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 1687 | 1688 | You should have received a copy of the GNU General Public License along with 1689 | this program. If not, see http://www.gnu.org/licenses/. 1690 | 1691 | #+html: 1692 | #+html: :license-gpl-blue.svg 1693 | #+html: 1694 | #+html: 1695 | #+html: btn_donate_LG.gif 1696 | #+html: 1697 | 1698 | * Footnotes 1699 | 1700 | [fn:myfootnote] Extensively used in large documents. 1701 | 1702 | [fn:2] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do 1703 | eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim 1704 | veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea 1705 | commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit 1706 | esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat 1707 | non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 1708 | 1709 | #+BIND: org-hide-emphasis-markers nil 1710 | 1711 | # This is for the sake of Emacs. 1712 | # Local Variables: 1713 | # flycheck-disabled-checkers: (proselint textlint) 1714 | # org-hide-emphasis-markers: nil 1715 | # End: 1716 | -------------------------------------------------------------------------------- /images/Rplot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fniessen/refcard-org-mode/a9da8f24aeba1e93b496051971719bd46ca2b636/images/Rplot.png -------------------------------------------------------------------------------- /images/fig.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fniessen/refcard-org-mode/a9da8f24aeba1e93b496051971719bd46ca2b636/images/fig.png -------------------------------------------------------------------------------- /images/org-mode-unicorn.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fniessen/refcard-org-mode/a9da8f24aeba1e93b496051971719bd46ca2b636/images/org-mode-unicorn.png -------------------------------------------------------------------------------- /images/test.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fniessen/refcard-org-mode/a9da8f24aeba1e93b496051971719bd46ca2b636/images/test.pdf --------------------------------------------------------------------------------