Added spellcheck. fixes #7

Author: iandstanley

docs/RELEASE-NOTES.md

@@ -1,6 +1,11 @@
 #		     STANDARD(?) UNIX NOTES
 #			RELEASE NOTES
 
+2.5
+	- Added spelling check to 'add' and 'edit' sub-commands
+	- Added prompt in config commands for choice of spelling 
+	  checker
+
 2.4 
 	- Added backup sub-command (creates GnuPG encrypted 
 	  tarball in HOME)

docs/ROADMAP.md

@@ -3,6 +3,8 @@
 				
 				ROADMAP
 
+2.5 Added spelling check to 'add' and 'edit' sub-commands
+
 2.4 Added backup sub command
 
 2.3 Use GNU shred(1) where available

docs/USING_NOTES.md

@@ -12,6 +12,12 @@ note* you will create 'my_new_note'.
 If available *notes* will use GNU shred(1) to delete any temporary 
 files. If unavailable it will default back to rm(1).
 
+## Spelling
+
+Unix Notes can be configured to use aspell(1), ispell(1) or 'none' using 
+the *spelling=* directive in the *config* file. This setting is 
+configured in the *init* sub-command on first run.
+
 ## Sub-command config
 
 Displays the 'config' file and also the DEFAULT and USE (current) 

docs/notes.1

@@ -55,6 +55,20 @@ config file.
 From version 1.8 onwards Notes/Notebook support Bash completion for sub 
 commands and note/notebook filenames.
 
+.SH SPELL CHECKING
+
+Notes(1) can be configured to use aspell(1) or ispell(1) to check the 
+spelling of the decrypted file during the \fBadd\fP and \fBedit\fP 
+sub-commands.
+
+To change spell checkers edit \fBspelling=\fP the config file to have 
+one of the following: 
+.RS 
+.IP spelling=aspell
+.IP spelling=ispell
+.IP spelling=none
+.RE
+
 .SH COMMANDS 
 
 The notes program takes a set of commands that allows the user to manipulate the 

notes

@@ -38,7 +38,26 @@ else
     SHREDCMD="rm"
 fi
 
-#
+SPELLCHECK=`grep spelling $CONFIGFILE | cut -d'=' -f 2`
+
+spellcheck () {
+    case ${SPELLCHECK} in 
+        aspell) 
+            SPELLINGCMD="aspell -x -c " 
+            ${SPELLINGCMD} ${notefile}
+            ;;
+        ispell) 
+            SPELLINGCMD="ispell -x " 
+            ${SPELLINGCMD} ${notefile}
+            ;;
+        none) 
+            ;;
+        *) 
+            echo Invalid config option `grep "spellcheck" ${CONFIGFILE}`
+    esac
+}
+
+
 # initialise notes system
 #
 
@@ -91,6 +110,23 @@ create_config () {
 	KEY="`gpg -K  --with-colons | grep fpr | head -1 | tr -d 'fpr:::::::::' `"
 	echo "KEY	$KEY" > $CONFIGFILE
 
+    echo Do you want spellchecking enabled?
+    echo "1) Use aspell"
+    echo "2) Use ispell"
+    echo "3) Do not spellcheck"
+    read -p "Choose 1,2,or 3: " choosespell
+    case $choosespell in
+        1)
+            echo "spelling=aspell" >> $CONFIGFILE
+            ;;
+        2)
+            echo "spelling=ispell" >> $CONFIGFILE
+            ;;
+        *)
+            echo "spelling=none" >> $CONFIGFILE
+            ;;
+    esac
+
 	echo Default config written:
 	cat  $CONFIGFILE
 }
@@ -165,7 +201,7 @@ note_add () {
 		# create temporary note file
 		$EDITOR "$notefile"
 
-		#aspell -c "$notefile"
+        spellcheck
 
 		# encrypt note file
 		$GPG -ear $KEY $GPG_OPTS  "$notefile"
@@ -213,11 +249,13 @@ note_edit () {
 	if [ -f "$notefile" ]; then 
 		gpg -d -o "${decrypted}" "${notefile}" 
 		${EDITOR} "${decrypted}" 
+        spellcheck
 		$GPG -ear $KEY $GPG_OPTS  "${decrypted}"
 		${SHREDCMD} ${decrypted}
 	elif [ -f "${notefile}.asc" ]; then 
 		gpg -d -o "${decrypted}"  "${notefile}.asc" 
 		${EDITOR} "${decrypted}" 
+        spellcheck
 		$GPG -ear $KEY $GPG_OPTS  "${decrypted}"
 		${SHREDCMD} ${decrypted}
 	else 
@@ -371,7 +409,7 @@ GPG encrypted notes system for BSD and Linux systems
 
 	notes init          initialise notes system
 	notes config        display config file
-    notes backup        backup $NOTESDIR to GPG encrypted tar file
+	notes backup        backup $NOTESDIR to GPG encrypted tar file
 	notes newkey email  change GPG key 
 	notes help          show help
 	notes version       show version