pali112/org.vim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Relicence under the Vim licence, add legal info and update file headers

Browse Source
This commit is contained in:
Alex Vear
2019-09-22 18:01:36 +01:00
parent 3f9b6c5977
commit c47ffd4ec6
9 changed files with 192 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
LICENCE
View File

@@ -1,15 +1,88 @@
ISC License Copyright (c) 2018-2019, Alex Vear.
Copyright (c) 2019, Alex Vear Org.vim is distributed under the same terms as Vim itself.
Permission to use, copy, modify, and/or distribute this software for any The text below is a copy of the Vim license, the full license is shipped with
purpose with or without fee is hereby granted, provided that the above Vim and can be viewed on the web [0] or by invoking `:help license` from within
copyright notice and this permission notice appear in all copies. Vim.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES [0]: <http://vimdoc.sourceforge.net/htmldoc/uganda.html#license>
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR VIM LICENSE
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN I) There are no restrictions on distributing unmodified copies of Vim except
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF that they must include this license text. You can also distribute
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. unmodified parts of Vim, likewise unrestricted except that they must
include this license text. You are also allowed to include executables
that you made from the unmodified Vim sources, plus your own usage
examples and Vim scripts.
II) It is allowed to distribute a modified (or extended) version of Vim,
including executables and/or source code, when the following four
conditions are met:
1) This license text must be included unmodified.
2) The modified Vim must be distributed in one of the following five ways:
a) If you make changes to Vim yourself, you must clearly describe in
the distribution how to contact you. When the maintainer asks you
(in any way) for a copy of the modified Vim you distributed, you
must make your changes, including source code, available to the
maintainer without fee. The maintainer reserves the right to
include your changes in the official version of Vim. What the
maintainer will do with your changes and under what license they
will be distributed is negotiable. If there has been no negotiation
then this license, or a later version, also applies to your changes.
The current maintainer is Bram Moolenaar <Bram@vim.org>. If this
changes it will be announced in appropriate places (most likely
vim.sf.net, www.vim.org and/or comp.editors). When it is completely
impossible to contact the maintainer, the obligation to send him
your changes ceases. Once the maintainer has confirmed that he has
received your changes they will not have to be sent again.
b) If you have received a modified Vim that was distributed as
mentioned under a) you are allowed to further distribute it
unmodified, as mentioned at I). If you make additional changes the
text under a) applies to those changes.
c) Provide all the changes, including source code, with every copy of
the modified Vim you distribute. This may be done in the form of a
context diff. You can choose what license to use for new code you
add. The changes and their license must not restrict others from
making their own changes to the official version of Vim.
d) When you have a modified Vim which includes changes as mentioned
under c), you can distribute it without the source code for the
changes if the following three conditions are met:
- The license that applies to the changes permits you to distribute
the changes to the Vim maintainer without fee or restriction, and
permits the Vim maintainer to include the changes in the official
version of Vim without fee or restriction.
- You keep the changes for at least three years after last
distributing the corresponding modified Vim. When the maintainer
or someone who you distributed the modified Vim to asks you (in
any way) for the changes within this period, you must make them
available to him.
- You clearly describe in the distribution how to contact you. This
contact information must remain valid for at least three years
after last distributing the corresponding modified Vim, or as long
as possible.
e) When the GNU General Public License (GPL) applies to the changes,
you can distribute the modified Vim under the GNU GPL version 2 or
any later version.
3) A message must be added, at least in the output of the ":version"
command and in the intro screen, such that the user of the modified Vim
is able to see that it was modified. When distributing as mentioned
under 2)e) adding the message is only required for as far as this does
not conflict with the license used for the changes.
4) The contact information as required under 2)a) and 2)d) must not be
removed or changed, except that the person himself can make
corrections.
III) If you distribute a modified version of Vim, you are encouraged to use
the Vim license for your changes and make them available to the
maintainer, including the source code. The preferred way to do this is
by e-mail or by uploading the files to a server and e-mailing the URL.
If the number of changes is small (e.g., a modified Makefile) e-mailing a
context diff will do. The e-mail address to be used is
<maintainer@vim.org>
IV) It is not allowed to remove this license from the distribution of the Vim
sources, parts of it or from a modified version. You may use this
license for previous Vim releases instead of the license that they came
with, at your option.

