211 lines
6.6 KiB
Markdown
211 lines
6.6 KiB
Markdown
(TAB to open bullets)
|
|
|
|
emacs org mode
|
|
==============
|
|
|
|
README
|
|
------
|
|
|
|
The purpose of this guide is to provide a minimalist onboarding for the
|
|
use or emacs org mode specifically for anarchy planet projex and dox.
|
|
|
|
There are three basic things that are useful about org mode:
|
|
|
|
1. It is PLAINTEXT ALL THE WAY BABY!
|
|
2. bullets are collapsible which makes it really easy to organize shit
|
|
and move it around collapsible items rule!
|
|
3. TODO items have a lot of functionality (e.g. agenda)
|
|
|
|
The longer-term goal is to convert ap/projex pads to org mode. see
|
|
*org-pandoc* for more info.
|
|
|
|
### emacs keyboard shortcuts
|
|
|
|
Written as, e.g., C-x C-f, which means CTRL-c CTRL-f (in succession) M-x
|
|
means META-x. the META key is (usually) ALT
|
|
<https://orgmode.org/orgcard.pdf> is a decent cheatsheet!
|
|
|
|
### Headings
|
|
|
|
Place a \* in front of some text: you've got a heading! Place \*\* in
|
|
front of some text: you've got a sub-heading! Headings are COLLAPSIBLE:
|
|
with cursor over a heading, hit TAB Headings can be moved around easily
|
|
|
|
- M-<enter> to add new heading
|
|
- M-<left> or M-<right> to promote / demote heading
|
|
|
|
### TODOs
|
|
|
|
Make a heading followed by the word TODO: you've got a todo item!
|
|
|
|
1. DONE demo emacs org mode
|
|
|
|
2. DONE enable line wrap as default
|
|
|
|
3. TODO re-write projex in org mode style
|
|
|
|
projex~demo~.org is the test run of this.
|
|
|
|
- C-c C-t to cycle through todo-done
|
|
- You can add more options by adding \#+TODO: TODO ONHOLD | DONE
|
|
to the top of the page (requires restart)
|
|
|
|
### advanced
|
|
|
|
1. links
|
|
|
|
- link structure: \[ \[link\]\[desc\] \] (but without the spaces)
|
|
- [file](test.org) C-c C-o to open at point this creates a split
|
|
buffer. C-x o to switch between split buffers, C-x 1 to return
|
|
the buffer to a single one.
|
|
|
|
2. agenda mode
|
|
|
|
<https://orgmode.org/worg/org-tutorials/orgtutorial_dto.html> is a
|
|
good tut.
|
|
|
|
notes
|
|
-----
|
|
|
|
### useful things overview
|
|
|
|
So there are two basic things that are useful about org mode:
|
|
|
|
1. bullets are collapsible which makes it really easy to organize shit
|
|
and move it around collapsible items rule!
|
|
2. TODO items have a lot of functionality
|
|
|
|
The goal is to take projex~demo~.org (another file in this directory)
|
|
and format it into org mode. The **reason** is that then we can export
|
|
it using pandoc with clean html (which we can add a loittle styling etc)
|
|
.. . once we have a format established, we can loosely require people to
|
|
add to pads in that format so that chhanges can be git pushed and
|
|
incorportated into the html. You can see an example of what the raw html
|
|
looks like here: <https://irc.anarchyplanet.org/dox/org.html>
|
|
|
|
(I think it's a good strategy to hit enter like this when we're done
|
|
typing :) )
|
|
|
|
### Switching between emacs 'buffers' (where different documents are open in the same emacs instance)
|
|
|
|
- to open projex~demo~.org: C-x C-f and then start typing proj and
|
|
then TAB (for autocomplete)
|
|
|
|
- use C-x <left> and use C-x <right> to switch
|
|
between buffers.
|
|
|
|
### making bullets
|
|
|
|
So, I guess my first question is about how I make the bullets?
|
|
|
|
1. like this
|
|
|
|
1. this is a sub-level
|
|
|
|
Ok I'll give that a shot
|
|
|
|
So to "attach" the bullet to the text under it, do I just add
|
|
asterisks to the text?
|
|
|
|
like this:
|
|
|
|
2. Bullet
|
|
|
|
This is the text under it!
|
|
|
|
Damn that's east's easy :)
|
|
|
|
yeah! and, you can do it with all kinds of list items, and it's also
|
|
especially useful when you have long passages of text that you can
|
|
just hide by pressing TAB.
|
|
|
|
Perfect :) So, I might try to just "bullet" this conversation. So I
|
|
think what I did there makes sense in terms of how I organized that?
|
|
|
|
YEAH! One more thing:
|
|
|
|
to make new bullets you can do ALT-enter (ALT is known as M ,
|
|
so M-<enter>)
|
|
|
|
3. bullet1
|
|
|
|
4. bullet 3
|
|
|
|
5. bullet 2
|
|
|
|
6. bullet 4
|
|
|
|
and then, to change the order, you can use M-<up> and
|
|
M-<down> ... to promote you can use M-<left> and
|
|
M-<right> (but this gets more complicated when you have
|
|
sub-trees, so we'll worry about that layter beucause that's what I'm
|
|
having problems with re; my keybindings)
|
|
|
|
Note for noobs: You have to have the cursor under the bullet tomove
|
|
your text, not the text itself.
|
|
|
|
Edit this guide: <https://irc.anarchyplanet.org/pad/p/dox-emacs>
|
|
|
|
### code syntax highlighting and evaluation
|
|
|
|
emacs provides support for lots of languages and you can start an
|
|
interpreter and run code with C-c C-c (evaluate buffer)
|
|
|
|
You can also do code blocks and tangle / weave for literate programming.
|
|
|
|
My friend always used indent region and it was impressingly fast
|
|
|
|
### org-pandoc
|
|
|
|
The **reason** to use org-mode is to provide a minimal amount of
|
|
functionality for organizing documents in plaintext that then can be
|
|
exported using pandoc with clean html (which we can add a little styling
|
|
etc) .. . once we have a format established, we can loosely require
|
|
people to add to pads in that format so that chhanges can be git pushed
|
|
and incorportated into the html. You can see an example of what the raw
|
|
html looks like here: <https://irc.anarchyplanet.org/dox/org.html>
|
|
|
|
### using org mode for IRC
|
|
|
|
how can i restart and save session? (keep buffers)
|
|
|
|
there's M-x revert-buffer or you can turn auto-revert-mode on so it will
|
|
reload every time the file changes. I've never used the second... rarely
|
|
the first, I always just close :P so i don't need to save it? it
|
|
members? no, you would have to save it. I always just do C-x C-c (closes
|
|
all buffers) and save them all. I blieve if you try to revert-buffer it
|
|
will prompt you to save. Do i do this after restarting or before? C-c
|
|
C-s saves all buffers, C-c C-c exits.
|
|
|
|
M-x package-install circe <enter> M-x circe <enter> Can i
|
|
set a socks proxy? I am not sure... I don't understand all that v. well.
|
|
|
|
last year i read an article/list post how outdated emacs' networking is
|
|
and RMS agreed. i think the thread went viral ..
|
|
|
|
could be!
|
|
<https://stackoverflow.com/questions/19699294/make-emacs-access-to-https-over-socks-proxy>
|
|
|
|
I was just gonna paste this :P
|
|
|
|
how do i get into config mode?
|
|
|
|
do you mean the customize emacs thing?
|
|
|
|
to set socks-noproxy or socks-server. the config file ..
|
|
|
|
the config file is at \~/.emacs you can also change \~/.emacs.d/init.el
|
|
|
|
Thanks, i changed my mind and prefer to keep my sanity!
|
|
|
|
re: tor: we should use it for w3m tho, yah?
|
|
|
|
sure, always. :) does emacs mind if we take aways some sycalls from it?
|
|
|
|
essential keys
|
|
==============
|
|
|
|
C-x 1 to return buffer to 1 window C-g to cancel a command C-h a to
|
|
search for commands tiling window: C-x \[1..3\] C-k cut C-y paste show
|
|
only headlines: navigate to first heading and do C-c C-k
|