My notes on emacs' org mode Zintis notes on org-mode in emacs

one , two *, three * etc. are for sections and subsections when in one subsection, can hit m-return or "alt hammer" in slang that will add another element at the same level.

so if you were in a list, and want another list entry alt hammer if you were in a * level, and you want another * entry alt hammer etc.

when in one section and entering a new line, hit tab to align to the correct column if you have inserted text from some other source that is not aligned, you can simply hit tab anywhere on the line, and that line will align itself to the level above it. note: if you are inserting python code as an example, it will mess up the code indents

• i still don't know how to change this behaviour when inputting python code.

use shift-tab repeatedly. it is a toggle.

m-hammer can also be used at any level to create a new line with the same heading

since updating emacs, when i use m-hammer i would get a new top level heading and not a new heading at the current level to fix it i researched the following:

m-hammer is (org-meta-return)

actually it wasn't broken: my meta key had changed from apple 'command' to apple option.

m-down arrow will move the section down m-up arrow will move the section up

• have the cursor somewhere/anywhere in the section, on any section even in a simple paragraph.

note: this works for me in terminal mode, for instance emacs -nw org-mode.org, but in windows mode it works when i am using the \-option key from my mbp keyboard as the meta key

simply square brackets with a space, specifically: minus space bracket space bracket

C-c C-c can be used to assign keywords/(tag) to a heading. any level. you will see a prompt: to enter a tag. this will display a tag on the right side.

orgmode.org is a good web page. specifically handling links as text it is: [ with [link] then [description] ending with ]

c-c c-l to both add a link, and to edit one already there (cursor must be on link)

• i learned this first from here
• pressing c-c c-o to open
• to edit, simply delete the last "]". there are a pair of [][] with a pair [] surround the whole.
• like this: [[link][description] ]
• as soon as you delete the (hidden) last ] is will no longer be a link.
  • edit it, then add the last ] when done and it is back to being a link.

c-u c-c c-l to add link to a file, not just http links.

• so for example, a link to the org-mode reference card using c-u c-c c-l
• if the external link is a local file link, c-c c-o will open the file in a split buffer. how cool is that! c-x b will switch buffers c-x c-b will list buffers.

can link to not just websites.

my emacs eg emacs.org it can also be specific lines in files, like my python elpy in emacs.org

