├── .gitignore ├── LICENSE ├── images ├── paragraphs-alignement.png ├── paragraphs.png ├── screencast.gif └── toc.png ├── org-view-font.el ├── org-view-mode.el └── readme.org /.gitignore: -------------------------------------------------------------------------------- 1 | # -*- mode: gitignore; -*- 2 | *~ 3 | \#*\# 4 | /.emacs.desktop 5 | /.emacs.desktop.lock 6 | *.elc 7 | auto-save-list 8 | tramp 9 | .\#* 10 | 11 | # Org-mode 12 | .org-id-locations 13 | *_archive 14 | test.org 15 | 16 | # flymake-mode 17 | *_flymake.* 18 | 19 | # eshell files 20 | /eshell/history 21 | /eshell/lastdir 22 | 23 | # elpa packages 24 | /elpa/ 25 | 26 | # reftex files 27 | *.rel 28 | 29 | # AUCTeX auto folder 30 | /auto/ 31 | 32 | # cask packages 33 | .cask/ 34 | dist/ 35 | 36 | # Flycheck 37 | flycheck_*.el 38 | 39 | # server auth directory 40 | /server/ 41 | 42 | # projectiles files 43 | .projectile 44 | 45 | # directory configuration 46 | .dir-locals.el 47 | 48 | # network security 49 | /network-security.data 50 | 51 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /images/paragraphs-alignement.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amno1/org-view-mode/16d7c87a1bef54abd892f0fda2a541043c42e097/images/paragraphs-alignement.png -------------------------------------------------------------------------------- /images/paragraphs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amno1/org-view-mode/16d7c87a1bef54abd892f0fda2a541043c42e097/images/paragraphs.png -------------------------------------------------------------------------------- /images/screencast.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amno1/org-view-mode/16d7c87a1bef54abd892f0fda2a541043c42e097/images/screencast.gif -------------------------------------------------------------------------------- /images/toc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amno1/org-view-mode/16d7c87a1bef54abd892f0fda2a541043c42e097/images/toc.png -------------------------------------------------------------------------------- /org-view-font.el: -------------------------------------------------------------------------------- 1 | ;;; org-view-font.el --- Font switcher module for org-view-mode -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2022 Trevor Richards 4 | 5 | ;; This program is free software; you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | ;;; Commentary: 19 | 20 | ;; This file is a library that contains the necessary code for `org-view-mode' 21 | ;; to be able to toggle a "reading font" off and on. 22 | 23 | 24 | ;;; Code: 25 | (require 'face-remap) 26 | (require 'cl-seq) 27 | 28 | (defgroup org-view-font nil 29 | "Special font customizations for `org-view-mode'." 30 | :group 'org-view) 31 | 32 | ;;;###autoload 33 | (defcustom org-view-font-remaps 34 | '((default . (:family "Serif" :height 1.25)) 35 | (org-document-title . (:height 1.2)) 36 | (org-level-1 . (:height 1.4 :weight normal)) 37 | (org-level-2 . (:height 1.3 :weight normal)) 38 | (org-level-3 . (:height 1.2 :weight normal)) 39 | (org-level-4 . (:height 1.1 :slant italic)) 40 | (org-level-5 . (:height 1.0 :weight semibold)) 41 | (org-level-6 . (:height 1.0 :weight semibold)) 42 | (org-level-7 . (:height 1.0 :weight semibold)) 43 | (org-level-8 . (:height 1.0 :weight semibold)) 44 | (org-link . (:underline t :weight normal))) 45 | "Faces to remap, with attributes to remap." 46 | :type '(alist :key-type face 47 | :value-type (plist :key-type symbol 48 | :value-type sexp)) 49 | :group 'org-view-font) 50 | 51 | ;;;###autoload 52 | (defcustom org-view-font-no-remap 53 | '(org-block 54 | org-block-begin-line 55 | org-block-end-line 56 | org-document-info-keyword 57 | org-code 58 | org-latex-and-related 59 | org-checkbox 60 | org-meta-line 61 | org-table 62 | org-drawer 63 | org-special-keyword 64 | org-property-value 65 | org-verbatim) 66 | "Faces to avoid remapping." 67 | :type '(repeat face) 68 | :group 'org-view-font) 69 | 70 | ;;;###autoload 71 | (defcustom org-view-font-enable nil 72 | "Enable the custom reading font settings for `org-view-mode'." 73 | :type 'boolean 74 | :group 'org-view-font) 75 | 76 | 77 | 78 | (defvar org-view-font--cookies '() 79 | "A record of remapped faces used by `org-view-mode'.") 80 | 81 | (defun org-view-font--apply-remap (setting) 82 | "Invoke `face-remap-add-relative' with a given face `SETTING'." 83 | (face-remap-add-relative (car setting) (cdr setting))) 84 | 85 | (defun org-view-font--remap-faces (remaps) 86 | "Apply `REMAPS' and store a record of them in the cookie storage." 87 | (dolist (cookie (cl-mapcar 'org-view-font--apply-remap (reverse remaps))) 88 | (add-to-list 'org-view-font--cookies cookie))) 89 | 90 | (defun org-view-font--to-face-props (face) 91 | "Reduce a `FACE' into a property list of its face properties." 92 | (cl-reduce 93 | `(lambda (props name) 94 | (plist-put props (car name) (face-attribute ',face (car name)))) 95 | face-attribute-name-alist 96 | :initial-value '())) 97 | 98 | (defun org-view-font--default-setting (face) 99 | "Create a default setting for a `FACE'. Preserves pre-existing settings." 100 | (let ((props (org-view-font--to-face-props face))) 101 | (cons face (plist-put props :family (face-attribute 'default :family))))) 102 | 103 | (defun org-view-font--clear-remaps (cookies) 104 | "Clear the remaps in a `COOKIES' list." 105 | (dolist (c cookies) 106 | (face-remap-remove-relative c))) 107 | 108 | 109 | 110 | ;;;###autoload 111 | (defun org-view-font-enable-font () 112 | "Enable the org-view-font feature." 113 | (org-view-font--remap-faces org-view-font-remaps) 114 | (org-view-font--remap-faces (cl-mapcar 'org-view-font--default-setting 115 | org-view-font-no-remap))) 116 | 117 | ;;;###autoload 118 | (defun org-view-font-disable-font () 119 | "Disable the org-view-font feature." 120 | (org-view-font--clear-remaps org-view-font--cookies) 121 | (setq org-view-font--cookies '())) 122 | 123 | (provide 'org-view-font) 124 | 125 | ;;; org-view-font.el ends here 126 | -------------------------------------------------------------------------------- /org-view-mode.el: -------------------------------------------------------------------------------- 1 | ;;; org-view-mode.el --- Read-only viewer with less markup clutter in org mode files -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2021 Arthur Miller 4 | 5 | ;; Author: Arthur Miller 6 | ;; Keywords: convenience, outlines, tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;; Author: Arthur Miller 22 | ;; Version: 1.0.0 23 | ;; Keywords: tools convenience 24 | ;; Package-Requires: ((emacs "25.1")) 25 | ;; URL: https://github.com/amno1/org-view-mode 26 | 27 | ;;; Commentary: 28 | 29 | ;; A read-only viewer with reduced clutter and prettier rendering in org files. 30 | ;; To enter the view-mode run: `M-x org-view-mode'. To turn it off run the same 31 | ;; command. The mode tries very hard to not do any changes to the buffer and 32 | ;; the content. However, it does use text properties for some effects, so at 33 | ;; least in theory, if you don't exit the viewer cleanly, via some of its exit 34 | ;; methods, it might happened that the view is not restored properly. In that 35 | ;; case you may re-enter, and exit the viewer again, or re-open the file. 36 | 37 | ;;; Issues 38 | 39 | ;;; Code: 40 | (require 'org) 41 | (require 'org-view-font) 42 | 43 | ;;; Options 44 | (defgroup org-view nil 45 | "A minor read-only mode for viewing textual `org-mode' files." 46 | :prefix "org-view-" 47 | :group 'org) 48 | 49 | (defcustom org-view-hide-tags t 50 | "Hide/show tags in org-headings." 51 | :type 'boolean 52 | :group 'org-view) 53 | 54 | (defcustom org-view-hide-stars t 55 | "Hide/show leading stars in org-headings." 56 | :type 'boolean) 57 | 58 | (defcustom org-view-hide-keywords t 59 | "Hide/show org-markup keywords." 60 | :type 'boolean) 61 | 62 | (defcustom org-view-hide-agenda-keywords t 63 | "Hide/show DEADLINE and SCHEDULED keywords." 64 | :type 'boolean) 65 | 66 | (defcustom org-view-hide-properties t 67 | "Hide/show properties and property drawers." 68 | :type 'boolean) 69 | 70 | (defcustom org-view-hide-ellipses nil 71 | "Hide/show ellipses for hidden text." 72 | :type 'boolean) 73 | 74 | (defcustom org-view-prettify-toc t 75 | "Prettify table of contents when included." 76 | :type 'boolean) 77 | 78 | (defcustom org-view-prettify-credentials t 79 | "Prettify TITLE, AUTHOR and EMAIL when specified." 80 | :type 'boolean) 81 | 82 | (defcustom org-view-prettify-paragraphs t 83 | "Prettify quote, verse and centered paragraphs in org-buffers." 84 | :type 'boolean) 85 | 86 | (defcustom org-view-paragraph-indent " " 87 | "Indentation string for paragraphs." 88 | :type 'string) 89 | 90 | (defcustom org-view-default-fill-column 80 91 | "Default size for `fill-column' in org-view mode. 92 | 93 | This value is used only if `fill-column' has invalid size, such as <= 0 or nil." 94 | :type 'fixnum) 95 | 96 | (defcustom org-view-author-prefix "───" 97 | "String used to pretty-render author prefix in paragraphs." 98 | :type 'string) 99 | 100 | (defcustom org-view-verse-align 'left 101 | "Specify how verses will be aligned. 102 | 103 | Alignement can be: left, right, middle or nil. Nil value means to remove the 104 | alignement. The alignement is done relative to the longest line in the 105 | paragrach. If present, the author line is excluded." 106 | :type 'symbol) 107 | 108 | (defcustom org-view-quote-align 'left 109 | "Specify how quotes will be aligned. 110 | 111 | This variable has same meaning for quotes as the alignement in 112 | `org-view-verse-align'." 113 | :type 'symbol) 114 | 115 | (defcustom org-view-center-credentials t 116 | "Whether to align title and author in center or not. 117 | 118 | Centering is done pixel wise relative to window width." 119 | :type 'boolean) 120 | 121 | (defgroup org-view-faces nil 122 | "Faces for org-view mode." 123 | :group 'org-view) 124 | 125 | (defface org-view-author-face 126 | '((t :slant italic :weight bold)) 127 | "Face to display author names in paragraphs." 128 | :group 'org-view-faces) 129 | 130 | (defface org-view-verse-face 131 | '((t :slant italic)) 132 | "Face to display verses in paragraphs." 133 | :group 'org-view-faces) 134 | 135 | (defface org-view-quote-face 136 | '((t :slant italic)) 137 | "Face to display quotes in paragraphs." 138 | :group 'org-view-faces) 139 | 140 | ;;; Implementation 141 | 142 | (defvar org-view-mode-map 143 | (let ((map (make-sparse-keymap))) 144 | (define-key map (kbd "e") #'org-view-edit-on) 145 | (define-key map (kbd "E") #'org-view-edit-on) 146 | (define-key map (kbd "q") #'org-view-quit) 147 | (define-key map (kbd "Q") #'org-view-quit) 148 | map) 149 | "Keymap for ‘org-view-mode’.") 150 | 151 | (defvar org-view-edit-mode-map 152 | (let ((map (make-sparse-keymap))) 153 | (define-key map (kbd "e") #'org-self-insert-command) 154 | (define-key map (kbd "E") #'org-self-insert-command) 155 | (define-key map (kbd "q") #'org-self-insert-command) 156 | (define-key map (kbd "Q") #'org-self-insert-command) 157 | (define-key map (kbd "C-x C-s") #'org-view-save-edit) 158 | (define-key map (kbd "C-x C-q") #'org-view-cancel-edit) 159 | map) 160 | "Keymap for ‘org-view-mode’ when performing quick-edit.") 161 | 162 | (defvar org-view-stars-re "^[ \t]*\\*+" 163 | "Regex used to recognize leading stars in org-headings.") 164 | (defvar org-view-credentials-re "[ \t]*#\\+\\(TITLE\\|AUTHOR\\|EMAIL\\):" 165 | "Regex used to update author and title lines.") 166 | (defvar org-view-markup-re "^[ \t]*#\\+.*$" 167 | "Regex usex to hide markup.") 168 | (defvar org-view-markup-with-agenda-re 169 | "^[ \t]*\\(#\\+\\|DEADLINE:\\|SCHEDULED:\\).*$" 170 | "Regex for markup with agenda keywords.") 171 | (defvar-local org-view--old-point nil 172 | "Keep old point to restore it when quick edit is cancelled.") 173 | (defvar-local org-view--old-content nil 174 | "Copy of buffer to restore it when quick edit is cancelled.") 175 | (defvar-local org-view--old-read-only nil 176 | "Keep the original state of read-only value and restore it after org-view-exit.") 177 | (defvar-local org-view--old-ellipses nil 178 | "Keep the original state of `selective-display' value.") 179 | (defvar-local org-view--old-link-display nil 180 | "Keep the original state of `org-link-display'.") 181 | 182 | (defun org-view--toggle-features (&optional on) 183 | "Toggle each feature ON or off according to customize options." 184 | (if org-view-hide-tags 185 | (org-view--update-tags on)) 186 | (if org-view-prettify-toc 187 | (org-view--update-toc on)) 188 | (if org-view-hide-stars 189 | (org-view--update-stars on)) 190 | (if org-view-hide-keywords 191 | (org-view--update-keywords on)) 192 | (if org-view-hide-properties 193 | (org-view--update-properties on)) 194 | (if org-view-prettify-paragraphs 195 | (org-view--update-paragraphs on)) 196 | (if org-view-prettify-credentials 197 | (org-view--update-credentials on)) 198 | (if org-view-font-enable 199 | (org-view--update-view-font on))) 200 | 201 | (defun org-view--on () 202 | "Properly enter `org-view-mode'." 203 | (add-hook 'change-major-mode-hook #'org-view--off nil t) 204 | (setq org-view--old-read-only buffer-read-only 205 | buffer-read-only t) 206 | (when org-view-hide-ellipses 207 | (unless buffer-displayd-table 208 | (setq buffer-display-table standard-display-table)) 209 | (setq org-view--old-ellipses 210 | (display-table-slot buffer-display-table 'selective-display)) 211 | (set-display-table-slot buffer-display-table 212 | 'selective-display (string-to-vector ""))) 213 | (setq org-view--old-link-display org-link-descriptive) 214 | (unless org-link-descriptive 215 | (org-toggle-link-display)) 216 | (font-lock-ensure 1 (point-max)) 217 | (org-view--toggle-features t)) 218 | 219 | (defun org-view--off () 220 | "Properly exit `org-view-mode'." 221 | (remove-hook 'change-major-mode-hook #'org-view--off t) 222 | (setq buffer-read-only org-view--old-read-only) 223 | (unless (eq org-link-descriptive org-view--old-link-display) 224 | (org-toggle-link-display)) 225 | (if org-view-hide-ellipses 226 | (set-display-table-slot buffer-display-table 227 | 'selective-display 228 | org-view--old-ellipses)) 229 | (org-view--toggle-features)) 230 | 231 | (defun org-view--update-toc (visibility) 232 | "Set invisible property to VISIBILITY for properties in the current buffer." 233 | (org-with-wide-buffer 234 | (save-excursion 235 | (with-silent-modifications 236 | (goto-char (point-min)) 237 | (when (re-search-forward "^:CONTENTS:" nil t) 238 | (put-text-property 239 | (match-end 0) (1- (match-end 0)) 'invisible visibility) 240 | (put-text-property 241 | (match-beginning 0) (1+ (match-beginning 0)) 'invisible visibility) 242 | (when (re-search-forward "^:END:") 243 | (put-text-property 244 | (if (> (match-beginning 0) 1) 245 | (1- (match-beginning 0)) 246 | (match-beginning 0)) 247 | (match-end 0) 'invisible visibility))))))) 248 | 249 | (defun org-view--update-tags (visibility) 250 | "Update invisible property to VISIBILITxxxxx Y for tags in the current buffer." 251 | (save-excursion 252 | (goto-char (point-min)) 253 | (with-silent-modifications 254 | (while (re-search-forward org-view-stars-re nil t) 255 | (goto-char (line-end-position)) 256 | (when (re-search-backward org-tag-line-re (line-beginning-position) t) 257 | (put-text-property 258 | (match-beginning 1) (match-end 1) 'invisible visibility)) 259 | (forward-line))))) 260 | 261 | (defun org-view--update-keywords (visibility) 262 | "Set VISIBILITY for each line starting with a keyword from KEYWORDS list." 263 | (org-with-wide-buffer 264 | (save-excursion 265 | (with-silent-modifications 266 | (goto-char (point-min)) 267 | (let ((hide-markup-re (if org-view-hide-agenda-keywords 268 | org-view-markup-with-agenda-re 269 | org-view-markup-re))) 270 | (while (re-search-forward hide-markup-re nil t) 271 | (goto-char (match-beginning 0)) 272 | (unless (looking-at-p org-view-credentials-re) 273 | (put-text-property 274 | (if (> (match-beginning 0) 1) 275 | (1- (match-beginning 0)) 276 | (match-beginning 0)) 277 | (match-end 0) 'invisible visibility)) 278 | (goto-char (match-end 0)))))))) 279 | 280 | (defun org-view--update-properties (visibility) 281 | "Set invisible property to VISIBILITY for properties in the current buffer." 282 | (org-with-wide-buffer 283 | (save-excursion 284 | (with-silent-modifications 285 | (goto-char (point-min)) 286 | (while (re-search-forward org-property-drawer-re nil t) 287 | (put-text-property 288 | (match-beginning 0) (match-end 0) 'invisible visibility)) 289 | (goto-char (point-min)) 290 | (while (re-search-forward "^[ \t]*#\\+PROPERTY:.*$" nil t) 291 | (let ((beg (if (> (match-beginning 0) 1) 292 | (1- (match-beginning 0)) 293 | (match-beginning 0))) 294 | (end (1+ (match-end 0)))) 295 | (put-text-property beg end 'invisible visibility))))))) 296 | 297 | (defun org-view--update-stars (visibility) 298 | "Update invisible property to VISIBILITY for markers in the current buffer." 299 | (org-with-wide-buffer 300 | (save-excursion 301 | (goto-char (point-min)) 302 | (with-silent-modifications 303 | (while (re-search-forward org-view-stars-re nil t) 304 | (put-text-property 305 | (match-beginning 0) (match-end 0) 'invisible visibility)))))) 306 | 307 | (defun org-view--update-credentials (visibility) 308 | "Set invisible property to VISIBILITY for export settings." 309 | (org-with-wide-buffer 310 | (save-excursion 311 | (with-silent-modifications 312 | (goto-char (point-min)) 313 | (while (re-search-forward org-view-credentials-re nil t) 314 | (put-text-property 315 | (match-beginning 0) (match-end 0) 'invisible visibility) 316 | (when org-view-center-credentials 317 | (let ((left (point)) 318 | (right (line-end-position)) 319 | (width (org-view--fill-column-pixel-width))) 320 | (when (re-search-forward "[ \t]+$" (line-end-position) t) 321 | (setq left (point)) 322 | (put-text-property 323 | (match-beginning 0) (match-end 0) 'invisible visibility)) 324 | (org-view--center-region left right width visibility))) 325 | (forward-line)))))) 326 | 327 | (defun org-view--update-view-font (enable) 328 | "Turn on specialized font settings if `ENABLE' is non-nil." 329 | (if enable 330 | (org-view-font-enable-font) 331 | (org-view-font-disable-font))) 332 | 333 | (defun org-view--fill-column-pixel-width () 334 | "Return width for `fill-column' in pixels. 335 | 336 | This methods works only in buffers with live windows. This function is the only 337 | instance where org-view modifies the content in original buffer - needed to 338 | calculate pixel width of a full line of text. The modification should not be 339 | visible, but there is no guarantee, it really depends on Emacs rendering 340 | algorithms. 341 | 342 | Emacs 29 has function 'string-pixel-width' however it is not avialable in older 343 | versions." 344 | (let ((window (or (get-buffer-window) (selected-window)))) 345 | (when window 346 | (save-excursion 347 | (with-silent-modifications 348 | (let ((width (if (> fill-column 0) 349 | fill-column 350 | org-view-default-fill-column)) 351 | pixel-width) 352 | (goto-char (point-max)) 353 | (insert (make-string width ?\s)) 354 | (goto-char (line-beginning-position)) 355 | (setq pixel-width 356 | (org-view--region-pixel-width 357 | (line-beginning-position) (line-end-position))) 358 | (delete-region (line-beginning-position) (line-end-position)) 359 | pixel-width)))))) 360 | 361 | (defun org-view--region-pixel-size (beg end) 362 | "Calculate pixel-size for a region between BEG and END points." 363 | (save-restriction 364 | (narrow-to-region beg end) 365 | (window-text-pixel-size 366 | (get-buffer-window (current-buffer)) beg end))) 367 | 368 | (defun org-view--region-pixel-width (beg end) 369 | "Calculate width in pixels for a region between BEG and END points. 370 | 371 | This should be cheaper than `string-pixel-width' introduced in recent Emacs 372 | version (29.1), as well as accessible in older Emacs versions. Limitation is 373 | that it works only for completely visible buffer lines." 374 | (car (org-view--region-pixel-size beg end))) 375 | 376 | (defun org-view--center-region (beg end line-width &optional center) 377 | "Render a line bounded by BEG and END centered in a window pixel wise. 378 | 379 | LINE-WIDTH is the pixel width of the base line used to CENTER region against, 380 | typically `fill-column' pixel width, and it assumes width from the left text 381 | area border." 382 | (if center 383 | (let* ((width (org-view--region-pixel-width beg end)) 384 | (spacer (/ (- line-width width) 2))) 385 | (overlay-put 386 | (make-overlay beg (1+ beg)) 387 | 'before-string (propertize " " 'display `(space :width (,spacer))))) 388 | (remove-overlays beg end))) 389 | 390 | ;;; Paragraphs 391 | (defvar org-view-paragraph-beg-re 392 | "^[ \t]*#\\+BEGIN_\\(QUOTE\\|CENTER\\|VERSE\\)[ \t]*$") 393 | (defvar org-view-paragraph-end-re 394 | "^[ \t]*#\\+END_\\(QUOTE\\|CENTER\\|VERSE\\)[ \t]*$") 395 | (defvar org-view--verse-ov nil 396 | "Overlay to prettify display of text marked as verse.") 397 | (defvar org-view--quote-ov nil 398 | "Overlay to prettify display of text marked as quotes.") 399 | (defvar org-view--author-ov nil 400 | "Overlay to prettify display of the author when an author is present.") 401 | (defvar org-view--author-prefix-ov nil 402 | "Overlay to prettify display of the author prefix when an author is present.") 403 | 404 | (defun org-view--line-lengths (beg end) 405 | "Return longest line in region between BEG and END points." 406 | (save-excursion 407 | (let (positions left right) 408 | (goto-char beg) 409 | (while (< (point) end) 410 | (skip-chars-forward " \t") 411 | (setq left (point)) 412 | (goto-char (line-end-position)) 413 | (skip-chars-backward " \t") 414 | (setq right (point)) 415 | (and left right (> (- right left) 0) 416 | (push (cons (- right left) (cons left right)) positions)) 417 | (forward-line)) 418 | positions))) 419 | 420 | (defun org-view--align-paragraph (beg end align) 421 | "Align text in region with the longest line according to the ALIGN parameter. 422 | 423 | BEG and END are start and end of the region. 424 | ALIGN can be one of following: 'left, 'right, 'middle or nil. 425 | Nil value means to remove the alignement." 426 | (save-excursion 427 | (let* ((lines (cl-sort (org-view--line-lengths beg end) #'> :key #'car)) 428 | (longest (car lines)) 429 | (lines (cdr lines)) 430 | indent longest-pixel-width indent-pixel-width) 431 | (cond (align 432 | (goto-char (cadr longest)) 433 | 434 | (cond ((eq align 'left) 435 | (setq indent (buffer-substring-no-properties 436 | (line-beginning-position) (point))) 437 | (dolist (line lines) 438 | (goto-char (cadr line)) 439 | (put-text-property 440 | (line-beginning-position) (point) 'invisible t) 441 | (overlay-put 442 | (make-overlay (line-beginning-position) (point)) 443 | 'before-string indent))) 444 | 445 | ((eq align 'right) 446 | (dolist (line lines) 447 | (setq 448 | indent (org-view--region-pixel-width 449 | (cadr longest) 450 | (+ (cadr longest) (- (car longest) (car line))))) 451 | (goto-char (cadr line)) 452 | (unless (= (char-before) ?\n) 453 | (put-text-property 454 | (line-beginning-position) (point) 'invisible t)) 455 | (unless (= (char-after (cddr line)) ?\n) 456 | (put-text-property 457 | (cddr line) (line-end-position) 'invisible t)) 458 | (overlay-put 459 | (make-overlay (point) (1+ (point))) 'before-string 460 | (propertize " " 'display `(space :width (,indent)))))) 461 | 462 | ((eq align 'middle) 463 | (setq longest-pixel-width 464 | (org-view--region-pixel-width 465 | (cadr longest) (cddr longest)) 466 | indent-pixel-width 467 | (org-view--region-pixel-width 468 | (line-beginning-position) (point))) 469 | (dolist (line lines) 470 | (let* ((length (org-view--region-pixel-width 471 | (cadr line) (cddr line))) 472 | (spacer (+ indent-pixel-width 473 | (/ (- longest-pixel-width length) 2)))) 474 | (goto-char (cadr line)) 475 | (unless (= (char-before) ?\n) 476 | (put-text-property 477 | (line-beginning-position) (point) 'invisible t)) 478 | (goto-char (line-beginning-position)) 479 | (overlay-put 480 | (make-overlay (point) (1+ (point))) 'before-string 481 | (propertize " " 'display `(space :width (,spacer))))))))) 482 | 483 | (t (remove-overlays beg end) 484 | (remove-text-properties beg end '(display t invisible t))))))) 485 | 486 | (defun org-view--prettify-quote (beg end &optional prettify) 487 | "Prettify text in region between BEG and END as quotes. 488 | 489 | PRETTIFY is a boolean flag meaning to add or remove the styling." 490 | (save-excursion 491 | (with-silent-modifications 492 | (if prettify 493 | (setq org-view--quote-ov (make-overlay beg end)) 494 | (remove-overlays beg end)) 495 | (goto-char beg) 496 | (if prettify 497 | (org-view--align-paragraph beg end org-view-quote-align)) 498 | (while (< (point) end) 499 | (cond (prettify 500 | (overlay-put org-view--quote-ov 'face 'org-view-quote-face) 501 | (overlay-put (make-overlay (point) (1+ (point))) 502 | 'before-string org-view-paragraph-indent)) 503 | (t (remove-overlays beg end) 504 | (remove-text-properties beg end '(display t invisible t)))) 505 | (forward-line))))) 506 | 507 | (defun org-view--prettify-verse (beg end &optional prettify) 508 | "Prettify text in region between BEG and END as verses. 509 | 510 | The author name should be separated by three dashes, '---' and put on a separate 511 | line after the paragraph content. 512 | PRETTIFY is a boolean flag meaning to add or remove the styling." 513 | (save-excursion 514 | (goto-char end) 515 | (when (search-backward "---" beg t) 516 | (setq end (line-beginning-position))) 517 | (cond (prettify 518 | (org-view--align-paragraph beg end org-view-verse-align) 519 | (overlay-put (make-overlay beg end) 'face 'org-view-verse-face)) 520 | (t (remove-overlays beg end) 521 | (remove-text-properties beg end '(display t invisible t)))))) 522 | 523 | (defun org-view--prettify-center (beg end &optional pretty) 524 | "Render text in region between BEG and END as centered. 525 | 526 | PRETTY is a boolean flag meaning to add or remove the centering. 527 | 528 | Centering is done according to `fill-column', or current window width if 529 | `fill-column' is nil. This function is the only instance where org-view 530 | modifies the content in original buffer in order to calculate pixel width of a 531 | full line of text. The modification should not be visible, but there is no 532 | guarantee, it really depends on Emacs rendering algorithms." 533 | (save-excursion 534 | (with-silent-modifications 535 | (let ((width (org-view--fill-column-pixel-width)) 536 | left right) 537 | (goto-char beg) 538 | (while (< (point) end) 539 | (when (re-search-forward "^[ \t]+" (line-end-position) t) 540 | (put-text-property 541 | (match-beginning 0) (match-end 0) 'invisible t)) 542 | (setq left (point)) 543 | (goto-char (line-end-position)) 544 | (when (re-search-backward "[ \t]*$" (line-beginning-position) t) 545 | (put-text-property 546 | (match-beginning 0) (match-end 0) 'invisible t)) 547 | (setq right (point)) 548 | (org-view--center-region left right width pretty) 549 | (forward-line)))))) 550 | 551 | (defun org-view--prettify-author (beg end &optional pretty) 552 | "Render author of a quote or verse in custom face. 553 | 554 | BEG and END are start and end of the region to be styled. 555 | PRETTY is a boolean flag meaning to add or remove the styling. 556 | Anything following three dashes to the end of line is recognized as author." 557 | (save-excursion 558 | (goto-char end) 559 | (when (search-backward "---" beg t) 560 | (put-text-property (point) (+ (point) 3) 'invisible pretty) 561 | (setq org-view--author-prefix-ov (make-overlay (point) (+ 3 (point))) 562 | org-view--author-ov (make-overlay (+ 3 (point)) (line-end-position))) 563 | (cond (pretty 564 | (overlay-put 565 | org-view--author-prefix-ov 'before-string org-view-author-prefix) 566 | (overlay-put org-view--author-ov 'face 'org-view-author-face)) 567 | (t (remove-overlays (point) (line-end-position))))))) 568 | 569 | (defun org-view--update-paragraphs (&optional pretty) 570 | "Prettify paragraphs and hide markers. 571 | 572 | PRETTY is a boolean flag meaning to add or remove the styling." 573 | (org-with-wide-buffer 574 | (save-excursion 575 | (with-silent-modifications 576 | (goto-char (point-min)) 577 | (let (beg end type) 578 | (while (re-search-forward org-view-paragraph-beg-re nil t) 579 | (put-text-property 580 | (1- (line-beginning-position)) (line-end-position) 'invisible pretty) 581 | (forward-line) 582 | (setq beg (point)) 583 | (when (re-search-forward org-view-paragraph-end-re nil t) 584 | (put-text-property 585 | (1- (line-beginning-position)) (line-end-position) 'invisible pretty) 586 | (setq end (1- (line-beginning-position))) 587 | (save-excursion 588 | (re-search-backward 589 | "\\(QUOTE\\|VERSE\\|CENTER\\)" (line-beginning-position) t) 590 | (setq type (match-string 0)) 591 | (cond 592 | ((equal "QUOTE" type) 593 | (org-view--prettify-quote beg end pretty)) 594 | ((equal "VERSE" type) 595 | (org-view--prettify-verse beg end pretty)) 596 | ((equal "CENTER" type) 597 | (org-view--prettify-center beg end pretty))) 598 | (org-view--prettify-author beg end pretty))))))))) 599 | 600 | ;;; User commands 601 | 602 | (defun org-view-quit () 603 | "Exit `org-view-mode'." 604 | (interactive) 605 | (org-view-mode -1) 606 | (message "org-view mode disabled in current buffer")) 607 | 608 | (defun org-view-save-edit () 609 | "Save quick edits when in `org-view-mode'." 610 | (interactive) 611 | (save-buffer) 612 | (org-view-edit-off)) 613 | 614 | (defun org-view-cancel-edit () 615 | "Cancel quick edits from `org-view-mode'." 616 | (interactive) 617 | (when (buffer-modified-p) 618 | (erase-buffer) 619 | (insert org-view--old-content) 620 | (org-view--on) 621 | (goto-char org-view--old-point) 622 | (set-buffer-modified-p nil) 623 | (setq buffer-undo-list nil) 624 | (message "Changes aborted")) 625 | (org-view-edit-off)) 626 | 627 | (defun org-view-edit-off () 628 | "Exit org-view quick edit feature." 629 | (interactive) 630 | (when (bound-and-true-p org-view-mode) 631 | (setq inhibit-read-only nil 632 | overriding-local-map nil 633 | org-view--old-content nil) 634 | (org-view--toggle-features t) ;; part after edit ppint loses 635 | ;; org-view-overlays and text props 636 | (message "org-view quick edit disabled in current buffer"))) 637 | 638 | (defun org-view-edit-on () 639 | "Enter org-view quick edit feature." 640 | (interactive) 641 | (when (bound-and-true-p org-view-mode) 642 | (setq inhibit-read-only t 643 | org-view--old-point (point) 644 | overriding-local-map org-view-edit-mode-map 645 | org-view--old-content (buffer-substring (point-min) (point-max))) 646 | (message "org-view edit mode enabled in current buffer"))) 647 | 648 | ;;;###autoload 649 | (define-minor-mode org-view-mode 650 | "Hide/show babel source code blocks on demand." 651 | :global nil :lighter " org-view" :keymap org-view-mode-map 652 | (unless (derived-mode-p 'org-mode) 653 | (error "Not in org-mode")) 654 | (if org-view-mode (org-view--on) (org-view--off))) 655 | 656 | (provide 'org-view-mode) 657 | 658 | ;;; org-view-mode.el ends here 659 | -------------------------------------------------------------------------------- /readme.org: -------------------------------------------------------------------------------- 1 | #+TITLE: org-view-mode 2 | 3 | [[https://melpa.org/packages/org-view-mode-badge.svg]] [[https://img.shields.io/badge/License-GPLv3-blue.svg]] 4 | 5 | This is my attempt to reduce clutter when viewing org-mode files. I think it 6 | looks noisy to look at all the markup, especially in README files when they are 7 | displayed in Dired buffers with my [[https://github.com/amno1/dired-auto-readme][dired-auto-readme]] mode. When viewing 8 | org-files, I am usually mostly interested in the content, not so in 9 | markup. Org-view-mode is an attempt to create a read-only "viewer" mode. Thus 10 | per definition, this minor mode is for consuming org content, not so much for 11 | creating it. It could be actually renamed org-readme-mode, since I have created 12 | it mostly to read README files in git repos without unnecessary noise :-). Also, 13 | don't expect this to work well with org-capture, agendas, etc. 14 | 15 | * Screencast 16 | 17 | [[./images/screencast.gif]] 18 | 19 | * Installation 20 | 21 | ** Melpa 22 | The package is now available from Melpa repository, so if you have Melpa 23 | included in your package archives, you can install org-view-mode either via 24 | built-in Emacs package manager with 25 | 26 | M-x package-install RET org-view-mode RET 27 | 28 | Or if you use use-package you can just do: 29 | 30 | #+begin_src emacs-lisp 31 | (use-package org-view-mode 32 | :ensure t) 33 | #+end_src 34 | 35 | ** Package.el 36 | You can download org-view-mode.el somewhere and use package.el to install file: 37 | M-x package-install-file RET and follow the prompt. 38 | 39 | ** Straight 40 | You may use straight.el to install this package, or some combination of straight & use-package 41 | #+begin_src emacs-lisp 42 | ;; straight.el 43 | (straight-use-package 44 | '(org-view-mode :type git :host github :repo "amno1/org-view-mode")) 45 | 46 | ;; use-package & straight 47 | (use-package org-view-mode 48 | :straight (org-view-mode :type git :host github :repo "amno1/org-view-mode")) 49 | #+end_src 50 | 51 | ** Manual 52 | Either clone this repo or just download 'org-view-mode.el'. 53 | 54 | Put org-view-mode.el somewhere in Emacs load-path. From there you 55 | can just require the file somewhere in your init file or add autoload for 56 | org-view-init mode to your init file. 57 | 58 | * Requirements 59 | 60 | Org-view does not use any external packages. 61 | Minimal Emacs version supported is probably 25.1. 62 | 63 | * Usage 64 | 65 | ** Org-view mode 66 | 67 | M-x org-view-mode to turn it on/off. 68 | 69 | ** Shortcuts 70 | 71 | Org-view-mode uses two mode maps: /org-view-mode-map/ and /org-view-edit-mode-map/. 72 | 73 | The former is active when read-only mode is on, while the latter is active when 74 | quick editing file. There really are not so many actions defines, only two: 75 | enter-edi mode and exit org-view-mode. Of course org-mode map(s) are active all 76 | the time. Maybe at some point in the future I might go through the mode and 77 | choose which ones to enable or disable, but for the current, be aware that 78 | all org-mode shortcuts are active and that some might not work due to read-only 79 | status of the buffer while in org-view-mode. 80 | 81 | ** Fill-column 82 | 83 | Some elements are centered in window in respect to fill-column value. Those are 84 | currently paragraphs marked with begin/end-centered, title, author, and email 85 | address. If fill-column is for some reason /nil/ or invalid (less than 1), 86 | org-view will use the default fill-column of 80 columns. Controlled with: 87 | 88 | /org-view-default-fill-column/ 89 | 90 | variable. Its value can be customized in customize options. 91 | 92 | ** Hiding markup 93 | 94 | Org-view-mode will by default hide any line starting with '#+' to the end of 95 | that line. Also the new line character before that line is hidden, so that there 96 | are no visible empty lines where hidden text is. You can set: 97 | 98 | /org-view-hide-keywords/ 99 | 100 | to nil to disable it. 101 | 102 | In addition to regular markup, even some agenda keywords are hidden: DEFAULT: 103 | and SCHEDULED:. Hiding those can be disabled by setting: 104 | 105 | /org-view-hide-agenda-keywords/ 106 | 107 | to nil. Note that both variables have to be 't in order to hide agenda keywords. 108 | 109 | ** Pretty Credentials 110 | 111 | To disable centering of title, author and email, set 112 | /org-view-prettify-credentials/ to /nil/ value. 113 | 114 | Centering is done with respect to fill-column value. 115 | 116 | Only the /author/ and /email/ keywords are prettified as of currently along with the 117 | /title/ keyword too. Co-authors are not yet prettified and are hidden by default, 118 | as org-view does with other markup. Patch is welcome if someone would like to 119 | implement that. 120 | 121 | ** Hiding ellipses 122 | 123 | By default outline-mode display ellipses instead of hidden text. Org-view-mode 124 | can hide those too. Unfortunately it does not see possible to hide ellipses only 125 | at some places, since it depends on a value in display-table. At least I don't 126 | see how to change it, I have tried to bind selective-display-ellipses and 127 | org-ellipses in various ways in order to hide them, but it does not seem to do 128 | anything. Changing the value in buffer-display-table does the trick, but it is 129 | all or nothing approach. Since it also removes ellipses from headlines, there is 130 | no indication if the content is toggled or not. For that reason the default 131 | value is off. The variable in control is: //org-view-hide-ellipses/. Use it at your 132 | own risk.. 133 | 134 | ** Pretty Headings 135 | 136 | By default org-view-mode hides leading stars in outline headings. You can 137 | disable it by setting /org-view-hide-stars/ to /nil/. 138 | 139 | Hiding tags and properties can be disabled by /setting org-view-hide-tags/ and 140 | /org-view-hide-properties/ to /nil/. 141 | 142 | ** Pretty Quotes and Verses 143 | 144 | Org-view will by default display text marked as /quote/ and /verse/ with their 145 | own face and aligned to the left. To disable paragraph prettification set 146 | /ort-view-prettify-paragraphs/ to /nil/. 147 | 148 | The alignment is done in respect to the longest line in the paragraph. Variables 149 | to control the alignment with are /org-view-quote-align/ and /org-view-verse-align/. 150 | 151 | The control values you can assign to each are: 'left, 'right and 'middle. 152 | 153 | Paragraphs marked with begin/end-center are always aligned in the middle. 154 | The effect of each alignment is shown in the screenshot below: 155 | 156 | [[./images/paragraphs-alignement.png]] 157 | 158 | In quote and verse paragraphs it is also possible to prettify the author if it 159 | is specified. The author should be prefixed with /---/ (three dashes) and 160 | stretches to the end of the buffer line. By default, dashes are replaced with Unicode 161 | drawing characters: ───. This option is controlled with /org-view-author-prefix/. 162 | 163 | Faces used to display quotes, verses and credentials are: 164 | 165 | /org-view-quote-face/, /org-view-verse-face/ and /org-view-author-face/ 166 | 167 | which can all be customized via customize options. 168 | 169 | For other options avialable please see the org-view group in customize: 170 | 171 | M-x customize-group RET org-view 172 | 173 | ** Org View Font 174 | 175 | Org view mode comes with an optional =org-view-font= feature. This gives you the 176 | ability to use a variable pitch/alternate font for reading org documents. 177 | 178 | You may utilize it by customizing the following variables: 179 | 180 | - =org-view-font-enable= to enable/disable the =org-view-font= feature 181 | - =org-view-font-remaps= (alist) to add/remove explicit face settings for org-mode 182 | - =org-view-font-no-remap= (list) to protect specific faces from being remapped 183 | 184 | Use =M-x customize-group org-view-font= to view these customization options in one 185 | view. 186 | 187 | You may also customize the view font with elisp: 188 | 189 | #+begin_src elisp 190 | (require 'org-view-mode) 191 | (setq org-view-font-enable) 192 | (add-to-list 'org-view-font-remaps '(default . (:family "Noto Sans"))) 193 | #+end_src 194 | 195 | ** Add 3rd party mode 196 | 197 | For example, if you would like to enable an additional mode, say org-bullets, 198 | and only in org-view-mode, you can do something like this: 199 | 200 | #+begin_src emacs-lisp 201 | (add-hook 'org-view-mode-hook 202 | (lambda () 203 | (if org-view-mode 204 | (org-bullets-mode +1) 205 | (org-bullets-mode -1))) nil t) 206 | #+end_src 207 | 208 | Org-bullets, replace stars in headings with unicode characters, so in order to 209 | see the bullets in org-mode, you have to tell org-view-mode not to hide stars, 210 | by customizing the org-view-hide-stars to nil. 211 | 212 | Of course, you will have to apropriately load org-bullets somewhere in your init 213 | file as well. 214 | 215 | * Issues 216 | 217 | There might be lots of issues I am not aware of, since I haven't extensively 218 | used this with many org files. 219 | 220 | I would like to hear input, ideas, suggestions and problems found. I don't 221 | promise to implement everything or any at all, but if something can be 222 | implemented relatively easily and is useful, I would like to hear the idea. 223 | Let me know. 224 | 225 | * Special thanks 226 | 227 | I am not a very good user of org-mode myself, so I don't have any org-mode files. 228 | with complex markup of my own, so I have used some from others for both tests 229 | and the screencast above. I would like to thank the authors for putting up their 230 | code and README files and for letting us use them freely, in order of the 231 | appearance in the screencast above, to [[https://github.com/oantolin][Omar Antolín Camarena]] for [[https://github.com/oantolin/orderless][Orderless]], [[https://github.com/takaxp][Takaaki 232 | Ishikawa]] for [[https://github.com/takaxp/moom][moom]], [[https://github.com/protesilaos/mct][Protesilaos Stavrou]] for [[https://github.com/protesilaos/mct][mct]] and [[https://github.com/okamsn][Okamsn]] for [[https://github.com/okamsn/loopy][loopy]]. Thank you. 233 | 234 | * License 235 | 236 | GPL v3. For details, see the attached [[./LICENSE][license file]]. 237 | --------------------------------------------------------------------------------