From c47ffd4ec6a2761ff8a291b392fea7058e7bfd48 Mon Sep 17 00:00:00 2001 From: Alex Vear Date: Sun, 22 Sep 2019 18:01:36 +0100 Subject: [PATCH] Relicence under the Vim licence, add legal info and update file headers --- LICENCE | 97 ++++++++++++++++++++++++++++++++++++++------ README.md | 18 ++++++-- doc/org.txt | 34 ++++++++++++++-- ftdetect/org.vim | 16 +++++--- ftplugin/org.vim | 16 +++++--- ftplugin/outline.vim | 16 +++++--- plugin/org.vim | 12 +++--- syntax/org.vim | 16 +++++--- syntax/outline.vim | 16 +++++--- 9 files changed, 192 insertions(+), 49 deletions(-) diff --git a/LICENCE b/LICENCE index 36d188c..bf28747 100644 --- a/LICENCE +++ b/LICENCE @@ -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 -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. +The text below is a copy of the Vim license, the full license is shipped with +Vim and can be viewed on the web [0] or by invoking `:help license` from within +Vim. -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +[0]: + +VIM LICENSE + +I) There are no restrictions on distributing unmodified copies of Vim except + that they must include this license text. You can also distribute + 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 . 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 + + +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. diff --git a/README.md b/README.md index bedf3bb..2a641d1 100644 --- a/README.md +++ b/README.md @@ -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. syntax highlighting and folding) at a high standard. The main goal of this plugin is to replicate [Vim's default 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]: diff --git a/doc/org.txt b/doc/org.txt index 2145c5e..ce54cb7 100644 --- a/doc/org.txt +++ b/doc/org.txt @@ -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~ -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| 2. Installation ............................... |org-install| 3. Basic syntax ............................... |org-syntax| 4. Configuration .............................. |org-configuration| + 5. Legal ...................................... |org-legal| + 6. References ................................. |org-references| ============================================================================== 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. 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* @@ -71,5 +73,29 @@ To disable this feature place the following line in your vimrc: > 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]: +[2]: +[3]: + ------------------------------------------------------------------------------ vim:et:ts=8:sts=4:sw=4:tw=78:ft=help:norl: diff --git a/ftdetect/org.vim b/ftdetect/org.vim index 28e75a5..69fa06e 100644 --- a/ftdetect/org.vim +++ b/ftdetect/org.vim @@ -1,7 +1,13 @@ -" ============================================================= -" Description: Detect Org-mode files -" Author: Alex Vear (axvr) -" Licence: ISC (2018) -" ============================================================= +" Vim filetype detect plugin for GNU Emacs' Org mode +" +" Maintainer: Alex Vear +" 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: autocmd BufRead,BufNewFile *.org setfiletype org diff --git a/ftplugin/org.vim b/ftplugin/org.vim index 8828f62..5fe62a2 100644 --- a/ftplugin/org.vim +++ b/ftplugin/org.vim @@ -1,8 +1,14 @@ -" ============================================================= -" Description: Configure Org-mode folding -" Author: Alex Vear (axvr) -" Licence: ISC (2019) -" ============================================================= +" Vim filetype plugin for GNU Emacs' Org mode +" +" Maintainer: Alex Vear +" 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: setlocal conceallevel=2 setlocal concealcursor=nc diff --git a/ftplugin/outline.vim b/ftplugin/outline.vim index dd3707d..de29bd3 100644 --- a/ftplugin/outline.vim +++ b/ftplugin/outline.vim @@ -1,8 +1,14 @@ -" ============================================================= -" Description: Folding for GNU Emacs' Outline mode -" Author: Alex Vear (axvr) -" Licence: ISC (2019) -" ============================================================= +" Vim filetype plugin for GNU Emacs' Outline mode +" +" Maintainer: Alex Vear +" 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: function! OutlineFold() let l:depth = match(getline(v:lnum), '\(^\*\+\)\@<=\( .*$\)\@=') diff --git a/plugin/org.vim b/plugin/org.vim index a6d21e3..a68d57e 100644 --- a/plugin/org.vim +++ b/plugin/org.vim @@ -1,8 +1,10 @@ -" ============================================================= -" Description: Set default config options for org.vim -" Author: Alex Vear (axvr) -" Licence: ISC (2019) -" ============================================================= +" Set default configuration options for org.vim +" +" Maintainer: Alex Vear +" 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') let g:org_state_keywords = ['TODO', 'NEXT', 'DONE'] diff --git a/syntax/org.vim b/syntax/org.vim index 0b3d3dc..40e27c1 100644 --- a/syntax/org.vim +++ b/syntax/org.vim @@ -1,8 +1,14 @@ -" ============================================================= -" Description: Basic Org-mode syntax highlighting -" Author: Alex Vear (axvr) -" Licence: ISC (2019) -" ============================================================= +" Vim syntax file for GNU Emacs' Org mode +" +" Maintainer: Alex Vear +" 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: if exists("b:current_syntax") finish diff --git a/syntax/outline.vim b/syntax/outline.vim index 7e72cb5..a228935 100644 --- a/syntax/outline.vim +++ b/syntax/outline.vim @@ -1,8 +1,14 @@ -" ============================================================= -" Description: Syntax file for GNU Emacs' Outline mode -" Author: Alex Vear (axvr) -" Licence: ISC (2019) -" ============================================================= +" Vim syntax file for GNU Emacs' Outline mode +" +" Maintainer: Alex Vear +" 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: if exists("b:current_syntax") finish