[Pkg-jed-commit] r107 - trunk/packages/jed-extra/debian
Guenter Milde
milde-guest at costa.debian.org
Wed Oct 12 13:32:27 UTC 2005
Author: milde-guest
Date: 2005-10-12 13:32:27 +0000 (Wed, 12 Oct 2005)
New Revision: 107
Modified:
trunk/packages/jed-extra/debian/README.Maintainer
Log:
Clarification of file sorting, statet alternative of one libdir fits all
Modified: trunk/packages/jed-extra/debian/README.Maintainer
===================================================================
--- trunk/packages/jed-extra/debian/README.Maintainer 2005-10-11 19:15:14 UTC (rev 106)
+++ trunk/packages/jed-extra/debian/README.Maintainer 2005-10-12 13:32:27 UTC (rev 107)
@@ -5,101 +5,15 @@
Organizing jed-extra
====================
-"Goccia's Rules of Thumb":
---------------------------
- 1. it should be as helpful as possible; but
- 2. it must not stand in the way; therefore,
- 3. it should be fully customisable, and
- 4. it should be usable by geeks and newbies alike.
+The jed-extra package should
- -- Guido Gonzato
+ a) "just work" once it is installed,
+
+ b) not impose settings on the user that cannot be reverted.
+
-Possible Levels of Support
---------------------------
-
-1. Provide the modes in an archive (see `Where should the modes go?`_),
- installation should be "by hand" (in /usr/local/... or ~/.jed/lib/).
-
- - no added value (why then a package at all?)
-
-2. Provide modes and a framework for installation
- (e.g. add /usr/local/jed/site-lib/ to the search path
- in /etc/jed.d/50jed-extra.sl using add_libdir() from libdir.sl)
-
- + facilitates "hand-installation"
- + allows "fine tuning" by experts
- - hard for novices
- - Installing jed-extra will not (automatically) improve the
- usability of JED.
-
-3. Install a choice of modes (inclusive adding autoloads and
- add_completion())
-
- a) choosen by the packagers
-
- + simple, no questions at install time
- - Violates Goccia's Rule 2. (could stand in the way).
-
- b) choosen from a list with debconf
-
- + Allows administrators to change choice easily with dpkg-reconfigure.
- - debconf abuse
-
- c) choosen from a list in a jed-extra-installer.sl mode
-
- as this is no system configuration, it must not change anything
- under /usr/share/jed/ or /usr/lib/jed-extra/.
-
- + user friendly
- - lots of work (wont be finished soon)
-
- d) "minimal-invasive" activation in jed.d/
-
- * Categorize modes regarding their "invasiveness" (see Categorization_)
- * Activate "non obstructing" modes in jed.d/50jed-extra.sl
- * Add comments for activating the other categories
- * Describe the activation/configuration in README.debian
- * Provide an example jed.rc for user configuration
-
- + 50jed-extra.sl is a config file, so the admin can override our
- choice.
- + Prepared configuration options for categories make configuration
- a bit more user friendly
- - no GUI
-
-
-
-Where should the modes go?
---------------------------
-
-* Generally, modes should go to the `jed-extra library directory` ::
-
- /usr/lib/jed-extra/
-
- Alternatives: /usr/share/jed/site-lib/, /usr/share/jed/jed-extra-lib/
-
- The `jed-extra library directory` should be added to the search path
- with append_libdir() from libdir.sl in jed.d/50jed-extra.sl.
-
-* Some modes are drop-in replacements. Placing them in the jed_library_path
- would
-
- * make their use obligatory for all users if the libdir is added,
- * prevent their use if the libdir is appended.
-
- Drop-ins should therefore go to an archive, say ::
-
- /usr/lib/jed-extra/archive/
-
- and the adding of this libdir be left to the sysadmin or user (aided by
- comments in 50jed-extra.sl and the example jed.rc).
-
- Fine-grained activation of drop-ins is possible by copying or symlinking
- of individual modes to a users (or local) libdir.
-
-
Categorization
--------------
@@ -178,7 +92,55 @@
-> do not install
+Where should the modes go?
+--------------------------
+* Generally, modes should go to the `jed-extra library directory` ::
+
+ /usr/lib/jed-extra/
+
+ Alternatives: /usr/share/jed/site-lib/, /usr/share/jed/jed-extra-lib/
+
+ The `jed-extra library directory` should be appended to the search
+ path (with append_libdir() from libdir.sl in jed.d/50jed-extra.sl).
+ This way the performance impact on searches in the libdir or
+ documentation is kept minimal.
+
+* Some modes are drop-in replacements. Placing them in the
+ jed_library_path would either
+
+ a) make their use obligatory for all users if the libdir is *added*, or
+ b) prevent their use if the libdir is *appended*.
+
+ Drop-ins should therefore go to a separate dir, say ::
+
+ /usr/lib/jed-extra/drop-in/
+
+ added to the library path in 50jed-extra.sl.
+
+ * The default behaviour would be to use the drop-ins if jed-extra
+ is installed
+ * A sysadmin can easily comment out the activation of drop-ins
+ * A user can remove the drop-in/ dir from the library path in jed.rc
+ (a function remove_libdir() in libdir.sl could assist)
+ * Fine-grained activation of drop-ins is possible by copying or symlinking
+ of individual modes to a users (or local) libdir.
+
+
+Alternatively, all files could go to /usr/lib/jed-extra/ and the dir be
+*added* in 50jed-extra.sl with a comment a'la::
+
+ % prepend the library directory to the library path
+ % -> identically named files (drop ins) will take precedence
+ add_libdir("/usr/lib/jed-extra/");
+
+ % append the library directory to the library path
+ % -> Drop in files will not replace the standard versions.
+ % They can be evaluated by giving the full path in require() or
+ % evalfile()
+ % append_libdir("/usr/lib/jed-extra/");
+
+
Contained modes
---------------
@@ -297,3 +259,73 @@
A window: Window management routines
A x-keydefs: extended set of Key_* variables for xjed
X yodl: mode for editing yodl documents
+
+
+Possible Levels of Support
+--------------------------
+
+When designing jed-exrta, let us follow
+
+"Goccia's Rules of Thumb":
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ 1. it should be as helpful as possible; but
+ 2. it must not stand in the way; therefore,
+ 3. it should be fully customisable, and
+ 4. it should be usable by geeks and newbies alike.
+
+ -- Guido Gonzato
+
+
+
+1. Provide the modes in an archive (see `Where should the modes go?`_),
+ installation should be "by hand" (in /usr/local/... or ~/.jed/lib/).
+
+ - no added value (why then a package at all?)
+
+2. Provide modes and a framework for installation
+ (e.g. add /usr/local/jed/site-lib/ to the search path
+ in /etc/jed.d/50jed-extra.sl using add_libdir() from libdir.sl)
+
+ + facilitates "hand-installation"
+ + allows "fine tuning" by experts
+ - hard for novices
+ - Installing jed-extra will not (automatically) improve the
+ usability of JED.
+
+3. Install a choice of modes (inclusive adding autoloads and
+ add_completion())
+
+ a) choosen by the packagers
+
+ + simple, no questions at install time
+ - Violates Goccia's Rule 2. (could stand in the way).
+
+ b) choosen from a list with debconf
+
+ + Allows administrators to change choice easily with dpkg-reconfigure.
+ - debconf abuse
+
+ c) choosen from a list in a jed-extra-installer.sl mode
+
+ as this is no system configuration, it must not change anything
+ under /usr/share/jed/ or /usr/lib/jed-extra/.
+
+ + user friendly
+ - lots of work (wont be finished soon)
+
+ d) "minimal-invasive" activation in jed.d/
+
+ * Categorize modes regarding their "invasiveness" (see Categorization_)
+ * Activate "non obstructing" modes in jed.d/50jed-extra.sl
+ * Add comments for activating the other categories
+ * Describe the activation/configuration in README.debian
+ * Provide an example jed.rc for user configuration
+
+ + 50jed-extra.sl is a config file, so the admin can override our
+ choice.
+ + Prepared configuration options for categories make configuration
+ a bit more user friendly
+ - no GUI
+
+
More information about the Pkg-jed-commit
mailing list