Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9eff5aadf5 | ||
|
|
b99b967b8f | ||
|
|
3b2c1e3f21 | ||
|
|
1122c1ea37 | ||
|
|
cc998511b6 | ||
|
|
79dd8529ea | ||
|
|
1156d9f34c | ||
|
|
adf01bb7c9 | ||
|
|
19babbda11 |
5
.gitattributes
vendored
5
.gitattributes
vendored
@@ -1,5 +0,0 @@
|
|||||||
# See: https://axvr.io/projects/ascribe/
|
|
||||||
* text=auto eol=lf final-newline trim-trailing-whitespace
|
|
||||||
*.vim line-length=78 expand-tab tab-stop=4
|
|
||||||
doc/*.txt line-length=78 expand-tab tab-stop=4
|
|
||||||
*.org line-length=80 expand-tab tab-stop=4
|
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1 +1,2 @@
|
|||||||
samples/
|
samples/
|
||||||
|
/doc/tags
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ This plugin aims to replicate Vim's [[https://github.com/tpope/vim-markdown/][ex
|
|||||||
editing experience on Org mode (and Outline mode) files, rather than trying to
|
editing experience on Org mode (and Outline mode) files, rather than trying to
|
||||||
be a full featured Org mode plugin—that is what Emacs is for. Originally
|
be a full featured Org mode plugin—that is what Emacs is for. Originally
|
||||||
created so I could use [[https://github.com/orgzly/orgzly-android/][Orgzly]]
|
created so I could use [[https://github.com/orgzly/orgzly-android/][Orgzly]]
|
||||||
without worrying Emacs lock-in.
|
without worrying about Emacs lock-in.
|
||||||
|
|
||||||
*Note*: this project is considered /feature complete/ by the author, so the
|
*Note*: this project is considered /feature complete/ by the author, so the
|
||||||
addition of new features will be unlikely.
|
addition of new features will be unlikely.
|
||||||
@@ -44,14 +44,14 @@ usage information and configuration options.
|
|||||||
|
|
||||||
Different Vim colour schemes will result in different appearances.
|
Different Vim colour schemes will result in different appearances.
|
||||||
|
|
||||||
| [[https://github.com/romainl/Apprentice][Apprentice]] | [[https://github.com/axvr/photon.vim][Photon]] |
|
| [[https://github.com/axvr/raider.vim][Raider]] | Unokai (built-in) |
|
||||||
|--------+------------|
|
|--------+------------|
|
||||||
| [[https://raw.githubusercontent.com/axvr/org.vim/images/apprentice.png]] | [[https://raw.githubusercontent.com/axvr/org.vim/images/photon.png]] |
|
| [[https://raw.githubusercontent.com/axvr/org.vim/images/raider.png]] | [[https://raw.githubusercontent.com/axvr/org.vim/images/unokai.png]] |
|
||||||
|
|
||||||
|
|
||||||
** Licence
|
** Licence
|
||||||
|
|
||||||
Copyright © 2018–2020, Alex Vear.
|
Copyright © 2018–2021, Alex Vear.
|
||||||
|
|
||||||
Org.vim is distributed under the same terms as Vim itself.
|
Org.vim is distributed under the same terms as Vim itself.
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
" Helper functions for org.vim
|
" Helper functions for org.vim
|
||||||
"
|
"
|
||||||
" Maintainer: Alex Vear <av@axvr.io>
|
" Maintainer: Alex Vear <alex@vear.uk>
|
||||||
" License: Vim (see `:help license`)
|
" License: Vim (see `:help license`)
|
||||||
" Location: autoload/org.vim
|
" Location: autoload/org.vim
|
||||||
" Website: https://github.com/axvr/org.vim
|
" Website: https://github.com/axvr/org.vim
|
||||||
|
|||||||
14
doc/org.txt
14
doc/org.txt
@@ -51,7 +51,7 @@ functionality offered by this plugin:
|
|||||||
To control how Org.vim handles folding, just use the standard Vim |folding|
|
To control how Org.vim handles folding, just use the standard Vim |folding|
|
||||||
options and commands.
|
options and commands.
|
||||||
|
|
||||||
For example if you want to enable or disable folding, just set 'foldenable'.
|
For example, if you want to enable or disable folding, just set 'foldenable'.
|
||||||
>
|
>
|
||||||
autocmd FileType org,outline setlocal nofoldenable
|
autocmd FileType org,outline setlocal nofoldenable
|
||||||
<
|
<
|
||||||
@@ -105,7 +105,7 @@ This option can be enabled for all buffers like so:
|
|||||||
>
|
>
|
||||||
let g:org_clean_folds = 1
|
let g:org_clean_folds = 1
|
||||||
<
|
<
|
||||||
Alternatively it can be enabled for specific buffers:
|
Alternatively, it can be enabled for specific buffers:
|
||||||
>
|
>
|
||||||
let b:org_clean_folds = 1
|
let b:org_clean_folds = 1
|
||||||
<
|
<
|
||||||
@@ -120,7 +120,7 @@ the italic variant of your font.
|
|||||||
As some terminals, terminal multiplexers and monospaced fonts don't support
|
As some terminals, terminal multiplexers and monospaced fonts don't support
|
||||||
the use of italics, org.vim provides a mechanism to disable italic text.
|
the use of italics, org.vim provides a mechanism to disable italic text.
|
||||||
|
|
||||||
To disable for all Org mode files place the following line in your vimrc:
|
To disable for all Org mode files, place the following line in your vimrc:
|
||||||
>
|
>
|
||||||
let g:org_use_italics = 0
|
let g:org_use_italics = 0
|
||||||
<
|
<
|
||||||
@@ -137,7 +137,7 @@ Enable/disable syntax highlighting of inline (La)TeX blocks[4]. This option
|
|||||||
exists as some Org mode users don't use TeX and may find the highlighting
|
exists as some Org mode users don't use TeX and may find the highlighting
|
||||||
annoying.
|
annoying.
|
||||||
|
|
||||||
To disable for all Org mode files place the following line in your vimrc:
|
To disable for all Org mode files, place the following line in your vimrc:
|
||||||
>
|
>
|
||||||
let g:org_highlight_tex = 0
|
let g:org_highlight_tex = 0
|
||||||
<
|
<
|
||||||
@@ -153,7 +153,7 @@ Default: 0~
|
|||||||
Enable/disable alphabetical bullets on ordered lists. This is disabled by
|
Enable/disable alphabetical bullets on ordered lists. This is disabled by
|
||||||
default like in Emacs.
|
default like in Emacs.
|
||||||
|
|
||||||
To enable for all Org mode files place the following line in your vimrc:
|
To enable for all Org mode files, place the following line in your vimrc:
|
||||||
>
|
>
|
||||||
let g:org_list_alphabetical_bullets = 1
|
let g:org_list_alphabetical_bullets = 1
|
||||||
<
|
<
|
||||||
@@ -214,14 +214,14 @@ v1.0 [2019-09-28]~
|
|||||||
|
|
||||||
Org.vim is distributed under the same terms as Vim itself.
|
Org.vim is distributed under the same terms as Vim itself.
|
||||||
|
|
||||||
Copyright (c) 2018–2020, Alex Vear.
|
Copyright (c) 2018–2021, Alex Vear.
|
||||||
|
|
||||||
A copy of the full licence text should have been provided with this extension
|
A copy of the full licence text should have been provided with this extension
|
||||||
in the `LICENCE` file. The license can also be viewed on the web [3] or by
|
in the `LICENCE` file. The license can also be viewed on the web [3] or by
|
||||||
viewing the |license| section of the |uganda.txt| help doc from within Vim.
|
viewing the |license| section of the |uganda.txt| help doc from within Vim.
|
||||||
|
|
||||||
Org.vim is based on the work of many other people (far too many to list here),
|
Org.vim is based on the work of many other people (far too many to list here),
|
||||||
without them org.vim would not have been possible. The most notable of thse
|
without them org.vim would not have been possible. The most notable of these
|
||||||
works are:
|
works are:
|
||||||
|
|
||||||
* GNU Emacs' Outline mode [1].
|
* GNU Emacs' Outline mode [1].
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
" Vim filetype detect plugin for GNU Emacs' Org mode
|
" Vim filetype detect plugin for GNU Emacs' Org mode
|
||||||
"
|
"
|
||||||
" Maintainer: Alex Vear <av@axvr.io>
|
" Maintainer: Alex Vear <alex@vear.uk>
|
||||||
" License: Vim (see `:help license`)
|
" License: Vim (see `:help license`)
|
||||||
" Location: ftplugin/org.vim
|
" Location: ftdetect/org.vim
|
||||||
" Website: https://github.com/axvr/org.vim
|
" Website: https://github.com/axvr/org.vim
|
||||||
" Last Change: 2019-09-22
|
" Last Change: 2019-09-22
|
||||||
"
|
"
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
" Vim filetype plugin for GNU Emacs' Org mode
|
" Vim filetype plugin for GNU Emacs' Org mode
|
||||||
"
|
"
|
||||||
" Maintainer: Alex Vear <av@axvr.io>
|
" Maintainer: Alex Vear <alex@vear.uk>
|
||||||
" License: Vim (see `:help license`)
|
" License: Vim (see `:help license`)
|
||||||
" Location: ftplugin/org.vim
|
" Location: ftplugin/org.vim
|
||||||
" Website: https://github.com/axvr/org.vim
|
" Website: https://github.com/axvr/org.vim
|
||||||
" Last Change: 2020-01-04
|
" Last Change: 2020-02-15
|
||||||
"
|
"
|
||||||
" Reference Specification: Org mode manual
|
" Reference Specification: Org mode manual
|
||||||
" GNU Info: `$ info Org`
|
" GNU Info: `$ info Org`
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
" Vim filetype plugin for GNU Emacs' Outline mode
|
" Vim filetype plugin for GNU Emacs' Outline mode
|
||||||
"
|
"
|
||||||
" Maintainer: Alex Vear <av@axvr.io>
|
" Maintainer: Alex Vear <alex@vear.uk>
|
||||||
" License: Vim (see `:help license`)
|
" License: Vim (see `:help license`)
|
||||||
" Location: ftplugin/outline.vim
|
" Location: ftplugin/outline.vim
|
||||||
" Website: https://github.com/axvr/org.vim
|
" Website: https://github.com/axvr/org.vim
|
||||||
|
|||||||
5
samples/links.org
Normal file
5
samples/links.org
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
[[https://google.com]]
|
||||||
|
|
||||||
|
[[https://google.com][Google]]
|
||||||
|
|
||||||
|
Hello [[world]] foo.
|
||||||
52
samples/sample1.org
Normal file
52
samples/sample1.org
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
#+TITLE: Org-mode sample 1
|
||||||
|
|
||||||
|
This is some sample text showing off the org-mode syntax for *bold*, /italic/,
|
||||||
|
_underlined_ and +strike-through+ text.
|
||||||
|
|
||||||
|
Org-mode also has support for single line and block comments.
|
||||||
|
|
||||||
|
# This is a single-line comment; denoted by the # at the beginning of the line.
|
||||||
|
|
||||||
|
#+BEGIN_COMMENT
|
||||||
|
This is a block comment, which is denoted through th use of the delimiters
|
||||||
|
found above and below.
|
||||||
|
#+END_COMMENT
|
||||||
|
|
||||||
|
_this is underline text
|
||||||
|
this is more_
|
||||||
|
|
||||||
|
~verbatim~
|
||||||
|
|
||||||
|
: verbatim
|
||||||
|
|
||||||
|
asasdf ** __
|
||||||
|
_hello world_ something __ _hello_
|
||||||
|
|
||||||
|
_hello world_ _ _ __
|
||||||
|
|
||||||
|
=monospace=
|
||||||
|
|
||||||
|
#+BEGIN_SRC file-type
|
||||||
|
this is a code block
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
#+BEGIN_EXAMPLE
|
||||||
|
some example text
|
||||||
|
#+END_EXAMPLE
|
||||||
|
|
||||||
|
#+SOME_OPTION: This is an org-mode option
|
||||||
|
|
||||||
|
Active date:
|
||||||
|
<2019-03-02 23:44>
|
||||||
|
Inactive date:
|
||||||
|
[2019-03-02 23:44]
|
||||||
|
|
||||||
|
[[https://google.com]]
|
||||||
|
[[https://google.com][Google]]
|
||||||
|
|
||||||
|
* Heading 1
|
||||||
|
** Heading 2
|
||||||
|
*** Heading 3 :tag:
|
||||||
|
**** TODO DONE NEXT DOING Heading 4
|
||||||
|
|
||||||
|
# vim: set spell :
|
||||||
83
samples/sample2.org
Normal file
83
samples/sample2.org
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
#+TITLE: Hello world
|
||||||
|
|
||||||
|
[[hello world][something]] <-- this is a link
|
||||||
|
|
||||||
|
*bold*
|
||||||
|
|
||||||
|
/italic/
|
||||||
|
|
||||||
|
+strikethrough+
|
||||||
|
|
||||||
|
_underline_
|
||||||
|
|
||||||
|
/aasdf *sdfasdf* sadfasdf/
|
||||||
|
|
||||||
|
#+BEGIN_COMMENT
|
||||||
|
hello world this is a comment block
|
||||||
|
#+END_COMMENT
|
||||||
|
|
||||||
|
# comment
|
||||||
|
|
||||||
|
1. Foo bar bz baz this is a /not so/ very long line of text in this vim 8.2
|
||||||
|
buffer.
|
||||||
|
2. Hello world.
|
||||||
|
1. Foo
|
||||||
|
2. Bar
|
||||||
|
|
||||||
|
- foo
|
||||||
|
- bar
|
||||||
|
|
||||||
|
- This is *foo*
|
||||||
|
- A nested listsdf
|
||||||
|
+ Using different asdfasd
|
||||||
|
+ delimiters /fee/
|
||||||
|
|
||||||
|
+ Foo bar bz baz this is a /not so/ very long line of text in this vim 8.2 buffer.
|
||||||
|
|
||||||
|
+ [ ] This is a checkbox.
|
||||||
|
+ [ ] Nested checkbox.
|
||||||
|
+ [X] This is a checked checkbox with really long text to test how wrapping
|
||||||
|
works.
|
||||||
|
+ [ ] Something asdf asdf asdf adfs dsf asdf sadf sadf sadf saf sdf asdf sdf
|
||||||
|
asdf sadf
|
||||||
|
|
||||||
|
# * foo not a list item
|
||||||
|
# * Is a list item
|
||||||
|
|
||||||
|
|
||||||
|
| Table | Column 1 |
|
||||||
|
|-------+----------|
|
||||||
|
| item | _foo_ bar |
|
||||||
|
|
||||||
|
<2003-09-16 Tue 12:00>--<2003-09-16 Tue 12:00>
|
||||||
|
<2003-09-16 Tue>--<2003-09-16 Tue>
|
||||||
|
[2003-09-16 Tue]
|
||||||
|
[2003-09-16 Tue 12:00]--[2003-09-16 Tue 12:00]
|
||||||
|
<2003-09-16 Tue>
|
||||||
|
<2003-09-16 Sáb>
|
||||||
|
<2003-09-16 Tue 12:00-12:30>
|
||||||
|
|
||||||
|
#+asdasdsdfasdf: asdfasd
|
||||||
|
|
||||||
|
~verbatim~
|
||||||
|
: verbatim
|
||||||
|
|
||||||
|
=monospace=
|
||||||
|
|
||||||
|
#+BEGIN_SRC
|
||||||
|
asdfasdfasdf
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
* Hello world
|
||||||
|
** Foo bar
|
||||||
|
*** Something :something_else:
|
||||||
|
|
||||||
|
******** asdfasdf
|
||||||
|
|
||||||
|
hello world
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**** Hello world
|
||||||
|
|
||||||
|
something
|
||||||
45
samples/sample3.org
Normal file
45
samples/sample3.org
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
#+TITLE: This is a title
|
||||||
|
#+Author: Foo bar
|
||||||
|
|
||||||
|
* Heading 1
|
||||||
|
|
||||||
|
This is *bold* text.
|
||||||
|
This is /italic/ text.
|
||||||
|
This is _underlined_ text.
|
||||||
|
This is +strikethrough+ text.
|
||||||
|
This is ~monospace~ text.
|
||||||
|
This is =verbatim= text.
|
||||||
|
|
||||||
|
Link to [[https://www.orgmode.org][Org mode]] website.
|
||||||
|
|
||||||
|
Get Org.vim from here: [[https://github.com/axvr/org.vim]]
|
||||||
|
|
||||||
|
# Comment
|
||||||
|
|
||||||
|
: Verbatim
|
||||||
|
|
||||||
|
#+BEGIN_SRC lisp
|
||||||
|
(if (> 1 2)
|
||||||
|
(print "True")
|
||||||
|
(print "False"))
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
#+BEGIN_COMMENT
|
||||||
|
This is a comment block.
|
||||||
|
#+END_COMMENT
|
||||||
|
|
||||||
|
- Foo.
|
||||||
|
- Bar.
|
||||||
|
+ Biz.
|
||||||
|
1. Hello.
|
||||||
|
2. World.
|
||||||
|
+ Baz.
|
||||||
|
1) Org,
|
||||||
|
2) Mode.
|
||||||
|
|
||||||
|
Time stamps: [2020-03-01] <2020-02-29>
|
||||||
|
|
||||||
|
** TODO Heading 2
|
||||||
|
*** Heading 3 :heading:tags:
|
||||||
|
**** Heading 4
|
||||||
|
and so on...
|
||||||
36
samples/tex.org
Normal file
36
samples/tex.org
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
#+TITLE: Experiment with TeX in Org mode
|
||||||
|
#+OPTIONS: tex:t
|
||||||
|
|
||||||
|
Hello $\alpha$.
|
||||||
|
|
||||||
|
$$\alpha$$
|
||||||
|
|
||||||
|
* Foo $\alpha$
|
||||||
|
|
||||||
|
*foo $\alpha$ bar*
|
||||||
|
|
||||||
|
\neg
|
||||||
|
|
||||||
|
a \begin{equation} % arbitrary environments,
|
||||||
|
x=\sqrt{b} % even tables, figures
|
||||||
|
\end{equation} % etc
|
||||||
|
|
||||||
|
\begin{equation} % arbitrary environments,
|
||||||
|
x=\sqrt{b} % even tables, figures
|
||||||
|
\end{equation} % etc
|
||||||
|
|
||||||
|
\begin{equation} % arbitrary environments,
|
||||||
|
x=\sqrt{b} % even tables, figures
|
||||||
|
\end{equation} % etc
|
||||||
|
|
||||||
|
\begin[asdf]{equation2} % arbitrary environments,
|
||||||
|
x=\sqrt{b} % even tables, figures
|
||||||
|
\end{equation2} % etc
|
||||||
|
|
||||||
|
If $a^2=b$ and \( b=2 \), then the solution must be
|
||||||
|
either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
|
||||||
|
|
||||||
|
$$
|
||||||
|
|
||||||
|
a+=\alpha
|
||||||
|
$$
|
||||||
46
samples/unusual.org
Normal file
46
samples/unusual.org
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
Hello /world/ foo/bar/asdf biz/baz//buz/
|
||||||
|
|
||||||
|
~foo~
|
||||||
|
|
||||||
|
*hello*
|
||||||
|
/_asdf/
|
||||||
|
a/foo/
|
||||||
|
-/foo/
|
||||||
|
#/foo/
|
||||||
|
@/foo/
|
||||||
|
:/foo/
|
||||||
|
_/foo/_
|
||||||
|
+/foo/+
|
||||||
|
3/foo/
|
||||||
|
£/foo/
|
||||||
|
;/foo/
|
||||||
|
,/foo/
|
||||||
|
./foo/
|
||||||
|
*hello*
|
||||||
|
|
||||||
|
/asdföasdf/
|
||||||
|
/öasdf/
|
||||||
|
|
||||||
|
hello /foo
|
||||||
|
bar/
|
||||||
|
|
||||||
|
*Foo. Bar.*
|
||||||
|
|
||||||
|
Biz
|
||||||
|
|
||||||
|
|
||||||
|
Org mode will match unconditionally from first =*= (must be preceded by [- '"(] ) to first one with [ \n\r-'")[}] on the right side.
|
||||||
|
|
||||||
|
|
||||||
|
*Hello
|
||||||
|
asdf world*
|
||||||
|
|
||||||
|
Hello 123468-qwertyuiop[]\aasdfgghjjk;/.,mzxcg!@#$%^&*(*Foo=\\\\]][][[[*asdf]* [asdf*
|
||||||
|
|
||||||
|
Bar
|
||||||
|
|
||||||
|
*Helloa sdf world
|
||||||
|
asdf ** dasf
|
||||||
|
Hello 123468-qwertyuiop[]\aasdfgghjjk;'"/.,mzxcg!@#$%^&*(*Foo=\\\\]][ _asd_ [[*asdf]"**[a*sdf*/
|
||||||
|
|
||||||
|
Bar
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
" Vim syntax file for GNU Emacs' Org mode
|
" Vim syntax file for GNU Emacs' Org mode
|
||||||
"
|
"
|
||||||
" Maintainer: Alex Vear <av@axvr.io>
|
" Maintainer: Alex Vear <alex@vear.uk>
|
||||||
" License: Vim (see `:help license`)
|
" License: Vim (see `:help license`)
|
||||||
" Location: syntax/org.vim
|
" Location: syntax/org.vim
|
||||||
" Website: https://github.com/axvr/org.vim
|
" Website: https://github.com/axvr/org.vim
|
||||||
" Last Change: 2020-01-05
|
" Last Change: 2021-03-11
|
||||||
"
|
"
|
||||||
" Reference Specification: Org mode manual
|
" Reference Specification: Org mode manual
|
||||||
" GNU Info: `$ info Org`
|
" GNU Info: `$ info Org`
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
" Vim syntax file for GNU Emacs' Outline mode
|
" Vim syntax file for GNU Emacs' Outline mode
|
||||||
"
|
"
|
||||||
" Maintainer: Alex Vear <av@axvr.io>
|
" Maintainer: Alex Vear <alex@vear.uk>
|
||||||
" License: Vim (see `:help license`)
|
" License: Vim (see `:help license`)
|
||||||
" Location: syntax/outline.vim
|
" Location: syntax/outline.vim
|
||||||
" Website: https://github.com/axvr/org.vim
|
" Website: https://github.com/axvr/org.vim
|
||||||
" Last Change: 2019-09-28
|
" Last Change: 2020-08-24
|
||||||
"
|
"
|
||||||
" Reference Specification: GNU Emacs Manual, section 'Outline Mode'
|
" Reference Specification: GNU Emacs Manual, section 'Outline Mode'
|
||||||
" GNU Info: `$ info Emacs Outline Mode`
|
" GNU Info: `$ info Emacs Outline Mode`
|
||||||
|
|||||||
Reference in New Issue
Block a user