[Pkg-jed-commit] r93 - trunk/packages/jed-extra/debian
Guenter Milde
milde-guest at costa.debian.org
Fri Sep 30 16:16:57 UTC 2005
Author: milde-guest
Date: 2005-09-30 16:16:56 +0000 (Fri, 30 Sep 2005)
New Revision: 93
Added:
trunk/packages/jed-extra/debian/README.Maintainer
Log:
README.Maintainer with considerations for structuring jed-extra
Added: trunk/packages/jed-extra/debian/README.Maintainer
===================================================================
--- trunk/packages/jed-extra/debian/README.Maintainer 2005-09-30 13:24:46 UTC (rev 92)
+++ trunk/packages/jed-extra/debian/README.Maintainer 2005-09-30 16:16:56 UTC (rev 93)
@@ -0,0 +1,245 @@
+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.
+
+ -- Guido Gonzato
+
+
+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/20jed-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
+
+ - Asks questions at install time (depending on importance setting)
+ + Configuration the "Debian way"
+ + Allows administrators to change choice easily with dpkg-reconfigure.
+
+
+
+Where should the modes go?
+--------------------------
+
+JED library directory
+.....................
+
+"installed" modes should go to the jed-extra library directory, e.g.::
+
+ /usr/share/jed/site-lib/
+ /usr/share/jed/jed-extra-lib/
+ /usr/lib/jed-extra/
+
+Archive
+.......
+
+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.::
+
+ /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/
+
+ /the/agreed/upon/libdir/archive/ % this way "installing" could be
+ done with a simple relative
+ symlink
+
+
+For consistency, all modes could go to the archive with symlinks to the
+library dir for all installed files.
+
+
+Installation
+------------
+
+Broadly speaking, there are 4 types of modes:
+
+Utils
+'''''
+
+* e.g. bufutils.sl
+
+* provide functions used by other modes
+
+* can be installed in the libdir
+
+* do not need activation
+
+
+Additions
+'''''''''
+
+* e.g. language modes like make.sl
+
+* add a new capability but keep the "look and feel"
+
+* 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)
+
+* might slow down startup, increase memory or CPU usage
+
+* can be installed in the libdir by default
+
+-> activation should be configurable
+
+
+Drop-in replacements
+''''''''''''''''''''
+
+* e.g. help.sl (hyperhelp), man.sl (hyperman), recent.sl
+
+* provide an "improved" look and feel (enhance usability)
+
+* might slow down startup, increase memory or CPU usage
+
+* do not need activation
+
+-> installation in a libdir should be configurable
+
+
+Contained modes
+---------------
+
+Instead of just a download of Jedmodes-CVS, we should offer an
+"intelligent" choice of packages: purge obsolete packages and add
+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
More information about the Pkg-jed-commit
mailing list