https://github.com/integral-dw/org-menu-mode

Hide verbose Org syntax behind menus.
https://github.com/integral-dw/org-menu-mode

Last synced: 18 days ago
JSON representation

Hide verbose Org syntax behind menus.

• Host: GitHub
• URL: https://github.com/integral-dw/org-menu-mode
• Owner: integral-dw
• License: gpl-3.0
• Created: 2020-02-20T18:32:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-07T23:40:45.000Z (almost 5 years ago)
• Last Synced: 2023-03-07T11:32:57.224Z (almost 2 years ago)
• Language: Emacs Lisp
• Homepage:
• Size: 88.9 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+TITLE: Org Menu Mode

* WARNING

  This package is under construction.  Once again, I am busy working

  out the kinks.  *Any function and variable defined here is subject to

  change* until version 1.0.0, from which point on I will try my best

  not to inconvenience people.  See below for announcements regarding

  the current state of affairs.

  *Remark:* This package is not yet in what I would consider a complete

  first draft state.  It will take a little while before this package

  is even usable for testing purposes.

* NEWS

** =2019-02-23=

   The project is now public.  The package is not yet in a working

   first draft state, but it compiles, survives ~checkdoc~'s scrutiny

   and runs through ~package-lint~ without problem.  Now I just have to

   keep it that way.

** =2019-03-01=

   Currently, the package is split across three files to ease the task

   of maintaining the structure of the code.  The three files in

   question are:

   * =org-menu.el= :: The main body.

   * =org-menu-fl.el= :: A collection of low-level buffer operations.

   * =org-menu-simple.el= :: A friendlier interface for the above.

   The features implemented now are working comparably well, but still

   behave weird in some edge cases (in particular, random point

   movement occasionally confusing the mode).  I will have to do some

   "field-testing" to properly pin down the oddities.  Once that

   works, I will promote the package to a "first draft" (version

   *0.1.0*).

* About

** Origins

  This package is [[https://pank.eu/blog/pretty-babel-src-blocks.html][based on a brilliant blog post from Rasmus Pank Roulund]],

  where he formulated a ~prettify-symbols~-based set of functions that

  hide away Org's ~#+BEGIN_BLOCK~ -- ~#+END_BLOCK~ syntax behind a

  [[https://en.wikipedia.org/wiki/Semigraphics][semi-graphical]] interface.  The author expressed dissatisfaction with

  the limitations of ~prettify-symbols-mode~, such as being restricted

  to literal matches (as opposed to regex).  This inspired me to take

  a closer look at how Prettify Symbols is actually implemented within

  ~font-lock~, and how I can make use of it's principles while still

  being able to diverge from it.

#  LocalWords:  MELPA ELPA Worg fontification TODO README Org's