emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org-remark 51b0c08f25 104/173: docs: NEWS, README etc.


From: ELPA Syncer
Subject: [elpa] externals/org-remark 51b0c08f25 104/173: docs: NEWS, README etc. for name change
Date: Fri, 28 Jan 2022 16:58:05 -0500 (EST)

branch: externals/org-remark
commit 51b0c08f25cb9355857bccef08a7a979337d9eb9
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs: NEWS, README etc. for name change
---
 NEWS                       |   6 +-
 README.org                 | 113 +-----
 docs/org-remark-manual.org |  19 +
 docs/org-remark.info       | 909 ---------------------------------------------
 4 files changed, 28 insertions(+), 1019 deletions(-)

diff --git a/NEWS b/NEWS
index 274fbc2bb5..6264ddcdf3 100644
--- a/NEWS
+++ b/NEWS
@@ -1,6 +1,10 @@
+- Changes ::
 
+  - Removing all use of "marginalia"
 
-- Changes ::
+    + The default value of org-remark-notes-file-path is changed from
+      "marginalia.org" to "marginal-notes.org". Adjust the filenames or change
+      the value.
 
   - When updating the existing headline and position properties, don't update
     the headline text when it already exists. Let the user decide how to manage
diff --git a/README.org b/README.org
index 7085b0d09c..f4fd13e07b 100644
--- a/README.org
+++ b/README.org
@@ -1,12 +1,12 @@
 [[file:https://img.shields.io/badge/License-GPLv3-blue.svg]]
 
-#+TITLE: Org-marginalia
+#+TITLE: Org-remark
 
 #+PROPERTY: LOGGING nil
 
 # Note: I use the readme template that alphapapa shares on his GitHub repo 
<https://github.com/alphapapa/emacs-package-dev-handbook#template>. It works 
with the org-make-toc <https://github.com/alphapapa/org-make-toc> package, 
which automatically updates the table of contents.
 
-Org-marginalia lets you highlight text, and write margin notes (marginalia) 
for any text file in a separate Org file. 
+Org-remark lets you highlight and annote any text file with using Org mode.
 
 [[./resources/images/2020-12-24T101116_Title.png]]
 *Figure 1*. Left: Org-mode with text enlarged; Right marginalia file with the 
inline image display on
@@ -61,7 +61,6 @@ non-nil, Org-marginalia will add an ID property to the file 
level. This is mainl
 - [[#credits][Credits]]
 - [[#feedback][Feedback]]
 - [[#license][License]]
-- [[#marginalia-for-org-marginaliael][Marginalia for org-marginalia.el]]
 - [[#local-variables][Local Variables]]
 :END:
 
@@ -308,112 +307,6 @@ I am aiming to keep this package to be small and focused. 
I plan to add the foll
 
 This work is licensed under a GPLv3 license. For a full copy of the licese, 
refer to [[./LICENSE][LICENSE]].
 
-* Marginalia for ~org-marginalia.el~
-:PROPERTIES:
-:marginalia-source-file: ~/local-repos/org-marginalia/org-marginalia.el
-:marginalia-source-file: ~/src/org-marginalia/org-marginalia.el
-:TOC:      :depth 0
-:END:
-This section is used as a demonstration and a collection of my ideas for this 
package.
-
-** Deleted Notes
-
-I need to think it through.
-Do I want to reveal invisible elments to move, or keep it hidden.
-At the moment, ~om/list-highlights-positions~ has been changed to return 
beginning points of visible ones only -- this can be changed to make it 
opsitonal arg. For example, if I want to list *all*, including the hidden ones, 
do I want to just visible ones?
-
-** Deleted Notes on jit-lock-register
-:END:
-[[file:~/local-repos/org-marginalia/org-marginalia.el][org-marginalia]]
-
-Some syntactic elements keep their faces descpite being marked.
-It appears to be the way font-lock-mode works. Experimenting.
-This might also lead to a way for copy and paste (need to deal with duplicate 
IDs)
-#+begin_src 
-;; Comment dddd
-;; This is considered
-;; Comment
-
-;;Comment  dd
-jit-lock-register
-
-(defun)
-
-(jit-lock-register #'my/font-lock-fn)
-(font-lock-unfontify-buffer)
-(jit-lock-refontify)
-(font-lock-fontify-buffer)
-
-(point);; comment
-;; Comment 
-(my/font-lock-fn 155 160)
-
-(let ((beg 1)
-      (end 10))
-  (list beg end))
-
-(defun my/font-lock-fn (beg end &optional context)
-  (unless context
-    (list beg)
-    (if (get-char-property beg 'om/id)
-        (font-lock-unfontify-region beg end))))
-#+end_src
-
-** org-marginalia-load
-:PROPERTIES:
-:marginalia-id: 3ed4316a
-:marginalia-source-beg: 7324
-:marginalia-source-end: 7343
-:END:
-[[file:~/local-repos/org-marginalia/org-marginalia.el][org-marginalia]]
-
-
-** set-buffer-modified-p
-:PROPERTIES:
-:marginalia-id: 275b8a06
-:marginalia-source-beg: 7203
-:marginalia-source-end: 7224
-:END:
-[[file:~/local-repos/org-marginalia/org-marginalia.el][org-marginalia]]
-
-Adding overlay does not set the buffer modified.
-It's more fluid with save operation.
-You cannot use `undo' to undo highlighter.
-
-** overlay-put
-:PROPERTIES:
-:marginalia-id: 44c310d9
-:marginalia-source-beg: 6461
-:marginalia-source-end: 6472
-:END:
-[[file:~/local-repos/org-marginalia/org-marginalia.el][org-marginalia]]
-
-Do not add the =evaporate t= property for the highlight's overlay. By 
remaining in the buffer, =undo= puts overlays in their original location when 
text regions get killed and subsequently the kill gets undone.
-
-Using overlays instead of text-properties has an advantage of easy composition 
of faces; e.g. when marking on a comment line in =emacs-lisp-mode=, the 
highlighters face won't be composed onto the underlying syntax face for 
comments. Overlay can make it easy to add an additional face to comments and 
other syntactically font-locked regions.
-** (make-overlay beg end nil 'FRONT-ADVANCE)
-:PROPERTIES:
-:marginalia-id: 3ec6b5e6
-:marginalia-source-beg: 6411
-:marginalia-source-end: 6452
-:END:
-[[file:~/local-repos/org-marginalia/org-marginalia.el][org-marginalia]]
-
-It's more intuitive if editing the text both on the beg and end points of the 
highlight overlay does not extend it. Pass FRONT-ADVANCE; keep REAR-ADVANCE as 
default.
-
-#+ref: Manual (elisp)Manging Overlays
-#+begin_quote
-     The arguments FRONT-ADVANCE and REAR-ADVANCE specify the marker
-     insertion type for the start of the overlay and for the end of the
-     overlay, respectively.  *Note Marker Insertion Types::.  If they
-     are both ‘nil’, the default, then the overlay extends to include
-     any text inserted at the beginning, but not text inserted at the
-     end.  If FRONT-ADVANCE is non-‘nil’, text inserted at the beginning
-     of the overlay is excluded from the overlay.  If REAR-ADVANCE is
-     non-‘nil’, text inserted at the end of the overlay is included in
-     the overlay.
-#+end_quote
-
 * Local Variables
 
 # Local Variables:
@@ -423,3 +316,5 @@ It's more intuitive if editing the text both on the beg and 
end points of the hi
 # org-export-with-title: t
 # line-spacing: 4
 # End:
+
+
diff --git a/docs/org-remark-manual.org b/docs/org-remark-manual.org
index 8e8f08cc6c..e138daf44f 100644
--- a/docs/org-remark-manual.org
+++ b/docs/org-remark-manual.org
@@ -25,6 +25,25 @@ Org-remark lets you highlight and annote any text file with 
using Org mode.
 
 #+texinfo: @insertcopying
 
+* COPYING
+:PROPERTIES:
+:COPYING: t
+:END:
+
+Copyright (C) 2021  Free Software Foundation, Inc.
+
+#+begin_quote
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover Texts being “A GNU Manual,” and
+with the Back-Cover Texts as in (a) below.  A copy of the license is
+included in the section entitled “GNU Free Documentation License.”
+
+(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
+modify this GNU manual.”
+#+end_quote
+
 * Installation
 :PROPERTIES:
 :TOC:      :depth 0
diff --git a/docs/org-remark.info b/docs/org-remark.info
deleted file mode 100644
index 4840fb97c5..0000000000
--- a/docs/org-remark.info
+++ /dev/null
@@ -1,909 +0,0 @@
-This is org-remark.info, produced by makeinfo version 6.7 from
-org-remark.texi.
-
-INFO-DIR-SECTION Emacs
-START-INFO-DIR-ENTRY
-* Org-remark: (org-remark). Highlight and annotate any text file.
-END-INFO-DIR-ENTRY
-
-
-File: org-remark.info,  Node: Top,  Next: Installation,  Up: (dir)
-
-Org-remark User Manual
-**********************
-
-     CAUTION: This manual is still in a draft version and missing some
-     key information relevant to the version being described.
-
-This manual is for Org-remark version 0.0.7.
-
-Last updated: 03 January 2022.
-
-Org-remark lets you highlight and annote any text file with using Org
-mode.
-
-* Menu:
-
-* Installation::
-* Getting Started::
-* Usage::
-* Customizing::
-* Known Limitations::
-* Credits::
-* Feedback::
-* Contributing::
-* Index - Features::             Key concepts & features
-* Index - Commands::             Interactive functions
-* Index - User Options::         Customizable variables & faces
-* GNU Free Documentation License::
-
-— The Detailed Node Listing —
-
-Installation
-
-* Manual::
-
-Usage
-
-* Commands::
-* Keybindings Examples::
-* Composing Personal Workflow::
-
-
-
-File: org-remark.info,  Node: Installation,  Next: Getting Started,  Prev: 
Top,  Up: Top
-
-1 Installation
-**************
-
-* Menu:
-
-* Manual::
-
-
-File: org-remark.info,  Node: Manual,  Up: Installation
-
-1.1 Manual
-==========
-
-This package is not available on ELPA or MELPA yet.  Manual installation
-is required.
-
-Ensure to have Org Mode 9.4 or later (tested on 9.4.2).  This package
-uses ‘org-collect-keywords’, which does not exist in an earlier version.
-
-Store both of the ‘.el’ files in the repo in your load-path, and put
-this in your init file:
-
-     (add-to-list 'load-path "~/local-repos/org-remark/")
-     (require 'org-remark-global-tracking)
-     (require 'org-remark)
-
-By loading ‘org-remark’, it will also pull in Org mode.  You might like
-to defer loading of Org as it might take long time.  As of version
-0.0.6, you can do so with loading only ‘org-remark-global-tracking’,
-which does not load ‘org’ automatically.
-
-For example, I use this in my init file.
-
-     ;; Set `load-path'
-     (add-to-list 'load-path "~/local-repos/org-remark")
-
-     ;; Load only `org-remark-global-tracking'
-     ;; and turn it on for automatic loading of highlights
-     ;; for the files tracked
-     (load-library "org-remark-global-tracking")
-     (org-remark-global-tracking-mode 1)
-
-     ;; Set keybindings `org-remark-mark' is bound to global-map so that you 
can
-     ;; call it globally before the library is loaded.  In order to make
-     ;; `org-remark-mark' and `org-remark-mode' callable, use `autoload'.
-     ;; When this package is available in MELPA, `autoload' should not be 
required.
-     (autoload #'org-remark-mark "org-remark" nil t)
-     (autoload #'org-remark-mode "org-remark" nil t)
-     (define-key global-map (kbd "C-c n m") #'org-remark-mark)
-     ;; The rest of keybidings are done only on loading `org-remark'
-     (with-eval-after-load 'org-remark
-       (define-key org-remark-mode-map (kbd "C-c n o") #'org-remark-open)
-       (define-key org-remark-mode-map (kbd "C-c n ]") #'org-remark-next)
-       (define-key org-remark-mode-map (kbd "C-c n [") #'org-remark-prev)
-       (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove))
-
-
-File: org-remark.info,  Node: Getting Started,  Next: Usage,  Prev: 
Installation,  Up: Top
-
-2 Getting Started
-*****************
-
-To be added
-
-
-File: org-remark.info,  Node: Usage,  Next: Customizing,  Prev: Getting 
Started,  Up: Top
-
-3 Usage
-*******
-
-* Menu:
-
-* Commands::
-* Keybindings Examples::
-* Composing Personal Workflow::
-
-
-File: org-remark.info,  Node: Commands,  Next: Keybindings Examples,  Up: Usage
-
-3.1 Commands
-============
-
-‘org-remark-global-tracking-mode’
-A global minor mode to save and track files that have marginal notes.
-When active, visiting a file being tracked automatically turns on
-‘org-remark-mode’, which loads highlights previously saved in the remark
-file.
-
-The files being tracked are saved in ‘org-remark-tracking-file’, which
-you can customize.  The default file is named ‘.org-remark-tracking’ in
-your Emacs configuration directory (‘user-emacs-directory’).
-
-‘org-remark-mode’
-Org-remark is a local minor mode.  Toggle it on/off with using
-‘org-remark-mode’.  On activating, it loads your saved highlights from
-the remark file (defined by ‘org-remark-notes-file-path’), and enables
-automatic saving of highlights.  The automatic saving is achieved via
-function ‘org-remark-save’ added to ‘after-save-hook’.
-
-‘org-remark-mark’
-Select a region of text, and call ‘org-remark-mark’ to highlight the
-region.  It will generate a new ID, and start tracking the location – so
-you can edit text around the highlighted text.  Do not cut, copy and
-paste as the highlight will disappear (you can immediately ‘undo’ to
-recover the text region along the highlights).  To create a new marginal
-note entry in the remark file, save the buffer.
-
-‘org-remark-save’
-By default, Org-remark automatically creates or updates corresponding
-entries in the remark file with location and text of highlights on
-saving the buffer.  Nevertheless, you can manually call
-‘org-remark-save’ to do so (automatic process also call this command).
-
-If user option ‘org-remark-use-org-id’ is non-nil, Org-remark will
-create a link back to the source note with using an Org-ID link instead
-of a normal file link.
-
-When a new remark file is created and ‘org-remark-use-org-id’ is
-non-nil, Org-remark will add an ID property to the file level.  This is
-mainly to support Org-roam’s backlink feature for remark files.
-
-‘org-remark-open’
-Move your cursor on the highlighted text, and call ‘org-remark-open’ to
-open the relevant margin notes in a separate window.  Your cursor will
-move to the remark buffer narrowed to the relevant margin notes entry.
-You can edit the remark buffer as a normal Org buffer.  Once you have
-done editing, you may simply save and close the it (kill it or close the
-window) as per your normal workflow.  Technically, the remark buffer is
-a cloned indirect buffer of the remark file.
-
-‘org-remark-load’
-This command visits the remark file and loads the saved highlights onto
-the current buffer.  If there is no margin notes for it, it will output
-a message in the echo.  Highlights tracked locally by Org-remark cannot
-persist when you kill the buffer, or quit Emacs.  When you re-launch
-Emacs, ensure to turn on ‘org-remark-mode’ to load the highlights.
-Loading is automatically done when you activate the minor mode.
-
-‘org-remark-remove’
-This command removes the highlight at point.  It will remove the
-highlight, and remove the properties from the remark, but will keep the
-headline and notes in tact.
-
-You can pass a universal argument (‘C-u’ by default).  If this is the
-case, the command additionally deletes the entire heading subtree, along
-with the notes you have written, for the highlight.
-
-‘org-remark-next’
-Move to the next highlight if any.  If there is none below the cursor,
-and there is a highlight above, loop back to the top one.  If the point
-has moved to the next highlight, this function enables transient map
-with ‘set-transient-map’.  You don’t have to press the keybinding prefix
-again to move further to the next.  That is, you can do a key sequence
-like this:
-
-‘C-c n ] ] ] ]’
-
-If you have the same prefix for ‘org-remark-prev’, you can combine it in
-the sequence like so:
-
-‘C-c n ] ] [ [’ This lets your cursor back to where you started (next
-next prev prev)
-
-‘org-remark-prev’
-Move to the previous highlight if any.  If there is none above the
-cursor, and there is a highlight below, loop back to the bottom one.
-This function enables transient map.  See ‘org-remark-next’ for detail.
-
-‘org-remark-toggle’
-Toggle showing/hiding of highlighters in current buffer.  It only
-affects the display of the highlighters.  When hidden, highlights’
-locations are still kept tracked; thus, upon buffer-save the correct
-locations are still recorded in the remark file.
-
-
-File: org-remark.info,  Node: Keybindings Examples,  Next: Composing Personal 
Workflow,  Prev: Commands,  Up: Usage
-
-3.2 Keybindings Examples
-========================
-
-‘Org-remark‘ only provides its mode map, and does not bind any keys to
-it.  As an example, you could do something like this below.
-
-     (define-key org-remark-mode-map (kbd "C-c n o") #'org-remark-open)
-     (define-key org-remark-mode-map (kbd "C-c m") #'org-remark-mark)
-     (define-key org-remark-mode-map (kbd "C-c n ]") #'org-remark-next)
-     (define-key org-remark-mode-map (kbd "C-c n [") #'org-remark-prev)
-
-
-File: org-remark.info,  Node: Composing Personal Workflow,  Prev: Keybindings 
Examples,  Up: Usage
-
-3.3 Composing Personal Workflow
-===============================
-
-Currently only “elementary” functions are defined in the package; for
-example, ‘mark’ , ‘save’, and ‘open’ are all separate functions.  You
-can string these together to compose a more fluid operation to suite
-your own workflow.  A very useful set of such chained commands have been
-suggesetd by holtzermann17 in Org-roam’s Discourse discussion
-(https://org-roam.discourse.group/t/prototype-org-remark-write-margin-notes-with-org-mode/1080/10)
-(adjusted to reflect the change of the prefix from ‘om/’ to
-‘org-remark-’) .
-
-I will try to incorporate these into the package when I have more time
-to focus on it – I find them useful, but there are some plans I have
-had, and want to think of how I can incoprate these suggestions better
-with my ideas.
-
-     (defun org-remark-make-annotation ()
-       (interactive)
-       (let ((mark-end (region-end)))
-         (org-remark-mark (region-beginning) (region-end))
-         (org-remark-save)
-         (org-remark-open (1- mark-end))
-         (end-of-buffer)))
-
-     (define-key org-remark-mode-map (kbd "C-c M")
-       #'org-remark-make-annotation)
-
-     (defun org-remark-browse-forward ()
-       (interactive)
-       (let ((buf (current-buffer)))
-         (org-remark-next) (org-remark-open (point))
-         (pop-to-buffer buf nil t)))
-
-     (define-key org-remark-mode-map (kbd "C-c n }")
-       #'org-remark-browse-forward)
-
-     (defun org-remark-browse-backward ()
-       (interactive)
-       (let ((buf (current-buffer)))
-         (org-remark-prev) (org-remark-open (point))
-         (pop-to-buffer buf nil t)))
-
-     (define-key org-remark-mode-map (kbd "C-c n {")
-       #'org-remark-browse-backward)
-
-
-File: org-remark.info,  Node: Customizing,  Next: Known Limitations,  Prev: 
Usage,  Up: Top
-
-4 Customizing
-*************
-
-   • You can customize settings in the ‘org-remark’ group.
-   • Highlight’s face can be changed via ‘org-remark-highlighter’
-   • Remark file is defined by ‘org-remark-notes-file-path’
-   • Your files with marginal notes are saved and tracked in
-     ‘org-remark-tracking-file’ (when tracking is turned on via the
-     global minor mode ‘org-remark-global-tracking-mode’)
-   • You can use Org-ID to create links from marginal notes back to
-     their main notes when ‘org-remark-use-org-id’ is on (default is
-     on).  This option also enables Org-remark to add an ID property
-     when a new remark file is being created.  This is to support
-     seamless workflow with Org-roam (https://orgroam.com).
-
-
-File: org-remark.info,  Node: Known Limitations,  Next: Credits,  Prev: 
Customizing,  Up: Top
-
-5 Known Limitations
-*******************
-
-Copy & pasting loses highlights
-     Overlays are not part of the kill; thus cannot be yanked.
-
-Undo highlight does not undo it
-     Overlays are not part of the undo list; you cannot undo
-     highlighting.  Use ‘org-remark-remove’ command instead.
-
-Moving source files and remark file
-     Move your files and remark file to another directory does not
-     update the source path recorded in the remark file.  It will be
-     confusing.  Try not to do this.
-
-
-File: org-remark.info,  Node: Credits,  Next: Feedback,  Prev: Known 
Limitations,  Up: Top
-
-6 Credits
-*********
-
-To create this package, I was inspired by the following packages.  I did
-not copy any part of them, but borrowed some ideas from them – e.g.
-saving the margin notes in a separate file.
-
-Ov-highlight (https://github.com/jkitchin/ov-highlight)
-     John Kitchin’s (author of Org-ref).  Great UX for markers with
-     hydra.  Saves the marker info and comments directly within the Org
-     file as Base64 encoded string.  It uses overlays with using ‘ov‘
-     package.
-
-Annotate.el (https://github.com/bastibe/annotate.el)
-     Bastian Bechtold’s (author of Org-journal).  Unique display of
-     annotations right next to (or on top of) the text.  It seems to be
-     designed for very short annotations, and perhaps for code review
-     (programming practice); I have seen recent issues reported when
-     used with variable-pitch fonts (prose).
-
-Org-annotate-file 
(https://github.com/tkf/org-mode/blob/master/contrib/lisp/org-annotate-file.el)
-     Part of Org’s contrib library.  It seems to be designed to annotate
-     a whole file in a separate Org file, rather than specific text
-     items.
-
-InPlaceAnnotations (ipa-mode) (https://github.com/IdoMagal/ipa.el)
-     It looks similar to Annotate.el above.
-
-Transient navigation feature
-     To implement the transient navigation feature, I liberally copied
-     the relevant code from a wonderful Emacs package, Binder
-     
(https://github.com/rnkn/binder/blob/24d55db236fea2b405d4bdc69b4c33d0f066059c/binder.el#L658-L665)
-     by Paul W.  Rankin (GitHub user rnkn (https://github.com/rnkn)).
-
-
-File: org-remark.info,  Node: Feedback,  Next: Contributing,  Prev: Credits,  
Up: Top
-
-7 Feedback
-**********
-
-Feedback welcome in this repo, or in Org-roam Discourse forum
-(https://org-roam.discourse.group/t/prototype-org-marginalia-write-margin-notes-with-org-mode/1080).
-
-
-File: org-remark.info,  Node: Contributing,  Next: Index - Features,  Prev: 
Feedback,  Up: Top
-
-8 Contributing
-**************
-
-To be added
-
-
-File: org-remark.info,  Node: Index - Features,  Next: Index - Commands,  
Prev: Contributing,  Up: Top
-
-Appendix A Index - Features
-***************************
-
-
-File: org-remark.info,  Node: Index - Commands,  Next: Index - User Options,  
Prev: Index - Features,  Up: Top
-
-Appendix B Index - Commands
-***************************
-
-
-File: org-remark.info,  Node: Index - User Options,  Next: GNU Free 
Documentation License,  Prev: Index - Commands,  Up: Top
-
-Appendix C Index - User Options
-*******************************
-
-
-File: org-remark.info,  Node: GNU Free Documentation License,  Prev: Index - 
User Options,  Up: Top
-
-Appendix D GNU Free Documentation License
-*****************************************
-
-                     Version 1.3, 3 November 2008
-
-     Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
-     <https://fsf.org/>
-
-     Everyone is permitted to copy and distribute verbatim copies
-     of this license document, but changing it is not allowed.
-
-  0. PREAMBLE
-
-     The purpose of this License is to make a manual, textbook, or other
-     functional and useful document “free” in the sense of freedom: to
-     assure everyone the effective freedom to copy and redistribute it,
-     with or without modifying it, either commercially or
-     noncommercially.  Secondarily, this License preserves for the
-     author and publisher a way to get credit for their work, while not
-     being considered responsible for modifications made by others.
-
-     This License is a kind of “copyleft”, which means that derivative
-     works of the document must themselves be free in the same sense.
-     It complements the GNU General Public License, which is a copyleft
-     license designed for free software.
-
-     We have designed this License in order to use it for manuals for
-     free software, because free software needs free documentation: a
-     free program should come with manuals providing the same freedoms
-     that the software does.  But this License is not limited to
-     software manuals; it can be used for any textual work, regardless
-     of subject matter or whether it is published as a printed book.  We
-     recommend this License principally for works whose purpose is
-     instruction or reference.
-
-  1. APPLICABILITY AND DEFINITIONS
-
-     This License applies to any manual or other work, in any medium,
-     that contains a notice placed by the copyright holder saying it can
-     be distributed under the terms of this License.  Such a notice
-     grants a world-wide, royalty-free license, unlimited in duration,
-     to use that work under the conditions stated herein.  The
-     “Document”, below, refers to any such manual or work.  Any member
-     of the public is a licensee, and is addressed as “you”.  You accept
-     the license if you copy, modify or distribute the work in a way
-     requiring permission under copyright law.
-
-     A “Modified Version” of the Document means any work containing the
-     Document or a portion of it, either copied verbatim, or with
-     modifications and/or translated into another language.
-
-     A “Secondary Section” is a named appendix or a front-matter section
-     of the Document that deals exclusively with the relationship of the
-     publishers or authors of the Document to the Document’s overall
-     subject (or to related matters) and contains nothing that could
-     fall directly within that overall subject.  (Thus, if the Document
-     is in part a textbook of mathematics, a Secondary Section may not
-     explain any mathematics.)  The relationship could be a matter of
-     historical connection with the subject or with related matters, or
-     of legal, commercial, philosophical, ethical or political position
-     regarding them.
-
-     The “Invariant Sections” are certain Secondary Sections whose
-     titles are designated, as being those of Invariant Sections, in the
-     notice that says that the Document is released under this License.
-     If a section does not fit the above definition of Secondary then it
-     is not allowed to be designated as Invariant.  The Document may
-     contain zero Invariant Sections.  If the Document does not identify
-     any Invariant Sections then there are none.
-
-     The “Cover Texts” are certain short passages of text that are
-     listed, as Front-Cover Texts or Back-Cover Texts, in the notice
-     that says that the Document is released under this License.  A
-     Front-Cover Text may be at most 5 words, and a Back-Cover Text may
-     be at most 25 words.
-
-     A “Transparent” copy of the Document means a machine-readable copy,
-     represented in a format whose specification is available to the
-     general public, that is suitable for revising the document
-     straightforwardly with generic text editors or (for images composed
-     of pixels) generic paint programs or (for drawings) some widely
-     available drawing editor, and that is suitable for input to text
-     formatters or for automatic translation to a variety of formats
-     suitable for input to text formatters.  A copy made in an otherwise
-     Transparent file format whose markup, or absence of markup, has
-     been arranged to thwart or discourage subsequent modification by
-     readers is not Transparent.  An image format is not Transparent if
-     used for any substantial amount of text.  A copy that is not
-     “Transparent” is called “Opaque”.
-
-     Examples of suitable formats for Transparent copies include plain
-     ASCII without markup, Texinfo input format, LaTeX input format,
-     SGML or XML using a publicly available DTD, and standard-conforming
-     simple HTML, PostScript or PDF designed for human modification.
-     Examples of transparent image formats include PNG, XCF and JPG.
-     Opaque formats include proprietary formats that can be read and
-     edited only by proprietary word processors, SGML or XML for which
-     the DTD and/or processing tools are not generally available, and
-     the machine-generated HTML, PostScript or PDF produced by some word
-     processors for output purposes only.
-
-     The “Title Page” means, for a printed book, the title page itself,
-     plus such following pages as are needed to hold, legibly, the
-     material this License requires to appear in the title page.  For
-     works in formats which do not have any title page as such, “Title
-     Page” means the text near the most prominent appearance of the
-     work’s title, preceding the beginning of the body of the text.
-
-     The “publisher” means any person or entity that distributes copies
-     of the Document to the public.
-
-     A section “Entitled XYZ” means a named subunit of the Document
-     whose title either is precisely XYZ or contains XYZ in parentheses
-     following text that translates XYZ in another language.  (Here XYZ
-     stands for a specific section name mentioned below, such as
-     “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.)
-     To “Preserve the Title” of such a section when you modify the
-     Document means that it remains a section “Entitled XYZ” according
-     to this definition.
-
-     The Document may include Warranty Disclaimers next to the notice
-     which states that this License applies to the Document.  These
-     Warranty Disclaimers are considered to be included by reference in
-     this License, but only as regards disclaiming warranties: any other
-     implication that these Warranty Disclaimers may have is void and
-     has no effect on the meaning of this License.
-
-  2. VERBATIM COPYING
-
-     You may copy and distribute the Document in any medium, either
-     commercially or noncommercially, provided that this License, the
-     copyright notices, and the license notice saying this License
-     applies to the Document are reproduced in all copies, and that you
-     add no other conditions whatsoever to those of this License.  You
-     may not use technical measures to obstruct or control the reading
-     or further copying of the copies you make or distribute.  However,
-     you may accept compensation in exchange for copies.  If you
-     distribute a large enough number of copies you must also follow the
-     conditions in section 3.
-
-     You may also lend copies, under the same conditions stated above,
-     and you may publicly display copies.
-
-  3. COPYING IN QUANTITY
-
-     If you publish printed copies (or copies in media that commonly
-     have printed covers) of the Document, numbering more than 100, and
-     the Document’s license notice requires Cover Texts, you must
-     enclose the copies in covers that carry, clearly and legibly, all
-     these Cover Texts: Front-Cover Texts on the front cover, and
-     Back-Cover Texts on the back cover.  Both covers must also clearly
-     and legibly identify you as the publisher of these copies.  The
-     front cover must present the full title with all words of the title
-     equally prominent and visible.  You may add other material on the
-     covers in addition.  Copying with changes limited to the covers, as
-     long as they preserve the title of the Document and satisfy these
-     conditions, can be treated as verbatim copying in other respects.
-
-     If the required texts for either cover are too voluminous to fit
-     legibly, you should put the first ones listed (as many as fit
-     reasonably) on the actual cover, and continue the rest onto
-     adjacent pages.
-
-     If you publish or distribute Opaque copies of the Document
-     numbering more than 100, you must either include a machine-readable
-     Transparent copy along with each Opaque copy, or state in or with
-     each Opaque copy a computer-network location from which the general
-     network-using public has access to download using public-standard
-     network protocols a complete Transparent copy of the Document, free
-     of added material.  If you use the latter option, you must take
-     reasonably prudent steps, when you begin distribution of Opaque
-     copies in quantity, to ensure that this Transparent copy will
-     remain thus accessible at the stated location until at least one
-     year after the last time you distribute an Opaque copy (directly or
-     through your agents or retailers) of that edition to the public.
-
-     It is requested, but not required, that you contact the authors of
-     the Document well before redistributing any large number of copies,
-     to give them a chance to provide you with an updated version of the
-     Document.
-
-  4. MODIFICATIONS
-
-     You may copy and distribute a Modified Version of the Document
-     under the conditions of sections 2 and 3 above, provided that you
-     release the Modified Version under precisely this License, with the
-     Modified Version filling the role of the Document, thus licensing
-     distribution and modification of the Modified Version to whoever
-     possesses a copy of it.  In addition, you must do these things in
-     the Modified Version:
-
-       A. Use in the Title Page (and on the covers, if any) a title
-          distinct from that of the Document, and from those of previous
-          versions (which should, if there were any, be listed in the
-          History section of the Document).  You may use the same title
-          as a previous version if the original publisher of that
-          version gives permission.
-
-       B. List on the Title Page, as authors, one or more persons or
-          entities responsible for authorship of the modifications in
-          the Modified Version, together with at least five of the
-          principal authors of the Document (all of its principal
-          authors, if it has fewer than five), unless they release you
-          from this requirement.
-
-       C. State on the Title page the name of the publisher of the
-          Modified Version, as the publisher.
-
-       D. Preserve all the copyright notices of the Document.
-
-       E. Add an appropriate copyright notice for your modifications
-          adjacent to the other copyright notices.
-
-       F. Include, immediately after the copyright notices, a license
-          notice giving the public permission to use the Modified
-          Version under the terms of this License, in the form shown in
-          the Addendum below.
-
-       G. Preserve in that license notice the full lists of Invariant
-          Sections and required Cover Texts given in the Document’s
-          license notice.
-
-       H. Include an unaltered copy of this License.
-
-       I. Preserve the section Entitled “History”, Preserve its Title,
-          and add to it an item stating at least the title, year, new
-          authors, and publisher of the Modified Version as given on the
-          Title Page.  If there is no section Entitled “History” in the
-          Document, create one stating the title, year, authors, and
-          publisher of the Document as given on its Title Page, then add
-          an item describing the Modified Version as stated in the
-          previous sentence.
-
-       J. Preserve the network location, if any, given in the Document
-          for public access to a Transparent copy of the Document, and
-          likewise the network locations given in the Document for
-          previous versions it was based on.  These may be placed in the
-          “History” section.  You may omit a network location for a work
-          that was published at least four years before the Document
-          itself, or if the original publisher of the version it refers
-          to gives permission.
-
-       K. For any section Entitled “Acknowledgements” or “Dedications”,
-          Preserve the Title of the section, and preserve in the section
-          all the substance and tone of each of the contributor
-          acknowledgements and/or dedications given therein.
-
-       L. Preserve all the Invariant Sections of the Document, unaltered
-          in their text and in their titles.  Section numbers or the
-          equivalent are not considered part of the section titles.
-
-       M. Delete any section Entitled “Endorsements”.  Such a section
-          may not be included in the Modified Version.
-
-       N. Do not retitle any existing section to be Entitled
-          “Endorsements” or to conflict in title with any Invariant
-          Section.
-
-       O. Preserve any Warranty Disclaimers.
-
-     If the Modified Version includes new front-matter sections or
-     appendices that qualify as Secondary Sections and contain no
-     material copied from the Document, you may at your option designate
-     some or all of these sections as invariant.  To do this, add their
-     titles to the list of Invariant Sections in the Modified Version’s
-     license notice.  These titles must be distinct from any other
-     section titles.
-
-     You may add a section Entitled “Endorsements”, provided it contains
-     nothing but endorsements of your Modified Version by various
-     parties—for example, statements of peer review or that the text has
-     been approved by an organization as the authoritative definition of
-     a standard.
-
-     You may add a passage of up to five words as a Front-Cover Text,
-     and a passage of up to 25 words as a Back-Cover Text, to the end of
-     the list of Cover Texts in the Modified Version.  Only one passage
-     of Front-Cover Text and one of Back-Cover Text may be added by (or
-     through arrangements made by) any one entity.  If the Document
-     already includes a cover text for the same cover, previously added
-     by you or by arrangement made by the same entity you are acting on
-     behalf of, you may not add another; but you may replace the old
-     one, on explicit permission from the previous publisher that added
-     the old one.
-
-     The author(s) and publisher(s) of the Document do not by this
-     License give permission to use their names for publicity for or to
-     assert or imply endorsement of any Modified Version.
-
-  5. COMBINING DOCUMENTS
-
-     You may combine the Document with other documents released under
-     this License, under the terms defined in section 4 above for
-     modified versions, provided that you include in the combination all
-     of the Invariant Sections of all of the original documents,
-     unmodified, and list them all as Invariant Sections of your
-     combined work in its license notice, and that you preserve all
-     their Warranty Disclaimers.
-
-     The combined work need only contain one copy of this License, and
-     multiple identical Invariant Sections may be replaced with a single
-     copy.  If there are multiple Invariant Sections with the same name
-     but different contents, make the title of each such section unique
-     by adding at the end of it, in parentheses, the name of the
-     original author or publisher of that section if known, or else a
-     unique number.  Make the same adjustment to the section titles in
-     the list of Invariant Sections in the license notice of the
-     combined work.
-
-     In the combination, you must combine any sections Entitled
-     “History” in the various original documents, forming one section
-     Entitled “History”; likewise combine any sections Entitled
-     “Acknowledgements”, and any sections Entitled “Dedications”.  You
-     must delete all sections Entitled “Endorsements.”
-
-  6. COLLECTIONS OF DOCUMENTS
-
-     You may make a collection consisting of the Document and other
-     documents released under this License, and replace the individual
-     copies of this License in the various documents with a single copy
-     that is included in the collection, provided that you follow the
-     rules of this License for verbatim copying of each of the documents
-     in all other respects.
-
-     You may extract a single document from such a collection, and
-     distribute it individually under this License, provided you insert
-     a copy of this License into the extracted document, and follow this
-     License in all other respects regarding verbatim copying of that
-     document.
-
-  7. AGGREGATION WITH INDEPENDENT WORKS
-
-     A compilation of the Document or its derivatives with other
-     separate and independent documents or works, in or on a volume of a
-     storage or distribution medium, is called an “aggregate” if the
-     copyright resulting from the compilation is not used to limit the
-     legal rights of the compilation’s users beyond what the individual
-     works permit.  When the Document is included in an aggregate, this
-     License does not apply to the other works in the aggregate which
-     are not themselves derivative works of the Document.
-
-     If the Cover Text requirement of section 3 is applicable to these
-     copies of the Document, then if the Document is less than one half
-     of the entire aggregate, the Document’s Cover Texts may be placed
-     on covers that bracket the Document within the aggregate, or the
-     electronic equivalent of covers if the Document is in electronic
-     form.  Otherwise they must appear on printed covers that bracket
-     the whole aggregate.
-
-  8. TRANSLATION
-
-     Translation is considered a kind of modification, so you may
-     distribute translations of the Document under the terms of section
-     4.  Replacing Invariant Sections with translations requires special
-     permission from their copyright holders, but you may include
-     translations of some or all Invariant Sections in addition to the
-     original versions of these Invariant Sections.  You may include a
-     translation of this License, and all the license notices in the
-     Document, and any Warranty Disclaimers, provided that you also
-     include the original English version of this License and the
-     original versions of those notices and disclaimers.  In case of a
-     disagreement between the translation and the original version of
-     this License or a notice or disclaimer, the original version will
-     prevail.
-
-     If a section in the Document is Entitled “Acknowledgements”,
-     “Dedications”, or “History”, the requirement (section 4) to
-     Preserve its Title (section 1) will typically require changing the
-     actual title.
-
-  9. TERMINATION
-
-     You may not copy, modify, sublicense, or distribute the Document
-     except as expressly provided under this License.  Any attempt
-     otherwise to copy, modify, sublicense, or distribute it is void,
-     and will automatically terminate your rights under this License.
-
-     However, if you cease all violation of this License, then your
-     license from a particular copyright holder is reinstated (a)
-     provisionally, unless and until the copyright holder explicitly and
-     finally terminates your license, and (b) permanently, if the
-     copyright holder fails to notify you of the violation by some
-     reasonable means prior to 60 days after the cessation.
-
-     Moreover, your license from a particular copyright holder is
-     reinstated permanently if the copyright holder notifies you of the
-     violation by some reasonable means, this is the first time you have
-     received notice of violation of this License (for any work) from
-     that copyright holder, and you cure the violation prior to 30 days
-     after your receipt of the notice.
-
-     Termination of your rights under this section does not terminate
-     the licenses of parties who have received copies or rights from you
-     under this License.  If your rights have been terminated and not
-     permanently reinstated, receipt of a copy of some or all of the
-     same material does not give you any rights to use it.
-
-  10. FUTURE REVISIONS OF THIS LICENSE
-
-     The Free Software Foundation may publish new, revised versions of
-     the GNU Free Documentation License from time to time.  Such new
-     versions will be similar in spirit to the present version, but may
-     differ in detail to address new problems or concerns.  See
-     <https://www.gnu.org/licenses/>.
-
-     Each version of the License is given a distinguishing version
-     number.  If the Document specifies that a particular numbered
-     version of this License “or any later version” applies to it, you
-     have the option of following the terms and conditions either of
-     that specified version or of any later version that has been
-     published (not as a draft) by the Free Software Foundation.  If the
-     Document does not specify a version number of this License, you may
-     choose any version ever published (not as a draft) by the Free
-     Software Foundation.  If the Document specifies that a proxy can
-     decide which future versions of this License can be used, that
-     proxy’s public statement of acceptance of a version permanently
-     authorizes you to choose that version for the Document.
-
-  11. RELICENSING
-
-     “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
-     World Wide Web server that publishes copyrightable works and also
-     provides prominent facilities for anybody to edit those works.  A
-     public wiki that anybody can edit is an example of such a server.
-     A “Massive Multiauthor Collaboration” (or “MMC”) contained in the
-     site means any set of copyrightable works thus published on the MMC
-     site.
-
-     “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
-     license published by Creative Commons Corporation, a not-for-profit
-     corporation with a principal place of business in San Francisco,
-     California, as well as future copyleft versions of that license
-     published by that same organization.
-
-     “Incorporate” means to publish or republish a Document, in whole or
-     in part, as part of another Document.
-
-     An MMC is “eligible for relicensing” if it is licensed under this
-     License, and if all works that were first published under this
-     License somewhere other than this MMC, and subsequently
-     incorporated in whole or in part into the MMC, (1) had no cover
-     texts or invariant sections, and (2) were thus incorporated prior
-     to November 1, 2008.
-
-     The operator of an MMC Site may republish an MMC contained in the
-     site under CC-BY-SA on the same site at any time before August 1,
-     2009, provided the MMC is eligible for relicensing.
-
-ADDENDUM: How to use this License for your documents
-====================================================
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and license
-notices just after the title page:
-
-       Copyright (C)  YEAR  YOUR NAME.
-       Permission is granted to copy, distribute and/or modify this document
-       under the terms of the GNU Free Documentation License, Version 1.3
-       or any later version published by the Free Software Foundation;
-       with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
-       Texts.  A copy of the license is included in the section entitled ``GNU
-       Free Documentation License''.
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the “with...Texts.” line with this:
-
-         with the Invariant Sections being LIST THEIR TITLES, with
-         the Front-Cover Texts being LIST, and with the Back-Cover Texts
-         being LIST.
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of free
-software license, such as the GNU General Public License, to permit
-their use in free software.
-
-
-
-Tag Table:
-Node: Top211
-Node: Installation1105
-Node: Manual1249
-Node: Getting Started3295
-Node: Usage3439
-Node: Commands3629
-Node: Keybindings Examples8138
-Node: Composing Personal Workflow8731
-Node: Customizing10581
-Node: Known Limitations11446
-Node: Credits12049
-Node: Feedback13722
-Node: Contributing13998
-Node: Index - Features14140
-Node: Index - Commands14303
-Node: Index - User Options14474
-Node: GNU Free Documentation License14667
-
-End Tag Table
-
-
-Local Variables:
-coding: utf-8
-End:



reply via email to

[Prev in Thread] Current Thread [Next in Thread]