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

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

[elpa] externals/lentic ea6dd6dd9d 162/333: Documentation updates.


From: ELPA Syncer
Subject: [elpa] externals/lentic ea6dd6dd9d 162/333: Documentation updates.
Date: Tue, 27 Feb 2024 13:00:29 -0500 (EST)

branch: externals/lentic
commit ea6dd6dd9d51aee5792a47b210a00ce50ad0666e
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Commit: Phillip Lord <phillip.lord@newcastle.ac.uk>

    Documentation updates.
---
 lentic.el | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/lentic.el b/lentic.el
index 43bee43f69..b5214bdd05 100644
--- a/lentic.el
+++ b/lentic.el
@@ -28,7 +28,7 @@
 
 ;;; Commentary:
 
-;; lentic enables /lenticular text/: simultaneous editing and viewing of the
+;; `lentic' enables /lenticular text/: simultaneous editing and viewing of the
 ;; same (or closely related) text in two or more buffers, potentially in
 ;; different modes. Lenticular text is named after lenticular printing, which
 ;; produce images which change depending on the angle at which they are
@@ -52,7 +52,7 @@
 ;; and the documentation untroubled by the programmatic mode.
 
 ;; Lenticular text provides an alternative solution. Two lentic buffers, by
-;; default, the two share content but are otherwise independent. Therefore,
+;; default, the share content but are otherwise independent. Therefore,
 ;; you can have two buffers open, each showing the content in different modes;
 ;; to switch modes, you simply switch buffers. The content, location of point,
 ;; and view are shared.
@@ -61,9 +61,9 @@
 ;; between the two. If this is done, then the two can have different but
 ;; related text. This also solves the problem of integration with a
 ;; tool-chain; each lentic buffer can be associated with a different file and
-;; a different syntax.  This file is, itself, lenticular text. It can be
-;; viewed either as Emacs-Lisp or in Org-Mode. In Emacs-Lisp mode, this text
-;; is commented out, in org-mode it is not. In fact, even the default
+;; a different syntax. For example, this file is, itself, lenticular text. It
+;; can be viewed either as Emacs-Lisp or in Org-Mode. In Emacs-Lisp mode, this
+;; text is commented out, in org-mode it is not. In fact, even the default
 ;; behaviour of lentic uses this transformation capability--the text is
 ;; shared, but text properties are not, a behaviour which differs between
 ;; lentic buffers and indirect buffers.
@@ -75,6 +75,15 @@
 ;; The main user entry point is through `global-lentic-start-mode' which
 ;; provides tools to create a new lentic buffer.
 
+;;; Usage:
+
+;; lentic can be installed through MELPA then add
+
+;; (require 'lentic-autoload)
+;; (global-lentic-start-mode)
+
+;; to your .emacs.
+
 ;;; Configuration:
 
 ;; lentic buffers are configurable in a large number of ways. It is possible



reply via email to

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