18
README.md
View File

@@ -1,9 +1,21 @@
# Org-mode syntax highlighting for Vim # Org mode and Outline mode syntax highlighting for Vim
Org.vim is a minimal [Org-mode](https://orgmode.org/) plugin for Org.vim is a minimal [Org mode](https://orgmode.org/) plugin for
[Vim](https://www.vim.org/). It provides only the absolute necessities (e.g. [Vim](https://www.vim.org/). It provides only the absolute necessities (e.g.
syntax highlighting and folding) at a high standard. syntax highlighting and folding) at a high standard.
The main goal of this plugin is to replicate [Vim's default The main goal of this plugin is to replicate [Vim's default
Markdown](https://github.com/tpope/vim-markdown/) editing experience for Markdown](https://github.com/tpope/vim-markdown/) editing experience for
Org-mode files. Org mode files.
## Licence
Copyright (c) 2018-2019, Alex Vear.
Org.vim is distributed under the same terms as Vim itself.
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][] or by
invoking `:help license` from within Vim.
[web]: <http://vimdoc.sourceforge.net/htmldoc/uganda.html#license>

34
doc/org.txt
View File

@@ -1,24 +1,26 @@
*org.txt* A minimal Org-mode package providing only the necessities. *org.txt* A minimal Org mode package providing only the necessities.
Org.vim Manual by Alex Vear~ Org.vim Manual by Alex Vear~
Welcome to the org.vim user manual. *org* *org.vim* *vim-org* Welcome to the org.vim user manual. *org* *org.vim* *vim-org* *outline*
1. Introduction ............................... |org-intro| 1. Introduction ............................... |org-intro|
2. Installation ............................... |org-install| 2. Installation ............................... |org-install|
3. Basic syntax ............................... |org-syntax| 3. Basic syntax ............................... |org-syntax|
4. Configuration .............................. |org-configuration| 4. Configuration .............................. |org-configuration|
5. Legal ...................................... |org-legal|
6. References ................................. |org-references|
============================================================================== ==============================================================================
1. INTRODUCTION *org-intro* 1. INTRODUCTION *org-intro*
Org.vim is a minimal Org-mode package for Vim. It provides only the absolute Org.vim is a minimal Org mode package for Vim. It provides only the absolute
necessities (e.g. syntax highlighting and folding) at a high standard. necessities (e.g. syntax highlighting and folding) at a high standard.
The main goal of this package is to replicate Vim's default Markdown editing The main goal of this package is to replicate Vim's default Markdown editing
experience for Org-mode files. experience for Org mode files.
============================================================================== ==============================================================================
2. INSTALLATION *org-install* 2. INSTALLATION *org-install*
@@ -71,5 +73,29 @@ To disable this feature place the following line in your vimrc:
> >
let g:org_highlight_table_background = 0 let g:org_highlight_table_background = 0
< <
==============================================================================
5. LEGAL *org-legal*
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 works are:
* GNU Emacs' Outline mode [1].
* Carsten Dominik's Org mode [2].
Org.vim is distributed under the same terms as Vim itself.
Copyright (c) 2018-2019, Alex Vear.
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
viewing the |license| section of the |uganda.txt| help doc from within Vim.
==============================================================================
6. REFERENCES *org-references*
[1]: <https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html>
[2]: <https://orgmode.org/>
[3]: <http://vimdoc.sourceforge.net/htmldoc/uganda.html#license>
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
vim:et:ts=8:sts=4:sw=4:tw=78:ft=help:norl: vim:et:ts=8:sts=4:sw=4:tw=78:ft=help:norl:

16
ftdetect/org.vim
View File

@@ -1,7 +1,13 @@
" ============================================================= " Vim filetype detect plugin for GNU Emacs' Org mode
" Description: Detect Org-mode files "
" Author: Alex Vear (axvr) <av@axvr.io> " Maintainer: Alex Vear <av@axvr.io>
" Licence: ISC (2018) " License: Vim (see `:help license`)
" ============================================================= " Location: ftplugin/org.vim
" Website: https://github.com/axvr/org.vim
" Last Change: 2019-09-22
"
" Reference Specification: Org mode manual
" GNU Info: `$ info Org`
" Web: <https://orgmode.org/manual/index.html>
autocmd BufRead,BufNewFile *.org setfiletype org autocmd BufRead,BufNewFile *.org setfiletype org

