[Pkg-jed-commit] r97 - trunk/packages/jed-extra/debian
Guenter Milde
milde-guest at costa.debian.org
Tue Oct 4 10:16:59 UTC 2005
Author: milde-guest
Date: 2005-10-04 10:16:59 +0000 (Tue, 04 Oct 2005)
New Revision: 97
Modified:
trunk/packages/jed-extra/debian/README.Maintainer
Log:
Added categorization of Jedmodes modes
Modified: trunk/packages/jed-extra/debian/README.Maintainer
===================================================================
--- trunk/packages/jed-extra/debian/README.Maintainer 2005-10-04 06:58:54 UTC (rev 96)
+++ trunk/packages/jed-extra/debian/README.Maintainer 2005-10-04 10:16:59 UTC (rev 97)
@@ -1,3 +1,7 @@
+.. -*- rst-mode -*-
+.. Copyright (c) 2004 Guenter Milde.
+ Released under the terms of the GNU General Public License (v. 2 or later)
+
Organizing jed-extra
====================
@@ -40,102 +44,130 @@
b) choosen from a list with debconf
- - Asks questions at install time (depending on importance setting)
- + Configuration the "Debian way"
+ 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/20jed-extra.sl
+ * Add comments for activating the other categories
+ * Describe the activation/configuration in README.debian
+ * Provide an example jed.rc for user configuration
+
+ + 20jed-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?
--------------------------
-JED library directory
-.....................
+* Generally, modes should go to the `jed-extra library directory` ::
-"installed" modes should go to the jed-extra library directory, e.g.::
+ /usr/lib/jed-extra/
- /usr/share/jed/site-lib/
- /usr/share/jed/jed-extra-lib/
- /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/20jed-extra.sl.
-Archive
-.......
+* 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.
-Some modes are drop-in replacements. Placing them in the jed_library_path
-will make their use obligatory for all users. :-(
-
-Not "installed" modes should therefore go to an archive, e.g.::
+ Drop-ins should therefore go to an archive, say ::
- /usr/share/doc/jed-extra/examples/ % however, they are no examples
- /usr/share/doc/jed-extra/lib/ % not even are they documentation
- /usr/share/jed-extra/archive/
+ /usr/lib/jed-extra/archive/
+
+ and the adding of this libdir be left to the sysadmin or user (aided by
+ comments in 20jed-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.
- /the/agreed/upon/libdir/archive/ % this way "installing" could be
- done with a simple relative
- symlink
+Categorization
+--------------
-For consistency, all modes could go to the archive with symlinks to the
-library dir for all installed files.
+Broadly speaking, there are 4 types of modes:
+Additions
+~~~~~~~~~
-Installation
-------------
+* e.g. language modes like make.sl
-Broadly speaking, there are 4 types of modes:
+* add a new capability but keep the "look and feel"
-Utils
-'''''
+* add 1 or 2 autoloads but nothing "heavy"
-* e.g. bufutils.sl
+-> can be installed in the libdir and activated by default.
-* provide functions used by other modes
-* can be installed in the libdir
+Drop-in replacements
+~~~~~~~~~~~~~~~~~~~~
-* do not need activation
+* e.g. help.sl (hyperhelp), man.sl (hyperman), recent.sl
+* provide an "improved" look and feel (enhance usability)
-Additions
-'''''''''
+* might slow down startup, increase memory or CPU usage
-* e.g. language modes like make.sl
+* do not need activation
-* add a new capability but keep the "look and feel"
+-> install in a special libdir
-* add 1 or 2 autoloads but nothing "heavy"
--> can be installed in the libdir and activated by default.
-
-
Enhancements
-''''''''''''
+~~~~~~~~~~~~
* e.g. numbuf.sl, navigate.sl
-* provide an "improved" look and feel (enhance usability)
+* provide an "improved" look and feel or enhance usability
+* add to popup menus or keybindings (other than _Reserved_Key_Prefix)
+
* might slow down startup, increase memory or CPU usage
* can be installed in the libdir by default
--> activation should be configurable
+-> activation should be configurable: comments in 20jed-extra.sl and
+ example jed.rc
-Drop-in replacements
-''''''''''''''''''''
+Obsoleted modes
+~~~~~~~~~~~~~~~
-* e.g. help.sl (hyperhelp), man.sl (hyperman), recent.sl
+* unmaintained and obsoleted modes that are still in Jedmodes for
+ historical reasons
+
+-> do not install
+
-* provide an "improved" look and feel (enhance usability)
+Utils
+~~~~~
-* might slow down startup, increase memory or CPU usage
+* e.g. bufutils.sl
-* do not need activation
+* provide functions used by other modes
--> installation in a libdir should be configurable
+-> can be installed in the libdir and do not need activation
+
Contained modes
---------------
@@ -144,102 +176,113 @@
interesting new ones (most obviously Paul's modes outsoured to separate
Jedmodes "releases").
-Modes at Jedmodes:
- a2ps: Pretty-printing tools
- apache: mode for editing Apache configuration files
- apsmode: pretty printing mode using a2ps
- autotext: autotext a la MS Word
- awk: mode for editing Awk scripts
- brief: Brief editor emulation
- browse_url: Functions for display of web pages from within JED.
- bufed: buffer manager
- bufutils: Tools for buffer and windows handling
- cal: calendar and diary
- calc: SLang calculator
- cdecl: S-Lang version of K&R's dcl program
- ch_table: A "popup_buffer" with a table of characters
- circle: Circular array with relational indexing
- colors: collection of color schemes
- complete: keyword completion function
- css1: Mode for Cascading Style Sheets (CSS)
- csvutils: Utilities to work with csv data
- cua: CUA (Windows/Mac/CDE/KDE-like) bindings for Jed
- cuamark: CUA style of marking ("volatile regions")
- cuamisc: Helper functions for the cua suite
- cuamouse: CUA compatible mouse mode
- custmode: Custom syntax highlighting
- dabbrev: Complete the current word looking for similar
- word-beginnings
- datutils: Convenience functions for several Data_Types
- diagnose: Diagnostic functions for SLang programmers
- dict: A dict client.
- ding: Ding dictionary lookup function and mode
- email: mode for editing emails
- ffap: Find File At Point
- filelist: A special mode for file listings (ls, locate)
- fileview: configurable file viewing function
- filter-buffer: Filter buffer: show/hide lines that match a pattern
- gdbmrecent: another recent mode
- gnuplot: Mode for the Gnuplot plotting program
- grep: JED interface to the `grep` command
- history: Save the content of the minibuffer across jed sessions
- home-lib: Initialize libraries for jed extensions easily
- howto: howto-reader
- hyperhelp: Hypertext help browser.
- hyperman: hypertextish man pager
- info: Info reader for JED
- ishell: Interactive shell ("workbook mode")
- ispell: spell checking utilities
- jedasp: Try to simulate MS IIS Active Server Pages with JED
- jedgtk: slgtk dialogs for JED
- jedmodes: Utilities for the publication of modes at Jedmodes
- jedscape: html browser
- kcomplete: keyword completion from the syntax table
- keywords: Create keyword lists for syntax tables
- latex-jlm: Yet another latex mode for Jed
- libdir: Support for library directories with jed extensions
- life: Conway's Game of Life
- listing: Mode for listings of e.g. files or findings
- make: Mode for 'Makefile' files
- make_ini: Initialize non-standard modes automatically
- manedit:
- md5: MD5 message digest algorithm implemented in SLang
- menutils: popup menu extensions
- minued: Minibuffer edit mode
- misc: miscellaneous modes
- mtools: Interface to mtools for easy floppy read/write under
- UNIX
- mupad: Mode for Mupad (computer algebra system) files.
- navigate: "History feature" known from many browsers
- numbuf: Number the buffers and bind Alt-[n] to go to buffer n
- occur: occur with context
- outline: outline mode
- pcre: Perl-compatible searching functions
- po_mode: Mode for editing PO-files
- print: printer interface
- recent: Provide easy access to recently opened/saved files.
- rfcview: RFC viewer
- rmail: MUA suite
- rst: Mode for reStructured Text
- scrnhelp: Show little help buffers
- sl_utils: Basic SLang programming utils
- snake: Eat the apples and stay away from the walls
- sql: Syntax highlighting for SQL modes
- strutils: String processing functions
- subpar: paragraph reformatter
- tar: interface to GNU tar
- temabbrv: On request replaces the word at cursor with a
- user-defined template
- templates: Open templates and do some replacements
- tm: TM documentation parser and TM creation tools
- tree: Recursive directory listing utility
- turbo: dynamic word completion (like in StarOffice)
- txtutils: Tools for text processing (marking, string processing,
- formatting)
- uri: Let jed handle Universal Ressource Indicators (URIs)
- vi: vi editor emulation mode
- view: A generic view mode for readonly buffers
- window: Window management routines
- x-keydefs: extended set of Key_* variables for xjed
- yodl: mode for editing yodl documents
+:note: Should the choice be "inclusive" (as much as sensible) or "selective"
+ (as few as sensible, excluding "exotic" modes)?
+
+
+Modes at Jedmodes
+~~~~~~~~~~~~~~~~~
+
+Types: *A*ddition *D*rop-In *E*nhancement *O*bsolete *U*tils
+
+
+Type Name Abstract
+
+ A a2ps: Pretty-printing tools
+ A apache: mode for editing Apache configuration files
+ E apsmode: pretty printing mode using a2ps
+ E autotext: autotext a la MS Word
+ A awk: mode for editing Awk scripts
+ D brief: Brief editor emulation
+ A browse_url: Functions for display of web pages from within JED.
+ D bufed: buffer manager
+ U bufutils: Tools for buffer and windows handling
+ D? cal: calendar and diary
+ A calc: SLang calculator
+ A cdecl: S-Lang version of K&R's dcl program
+ E ch_table: A "popup_buffer" with a table of characters
+ U circle: Circular array with relational indexing
+ A colors: collection of color schemes
+ A complete: keyword completion function
+ A css1: Mode for Cascading Style Sheets (CSS)
+ A csvutils: Utilities to work with csv data
+ O cua: CUA (Windows/Mac/CDE/KDE-like) bindings for Jed
+ A cuamark: CUA style of marking ("volatile regions")
+ O cuamisc: Helper functions for the cua suite
+ A cuamouse: CUA compatible mouse mode
+ A custmode: Custom syntax highlighting
+ O dabbrev: Complete the current word looking for similar
+ word-beginnings
+ U datutils: Convenience functions for several Data_Types
+ O diagnose: Diagnostic functions for SLang programmers
+ A dict: A dict client.
+ A ding: Ding dictionary lookup function and mode
+ A email: mode for editing emails
+ A ffap: Find File At Point
+ E filelist: A special mode for file listings (ls, locate)
+ A fileview: configurable file viewing function
+ E filter-buffer: Filter buffer: show/hide lines that match a pattern
+ A gdbmrecent: another recent mode
+ A gnuplot: Mode for the Gnuplot plotting program
+ A grep: JED interface to the `grep` command
+ E history: Save the content of the minibuffer across jed sessions
+ O home-lib: Initialize libraries for jed extensions easily
+ A howto: howto-reader
+ D hyperhelp: Hypertext help browser.
+ D hyperman: hypertextish man pager
+ D info: Info reader for JED
+ A ishell: Interactive shell ("workbook mode")
+ D ispell: spell checking utilities
+ A jedasp: Try to simulate MS IIS Active Server Pages with JED
+ A jedgtk: slgtk dialogs for JED
+ A jedmodes: Utilities for the publication of modes at Jedmodes
+ A jedscape: html browser
+ ? kcomplete: keyword completion from the syntax table
+ A keywords: Create keyword lists for syntax tables
+ D latex-jlm: Yet another latex mode for Jed
+ A libdir: Support for library directories with jed extensions
+ A life: Conway's Game of Life
+ A listing: Mode for listings of e.g. files or findings
+ A make: Mode for 'Makefile' files
+ A make_ini: Initialize non-standard modes automatically
+ A manedit:
+ A md5: MD5 message digest algorithm implemented in SLang
+ A menutils: popup menu extensions
+ A minued: Minibuffer edit mode
+ ? misc: miscellaneous modes
+ A mtools: Interface to mtools for easy floppy read/write under
+ UNIX
+ A mupad: Mode for Mupad (computer algebra system) files.
+ E navigate: "History feature" known from many browsers
+ E numbuf: Number the buffers and bind Alt-[n] to go to buffer n
+ D occur: occur with context
+ A outline: outline mode
+ A pcre: Perl-compatible searching functions
+ A po_mode: Mode for editing PO-files
+ A print: printer interface
+ D recent: Provide easy access to recently opened/saved files.
+ A rfcview: RFC viewer
+A/O? rmail: MUA suite
+ A rst: Mode for reStructured Text
+ O scrnhelp: Show little help buffers
+ U sl_utils: Basic SLang programming utils
+ A snake: Eat the apples and stay away from the walls
+ A sql: Syntax highlighting for SQL modes
+ U strutils: String processing functions
+ A subpar: paragraph reformatter
+ A tar: interface to GNU tar
+ A temabbrv: On request replaces the word at cursor with a
+ user-defined template
+ A templates: Open templates and do some replacements
+ U tm: TM documentation parser and TM creation tools
+ A tree: Recursive directory listing utility
+ E turbo: dynamic word completion (like in StarOffice)
+ U txtutils: Tools for text processing (marking, string processing,
+ formatting)
+ E uri: Let jed handle Universal Ressource Indicators (URIs)
+ E vi: vi editor emulation mode
+ A view: A generic view mode for readonly buffers
+ A window: Window management routines
+ A x-keydefs: extended set of Key_* variables for xjed
+ A yodl: mode for editing yodl documents
More information about the Pkg-jed-commit
mailing list