Upload of 1.3 version

released on 1999-05-24

FAQ

@@ -0,0 +1,51 @@
+FAQ
+---
+
+1. Can I change the location of .emacs-records?
+2. Can I have spaces in the subject title?
+
+
+--------------------------------------------------------------------------
+1. The package installs .emacs-records in my home directory. I somehow dont 
+like the idea of cluttering my home directory. I was wondering if it was 
+possible to move this file to my records directory. Can I do it after I 
+install it and change the corresponding lines in recordsadmin or do I have to 
+install it again? If I have to install it again, which files do I have to 
+change for this to take effect?
+
+This is a bootstraping problem. Since recordsadmin creates this file the first
+time and then uses this file everytime you invoke it, I assumed a fixed place
+for it. Otherwise I would have to store the location of this file in some
+known place. I could use configure to ask the user to specify an area, but
+then what is the appropriate default? Making the default be inside the records
+directory requires some work because the records directory variable itself is
+customizable.
+
+The way you can move .emacs-records to ~/records is the following:
+  a) Set the following variable in recordsadmin
+  # global - should be set by makefile
+  $records_init_file="$ENV{HOME}/records/.emacs-records";
+
+  b) In .emacs
+  (load "~/records/.emacs-records")
+  (setq records-init-file (concat (getenv "HOME") "/records/.emacs-records"))
+
+2. When I insert a new record using C-c C-i or the menu, and type in the
+subject (or title) of the record, emacs does completion. And completion does 
+not allow for space in the record title. So I am forced to have either single 
+word titles or words-separated-by-hyphens or something similar titles. Is this 
+a feature or a bug? I dont mind having to type to hyphens or underscores, but 
+it would help to have spaces.
+
+You can have space in titles. The way you do it is to type C-q before typing
+in the space. That puts the literal space character in emacs. So for example
+you would type
+
+C-cC-iSpaceC-qTest
+
+and that would generate
+
+* Space Test
+------------
+link: <../../99/04/040999#* Space Test>
+

INSTALL