16
ftplugin/org.vim
View File

@@ -1,8 +1,14 @@
" ============================================================= " Vim filetype plugin for GNU Emacs' Org mode
" Description: Configure Org-mode folding "
" Author: Alex Vear (axvr) <av@axvr.io> " Maintainer: Alex Vear <av@axvr.io>
" Licence: ISC (2019) " License: Vim (see `:help license`)
" ============================================================= " Location: ftplugin/org.vim
" Website: https://github.com/axvr/org.vim
" Last Change: 2019-09-22
"
" Reference Specification: Org mode manual
" GNU Info: `$ info Org`
" Web: <https://orgmode.org/manual/index.html>
setlocal conceallevel=2 setlocal conceallevel=2
setlocal concealcursor=nc setlocal concealcursor=nc

16
ftplugin/outline.vim
View File

@@ -1,8 +1,14 @@
" ============================================================= " Vim filetype plugin for GNU Emacs' Outline mode
" Description: Folding for GNU Emacs' Outline mode "
" Author: Alex Vear (axvr) <av@axvr.io> " Maintainer: Alex Vear <av@axvr.io>
" Licence: ISC (2019) " License: Vim (see `:help license`)
" ============================================================= " Location: ftplugin/outline.vim
" Website: https://github.com/axvr/org.vim
" Last Change: 2019-09-22
"
" Reference Specification: GNU Emacs Manual, section 'Outline Mode'
" GNU Info: `$ info Emacs Outline Mode`
" Web: <https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html>
function! OutlineFold() function! OutlineFold()
let l:depth = match(getline(v:lnum), '\(^\*\+\)\@<=\( .*$\)\@=') let l:depth = match(getline(v:lnum), '\(^\*\+\)\@<=\( .*$\)\@=')

12
plugin/org.vim
View File

@@ -1,8 +1,10 @@
" ============================================================= " Set default configuration options for org.vim
" Description: Set default config options for org.vim "
" Author: Alex Vear (axvr) <av@axvr.io> " Maintainer: Alex Vear <av@axvr.io>
" Licence: ISC (2019) " License: Vim (see `:help license`)
" ============================================================= " Location: plugin/org.vim
" Website: https://github.com/axvr/org.vim
" Last Change: 2019-09-22
if !exists('g:org_state_keywords') if !exists('g:org_state_keywords')
let g:org_state_keywords = ['TODO', 'NEXT', 'DONE'] let g:org_state_keywords = ['TODO', 'NEXT', 'DONE']

16
syntax/org.vim
View File

@@ -1,8 +1,14 @@
" ============================================================= " Vim syntax file for GNU Emacs' Org mode
" Description: Basic Org-mode syntax highlighting "
" Author: Alex Vear (axvr) <av@axvr.io> " Maintainer: Alex Vear <av@axvr.io>
" Licence: ISC (2019) " License: Vim (see `:help license`)
" ============================================================= " Location: syntax/org.vim
" Website: https://github.com/axvr/org.vim
" Last Change: 2019-09-22
"
" Reference Specification: Org mode manual
" GNU Info: `$ info Org`
" Web: <https://orgmode.org/manual/index.html>
if exists("b:current_syntax") if exists("b:current_syntax")
finish finish

16
syntax/outline.vim
View File

@@ -1,8 +1,14 @@
" ============================================================= " Vim syntax file for GNU Emacs' Outline mode
" Description: Syntax file for GNU Emacs' Outline mode "
" Author: Alex Vear (axvr) <av@axvr.io> " Maintainer: Alex Vear <av@axvr.io>
" Licence: ISC (2019) " License: Vim (see `:help license`)
" ============================================================= " Location: syntax/outline.vim
" Website: https://github.com/axvr/org.vim
" Last Change: 2019-09-22
"
" Reference Specification: GNU Emacs Manual, section 'Outline Mode'
" GNU Info: `$ info Emacs Outline Mode`
" Web: <https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html>
if exists("b:current_syntax") if exists("b:current_syntax")
finish finish