when in the target org file, (or in the current file) at the chosen link, type c-c l for "org-store-link", which was previously set in init.el as follows: (global-set-key (kbd "c-c l") 'org-store-link)

you will see a message "stored: title of the section heading" for whatever the title is on the section heading you pressed c-c l on. that will "store" i.e. copy to clipboard, the target file link.

move to the buffer where you want to insert the link, and c-c c-l as usual except rather than pasting an html link, with description, you can now just hammer the copied file link instead of pasting an html link. then proceed with the description for the file link.

• adding links
• expanding links
• adding links from specific headings in other org files
• Other good youtube links about org mode follow:
• Summarizing file link workflow

If you C-c l a bunch of links, those links are stored in a buffer of links from which you can choose a link when you enter C-c C-l again. C-p and C-n to move between stored links.

Finally, these links do NOT have to be within the same org mode file, or even another org mode file. They could be in any file type. So for example, editing my ~/.emacs.d/init.el file, I can type C-c l and store the link from that file. Then in my .org file I can C-c C-l and past that link.

Here is a link to my init.el web-mode section Clicking on this link in this org mode file, will open that file in a split window buffer. How cool is that?

These next five links are all links to heading within this same file.

Also (global-set-key (kbd "C-c C-l") 'org-insert-link) but this one is default so probably already set.

• C-c l while on a heading, ( link stored in buffer)
• C-c C-l hammer at the link insertion point ( link pasted)
• Just add a description and hammer

Voila!

Result is [ [ *heading ] [ description ] ]

just use delete key when cursor at the end of the link, but not sure if this permanently deletes it or not. C-c C-o to open the link in my default browser. - bloody right good this is.

• org mode has plenty of features.
  • these are just the simplest features with which I have scratch the surface

Harry Swartz

The colours shown for a particular emphasis are specified in the init.el file as follows:

(add-to-list 'org-emphasis-alist '("*" (:foreground "red")))
(add-to-list 'org-emphasis-alist '("~" (:foreground "yellow")))
(add-to-list 'org-emphasis-alist '("=" (:foreground "magenta")))
(setq org-hide-emphasis-markers t)

if type(stringZ)is complex:
    print(" stingz is already complex ")
    return(stringZ)
else:
    stringZ = stringZ[0:-1]        # truncate the last field -1 which is the letter i                                                                           
    liststrings = stringZ.split()  # split into a list of three parts  - to remove the spaces                                                
    liststrings.append("j")        # adds the "j"                                                                                            
    complex_string = ''.join(liststrings) # joins them up again without the spaces                                                      

    return(complex(complex_string))    # converts this string to a complex number                                           

C-c-- or M-x org-ctrl-c-minus

• C-c-- actually does more depending on the context. It also:
• org-table-insert-hline when in a table
• org-toggle-item when somewhere else??
• org-cycle-list-bullet when in a list

The list cycle is as follows: - + * 1. 1)

• another powerful features. I should tag these powerful feartures somehow.

M-x

• org-redisplay-inline-images
• org-display-inline-images
• org-toggle-inline-images
• org-remove-inline-images

In terminal mode moving whole sections works using M-up or M-down where up and down are the up arrow and down arrow respectively.

In terminal mode C-h k then M-down showed me that, ESC <down> (translated from ESC M-O B) runs the command org-metadown (found in org-mode-map), which is an interactive compiled Lisp function in ‘org.el’.

It is bound to <M-down>, ESC <down>, <menu-bar> <Org> <Edit Structure> <Move Subtree Down>, <menu-bar> <Tbl> <Row> <Move Row Down>.

In windows mode, C-h k M-down gives me an error, "ESC-down is undefined" I had to change preferences in my Terminal app, under Profiles and Keyboard The toggle to change is called "Use Option as Meta key". With that set, (and emacs called from within a terminal) M-down worked for me.

just hit M-RET a.k.a. ESC-RETURN a.k.a. "met-hammer"

with text

use vertical bars | between your headings for more space in current table row use TAB

For next row, plain hammer or TAB, then when on next line, at the beginning: | - TAB

start typing, | N a m e | P h o n e | A g e RET | - TAB.

Add "wrap" text within a cell by using M-RETURN

Once the table has as few columns or rows, you can rearrange them very easily by M-up, M-down, M-left, and M-right.

You can add more columns by simply adding more headings separated by "|". There are more capabilites of tables listed here at org-mode.org.

Some common ones:

• C-c SPC (org-table-blank-field) Blank the field at point.
• Hammer (org-table-next-row) Re-align the table and move down to next row. Creates a new row if necessary. At the beginning or end of a line, RET still inserts a new line, so it can be used to split a table.

• M-a (org-table-beginning-of-field) Move to beginning of the current table field, or on to the previous field.
• M-e (org-table-end-of-field) Move to end of the current table field, or on to the next field.

• M-LEFT (org-table-move-column-left) Move the current column left.
• M-RIGHT (org-table-move-column-right) Move the current column right.
• M-S-LEFT (org-table-delete-column) remember M-S means "alt-shift" Kill the current column.
• M-S-RIGHT (org-table-insert-column) Insert a new column to the left of point position.
• M-UP (org-table-move-row-up) Move the current row up.
• M-DOWN (org-table-move-row-down) Move the current row down.

You can also =create a table from scratch with C-c |. You will be asked for the structure of the table, the default being 5x2 (see org-table-default-size), five columns and two rows:

Org mode also lets you convert an existing region into a table. For this, select a region and press C-c | The region could be comma seperated strings.

For example:

heading one, heading two, heading three, heading 4

Selecting that and pressing C-c | then becomes

you want to restrict the width visible width of a cell, you need to add a new row to your table.

Pressing C-c C-c on this table will update the display so that the first and second columns are respectively narrowed to 10 and 15 characters:

When columns are narrowed, it might be useful to temporarily see the content of a cell with C-u <TAB> (or C-u C-c `) or to edit the content in a separate window with C-c `.

If you would like to overrule the automatic alignment of number-rich columns to the right and of string-rich columns to the left, you can use <r>, <c> or <l> in a similar fashion. You may also combine alignment and field width like this: <r10>.

Lines which only contain these formatting cookies are removed automatically upon exporting the document.

C-c C-e will open a minibuffer with all the options to where you can export hit h then o to open html for example

Here is some metadata: with Hashtag colon opptions as follows;

This option specifies that a table of contents, toc, is set to true, t

However, if you don't want a table of contents, specifiy toc:nil Then when exporting to HTML this won't have the table of contents.

you can also export to pdf (latex (l) pdf () )

Other export formats can be added. That can be downloaded by searching packages that start with "ox". ox for "Org eXport." Specifically the next section describes my favourite: ox-twbs

out the org export to twitter boot strap. Now known as bootstrap.

ox-twbs twitter boot strap package, install it, then C-c C-e w o for twitter and open.

ox-gfm package for github flavoured markdown (if you want) org-drill gives you question / answer layouts, and have emacs present them.

Check out org2blog that published to a wordpress site. Check out org-publish that published org docs to a website, a whole tree of org files, and creates an entire website.

When exporting org files into html, verbatim, or highlighted text defaults to white background, red text. Here's how you change it:

First a couple of links: kitchingroup.cheme.cmu.edu has a blog on this.

This post looks promising while in org mode: stackoverflow.com

MobileOrg the automatically created the folder Dropbox/Apps/MobileOrg where it synced any files I created with the MobileOrg app.

Set up your org mode configuration files with this:

;; Set to the location of your Org files on your local system
(setq org-directory "~/eg")
;; Set to the name of the file where new notes will be stored.
;; (setq org-mobile-inbox-for-pull "~/eg/flagged.org")
(setq org-mobile-inbox-for-pull (concat org-directory "/flagged.org"))
;; Set to <your Dropbox root directory>/MobileOrg.
(setq org-mobile-directory "~/Dropbox/MobileOrg")
(setq org-mobile-directory (concat org-directory "~/Dropbox/MobileOrg"))

After restarting emacs/reparsing your configuration, run org-mobile-push. This will copy your Org files to ~/Dropbox/Apps/MobileOrg, which is where MobileOrg will read from.

You can run org-mobile-push by pressing C-c C-x RET p whilst you are in an Org buffer. If you use spacemacs just type: SPC q r

Go back to MobileOrg and click on the Outlines tab at the bottom, then click the Sync button in the upper right.

After capturing notes or making changes on the device to your Org files, be sure to sync in MobileOrg. Then run org-mobile-pull from Emacs to integrate your changes. After integrating, you can run org-mobile-push to make sure MobileOrg has access to the latest version of your files.

Sync items by running org-mobile-push and org-mobile-pull This can be done with the following key sequence:

C-c C-x RET p for push C-c C-x RET g for pull

For an org file to become an agenda file it must be added to the list of files that agenda will keep track of. Not any org file in the current directory or sub-directories will be checked for. I will keep the following files:

• todo.org
• zint-calendar.org

Org agenda view can be reached with M-x org-agenda The most common key-binding to M-x org-agenda is C-c a

Once enabled, M-x org-agenda will show a list of single letter "commands" as follows:

• a Agenda for this week
• t list of all TODO items
• T list of all TODO items specifically with TODO: keyword
• m match a tags/prop/todo query
• M match a tags/prop/todo query restricting to TODO: keyword
• e export agenda view
• s search for keywords
• n Agenda and all TODOs, (new view)

To find another key binding for org-agenda. How about M-g a for "goto agenda" ? It is not taken as of <2020-12-28 Mon>

See details in Customize Key Bindings So, set the key binding like this:

interactively: M-x global-set-key RET M-g a org-agenda RET or just

- (define-key org-mode-map "\C-a" 'move-beginning-of-line) - (define-key org-mode-map "\C-a" 'move-beginning-of-line) - (define-key org-mode-active-map "\C-a" 'some-emacs-function-or-something)

• (define-key org-mode-map "C-c s" 'org-deadline-in-one-week)

In my init.el file I have saved these keyboard macros:

;; setting Zintis org-mode keyboard macros
(fset 'make-bold
   (kmacro-lambda-form [?\C-w ?* ?\C-y ?*] 0 "%d"))
(fset 'make-hlight
   (kmacro-lambda-form [?\C-w ?~ ?\C-y ?~] 0 "%d"))
(fset 'make-underline
   (kmacro-lambda-form [?\C-w ?_ ?\C-y ?_] 0 "%d"))
(fset 'make-verbatim
   (kmacro-lambda-form [?\C-w ?= ?\C-y ?=] 0 "%d"))

So I also added a key binding for these four functions: - (define-key org-mode-map "\C-c b" 'make-bold) - (define-key org-mode-map "\C-c h" 'make-hlight) - (define-key org-mode-map "\C-c u" 'make-underline) - (define-key org-mode-map "\C-c v" 'make-verbatim)

For just in the current major mode, type M-x local-set-key RET M-g a org-agenda RET

You can mark an item as a TODO item by using a 3-way toggle:

• shift-right arrow cycles through TODO, DONE, OFF
• shift-left arrow cycles through OFF, DONE, TODO

Just remember to have the cursor somewhere on the heading itself to cycle

Try it on these task below:

M-S-hammer adds a new TODO or Checkbox item C-S-hammer adds a new TODO or Checkbox item after subtree C-c C-t adds a new TODO (in place of typing TODO: which also works)

With dates, you can schedule todo items C-c C-s inserts a scheduled timestamp, for the heading that your cursor is on

Can create repeating scheduled events by simply adding +1w to the scheduled timestamp. +1w will add that schedule on this day every week. ++1w will ensure your scheduled events will only be in the future

C-c C-d inserts a deadline (that has an automatic date added) This is done on a heading level, apparently no matter at what level the heading is.

Select the date, then hammer Could also try C-c . which is a time stamp for today's date.

When you are editing an org file that has been added to your agenda files, (see Add a file to agenda list ) and you subsequently hit M-g a then the screen will split into 2. You can use Shift-f to have your cursor "follow" where you are in the agenda view, and so quickly edit each item as needed, and add more info or whatever.

C-c . prompt for timestamp (default is today, no time stamp) C-u C-c . today with timestamp C-c C-d deadline C-c C-s scheduled C-c C-y calculate time between 2 dates in the time range

Can then adjust timestamps (both scheduled and deadline) S-RIGHT/LEFT on a timestamp adds/subtracts 1 day S-UP/DOWN on a timestamp adds/subtracts 1 month/year

Useful for working on contract:

all of which will act on the heading where your cursor is on:

• Shift-right-arrow 3-way toggle for TODO
• Shift-left-arrow 3-way toggle for TODO (reverse direction)
• C-c C-s to schedule
• C-c C-d to pick a deadline
• C-a A to enter agenda view (or is it just C-a ? where ? is one of many commands, the most common being a,t, and ?)
• Shift-f to switch to follow-me mode screen will split into 2 and where you place your cursor on the agenda or todo screen will cause the cursor to jump to that spot on the actual org mode in the "other" screen. Convenient to see the detailed notes for each TODO items and jump between them.
• F or B to jump forward or backward
• q to quit agenda mode.

After you run one of these commands on the heading, you won't see the results unless you expand the heading (use <TAB> )

After you create a time stamp, you can manually edit it, add a specific time, etc. These times can be simple timestamps, or a range of time. For example: DEADLINE: <2020-12-28 Mon 21:00>–<2020-12-28 Mon 21:45>

You can enter a calendar anywhere by C-c .

, and you can

(setq org-capture-templates
  `(("t" "Tasks / Projects")
    ("tt" "Task" entry (file+olp "~/Projects/Code/orgFiles/tasks.org" "Inbox")
         "* TODO %?\n  %U\n  %a\n  %i" :empty-lines 1)))

• %? is where the cursor is placed in the capture template
• %U gives a timestamp
• %a gives you the link to wherever you are in emacs (including heading)
• %i is the item. (or is %a and %i switched around? read the docs and update here)

The whole org-mode section follows:

(setq org-capture-templates
  `(("t" "Tasks / Projects")
    ("tt" "Task" entry (file+olp "~/Projects/Code/emacs-from-scratch/OrgFiles/Tasks.org" "Inbox")
         "* TODO %?\n  %U\n  %a\n  %i" :empty-lines 1)

    ("j" "Journal Entries")
    ("jj" "Journal" entry
         (file+olp+datetree "~/Projects/Code/emacs-from-scratch/OrgFiles/Journal.org")
         "\n* %<%I:%M %p> - Journal :journal:\n\n%?\n\n"
         ;; ,(dw/read-file-as-string "~/Notes/Templates/Daily.org")
         :clock-in :clock-resume
         :empty-lines 1)
    ("jm" "Meeting" entry
         (file+olp+datetree "~/Projects/Code/emacs-from-scratch/OrgFiles/Journal.org")
         "* %<%I:%M %p> - %a :meetings:\n\n%?\n\n"
         :clock-in :clock-resume
         :empty-lines 1)

    ("w" "Workflows")
    ("we" "Checking Email" entry (file+olp+datetree "~/Projects/Code/emacs-from-scratch/OrgFiles/Journal.org")
         "* Checking Email :email:\n\n%?" :clock-in :clock-resume :empty-lines 1)

    ("m" "Metrics Capture")
    ("mw" "Weight" table-line (file+headline "~/Projects/Code/emacs-from-scratch/OrgFiles/Metrics.org" "Weight")
     "| %U | %^{Weight} | %^{Notes} |" :kill-buffer t)))

There is a built-in sub-mode that comes with org-mode called org-habit but it is not activated by default. So you need to add it to init.el setup, and also add it the the org-modules list. That way org-mode will

(require 'org-habit)
(add-to-list 'org-modules 'org-habit)
(setq org-habit-graph-column 60)

For details, see orgmode.org/manual

Full org mode setup:

 (use-package org
:pin org
:hook (org-mode . efs/org-mode-setup)
:config
(setq org-ellipsis " ▾")

(setq org-agenda-start-with-log-mode t)
(setq org-log-done 'time)
(setq org-log-into-drawer t)

(setq org-agenda-files
      '("~/Projects/Code/emacs-from-scratch/OrgFiles/Tasks.org"
        "~/Projects/Code/emacs-from-scratch/OrgFiles/Habits.org"
        "~/Projects/Code/emacs-from-scratch/OrgFiles/Birthdays.org"))

(require 'org-habit)
(add-to-list 'org-modules 'org-habit)
(setq org-habit-graph-column 60)

(setq org-todo-keywords
  '((sequence "TODO(t)" "NEXT(n)" "|" "DONE(d!)")
    (sequence "BACKLOG(b)" "PLAN(p)" "READY(r)" "ACTIVE(a)" "REVIEW(v)" "WAIT(w@/!)" "HOLD(h)" "|" "COMPLETED(c)" "CANC(k@)")))

(setq org-refile-targets
  '(("Archive.org" :maxlevel . 1)
    ("Tasks.org" :maxlevel . 1)))

;; Save Org buffers after refiling!
(advice-add 'org-refile :after 'org-save-all-org-buffers)

(setq org-tag-alist
  '((:startgroup)
     ; Put mutually exclusive tags here
     (:endgroup)
     ("@errand" . ?E)
     ("@home" . ?H)
     ("@work" . ?W)
     ("agenda" . ?a)
     ("planning" . ?p)
     ("publish" . ?P)
     ("batch" . ?b)
     ("note" . ?n)
     ("idea" . ?i)))

You can turn on auto indent with the command: M-x org-indent-mode To test if you have it on, run M-x describe-variable org-indent-mode Could also be org-startup-indented so (defcustom org-startup-indented t) (or nil)

Or, on a per-file basis using #+STARTUP: indent

org-indent-mode is an autoloaded interactive LISP function in org-indent.el