@@ -0,0 +1,83 @@
+Make sure that you read the README file first.
+
+1. Run ./configure
+This program is provided in the source (do not run your own configure).
+If you want to specify the directory in which recordsadmin should be installed,
+you could say something like
+
+./configure --prefix $HOME
+
+Make sure ${bindir} (generally ${prefix}/bin) in the Makefile exists and is
+writable by you.
+
+2. Run make install (or just make)
+After the lisp files have been compiled, this procedure is interactive and asks
+for user defaults. Note: The lisp files are not installed anywhere.
+
+3. The changes to your system that "make install" does are the following:
+
+   a) Adds ~/.emacs-records (if this file already exists, it converts only
+      specific parts of the file).
+
+   b) Adds a couple of lines to ~/.emacs
+
+   c) Adds recordsadmin to ${bindir}
+
+   d) Creates your records directory (~/records or whatever you have specified
+      during make) and adds some indexes there. If this directory already
+      exists, then it reindexes your records and converts them to the new
+      format. If you don't trust the conversion, I would really suggest that
+      you KEEP A COPY OF YOUR RECORDS BEFORE DOING THE CONVERSION. Check the
+      conversion by hand to make sure that the conversion is fine. Specially
+      look for the following: HAVE EMBEDDED LINKS IN YOUR RECORDS BEEN
+      CONVERTED CORRECTLY. Please tell me if this conversion is not okay.
+
+4. Copy the next set of lines from 
+";;;; records-mode" to 
+";;;; records-mode end" into your ~/.emacs. Make sure that these lines occur
+after the following line (which has been automatically added during install) in
+your .emacs
+(load "~/.emacs-records")
+I did not automate this process since users may wish to change the key
+settings. Users will probably use the records-goto-today function most
+often. Bind it to a simple key.
+
+;;;; records-mode
+; Define key bindings for functions called from outside records mode
+
+; The preferred binding for records-goto-today - uncomment to use it
+(define-key global-map [?\C-c ?n] 'records-goto-today)
+(define-key global-map [?\C-c ?-] 'records-underline-line)
+
+; The Ctrl-x n map
+(define-key global-map [?\C-x ?n ?t] 'records-goto-today)
+(define-key global-map [?\C-x ?n ?r] 'records-insert-record-region)
+(define-key global-map [?\C-x ?n ?b] 'records-insert-record-buffer)
+
+
+; Hook up to the calendar mode
+(add-hook 'calendar-load-hook 
+	  (function
+	   (lambda ()
+	     (define-key calendar-mode-map "n" 'records-calendar-to-record))))
+
+;;;*** OPTIONAL ***;;;
+
+; If you like abbrev mode 
+(add-hook 'records-mode-hooks
+    (function
+     (lambda ()
+       (abbrev-mode 1))))
+
+; If you want to be brought to today's record on startup
+(records-goto-today)
+
+;;;; records-mode end
+
+5. Restart your emacs (unless you know how to evaluate regions in a buffer - in
+which case get the key bindings and load in .emacs-records).
+
+After restarting emacs, go back to the README file for using records mode in
+emacs.  
+
+Ashvin Goel ([email protected])

Makefile.in

@@ -0,0 +1,167 @@
+###
+### Makefile.in
+###
+### $Id: Makefile.in,v 1.6 1999/05/25 02:07:22 ashvin Exp $
+###
+### Copyright (C) 1996 by Ashvin Goel
+###
+### This file is under the Gnu Public License.
+
+# $Log: Makefile.in,v $
+# Revision 1.6  1999/05/25 02:07:22  ashvin
+# Renamed encrypt to mailcrypt.
+# Added records.info file.
+#
+# Revision 1.5  1999/04/10 19:42:13  ashvin
+# Added FAQ in DISTFILES
+#
+# Revision 1.4  1999/04/10 18:36:23  ashvin
+# Minor bug fix.
+#
+# Revision 1.3  1997/05/01 21:21:13  ashvin
+# Changed names from notes to record.
+#
+# Revision 1.2  1997/01/23 00:02:35  ashvin
+# The first release
+#
+# Revision 1.1  1996/12/24  23:56:07  asgoel
+# Initial revision
+#
+
+# the Emacs binary on your system
+EMACS=@EMACS_BIN@
+# the perl binary on your system
+PERL=@PERL@
+
+# The installation prefix for architecture-independent files.
+prefix=@prefix@
+
+# The installation prefix for architecture-dependent files.
+exec_prefix=@exec_prefix@
+
+# The directory for installing read-only architecture-independent data.
+datadir=@datadir@
+
+# Currently not used.
+# This will be wrong if you use private lispdir areas.
+# In that case, set it explicitly during make.
+lispdir=@lispdir@
+
+# The directory for installing executables that users run.
+bindir = @bindir@
+
+# Where to put the Info file
+infodir=@infodir@
+
+# Installation command
+INSTALL = @INSTALL@
+INSTALL_DATA = @INSTALL_DATA@
+
+# Various auxiliary programs
+MAKEINFO=makeinfo
+DVIPS=dvips
+TEXI2DVI=texi2dvi
+TEXI2HTML=texi2html
+TAR=tar
+
+srcdir = @srcdir@
+VPATH = @srcdir@
+
+SOURCES = records-vars.el records-dindex.el records-index.el records-util.el records.el
+OBJECTS = records-vars.elc records-dindex.elc records-index.elc records-util.elc records.elc
+
+PRELOADS = -l records-load.el -l records-vars.el -l records.el
+EFLAGS =-batch -q -no-site-file $(PRELOADS)
+
+DISTFILES = $(SOURCES) FAQ INSTALL Makefile.in \
+	README configure configure.in install-sh \
+	mkinstalldirs recordsadmin.in records-load.el \
+	records.info records.ps \
+	mailcrypt/mailcrypt.el mailcrypt/mc-pgp.el \
+	mailcrypt/mc-remail.el mailcrypt/mc-toplev.el
+
+# records.info records.dvi records.texi 
+
+.SUFFIXES:
+.SUFFIXES: .elc .el
+
+.el.elc:
+	$(EMACS) $(EFLAGS) -f batch-byte-compile $<
+
+all: $(OBJECTS)
+	./recordsadmin -i
+
+# install: all installdirs $(infodir)/records
+install: all
+	$(INSTALL) recordsadmin $(bindir)
+
+#	for f in $(SOURCES); do \
+#	  $(INSTALL_DATA) $(srcdir)/$$f $(lispdir); \
+#	done;
+#	for f in $(OBJECTS); do \
+#	  $(INSTALL_DATA) $(srcdir)/$$f $(lispdir); \
+#	done;
+
+# Make sure all installation directories actually exist
+# by making them if necessary.
+installdirs: mkinstalldirs
+	$(srcdir)/mkinstalldirs $(infodir)
+
+# There may be a newer info file in . than in srcdir.
+$(infodir)/records: records.info
+	-if test -f records.info; then d=.; \
+	 else d=$(srcdir); fi; \
+	$(INSTALL_DATA) $$d/records.info $@; \
+	if $(SHELL) -c 'install-info --version'	>/dev/null 2>&1; then \
+	  install-info --infodir=$(infodir) $$d/records.info; \
+	else true; fi
+
+info: records.info
+
+records.info: records.texi
+	$(MAKEINFO) $(srcdir)/records.texi
+
+dvi: records.dvi
+
+records.dvi: records.texi
+	$(TEXI2DVI) $(srcdir)/records.texi
+
+ps: records.ps
+
+records.ps: records.dvi
+	$(DVIPS) $(srcdir)/records.dvi
+
+TAGS: $(SOURCES)
+	cd $(srcdir) && etags $(SOURCES)
+
+clean:
+	rm -f $(OBJECTS) records.aux records.cp records.cps records.dvi 
+	rm -f records.fn records.pg records.ky records.kys records.toc 
+	rm -f records.tp records.vr records.vrs records.log
+
+distclean: clean
+	-rm -f *~ *.tar.gz
+	rm -f records.ps records.info 
+	rm -f Makefile config.status config.cache config.log
+
+${srcdir}/configure: configure.in
+	cd ${srcdir} && autoconf
+
+Makefile: Makefile.in recordsadmin.in config.status
+	./config.status
+
+config.status: ${srcdir}/configure
+	./config.status --recheck
+
+dist: $(DISTFILES)
+	version=`perl -ne 'print $$1 if /defconst records-version \"(.*)\"/' \
+		 records.el`; \
+	distname=records-$$version; \
+	rm -rf $$distname; \
+	mkdir $$distname; \
+	mkdir $$distname/mailcrypt; \
+	for file in $(DISTFILES); do \
+	  ln $$file $$distname/$$file; \
+	done; \
+	$(TAR) -chz -f $$distname.tar.gz $$distname; \
+	rm -rf $$distname

README

@@ -0,0 +1,58 @@
+This is the first version of the records mode that I am releasing. There is
+not much documentation provided. However, most of the functionality is
+available from the RECORDS menu when you are visiting a records file.
+
+A brief documentation on records usage is described below.
+
+Steps:
+
+1. Since you are reading this file, you have untarred the gzip'ed file. The
+elisp files in the current directory (in which you are right now) will not be
+installed in any other directory, and installation will automatically add the
+current directory to the load path in emacs. So if you wish to move the records
+software to some other emacs-related directory, now is the time to do it.
+
+2. Read ./INSTALL and follow its instructions. The install procedure makes the
+byte compiled elisp files, reads in the user settings for records (by running
+recordsadmin), and installs these settings into the records initialization file
+~/.emacs-records. This initialization file is read by emacs and the records
+administration program (recordsadmin). Install also adds the loading of
+.emacs-records into your .emacs. When you start emacs, all the records defaults
+will be automatically loaded.
+
+GO AHEAD AND DO THE INSTALLATION.
+
+3. Type key "Ctrl-c n" (for records-goto-today). This will get you today's
+records file. If you are starting fresh, it will be empty. 
+
+4. To insert a records subject type "Ctrl-c Ctrl-i" or look for "Insert Record"
+in the menu. Once you have added a subject, you can start typing ...
+Regarding spaces in subject titles, look at the FAQ.
+
+5. Multiple subjects can be added in each day's records file. Infact the same
+subject can be added multiple times in each day's records file.
+
+6. For all the other functionality, look at the records menu. The menu has been
+divided so that most of the functionality at the top of the menu is related to
+records traversal (up, down, prev, next, goto etc). The middle section adds,
+deletes and renames records. The last section does administration tasks such as
+encryption, concatanation of records by subject or days etc. Make sure you look
+at the records TODO facility.
+
+7. Remember that if you just have one records file (today's) then records
+traversal's are not very useful!
+
+8. The program recordsadmin has been provided in order to do meta-level things
+- initialize (or reinitialize) your records software, change date format,
+change directory structure and recreate records indexes if they are broken (for
+example if your system crashes while emacs is updating your indexes on the
+fly). You should not need to use it in normal records use.
+
+9. Tell me if you like the package, have improvements to suggest, or have
+found bugs.
+
+Good Luck.
+
+Ashvin Goel ([email protected])
+
+