README for GNOWSYS-mode
-*- mode: org; -*-
Table of Contents
1 GNOWSYS Mode
gnowsys-mode is a an application for knowledge networking and organization of the GNOWSYS knowledge base using emacs environment as a major mode. It is an extension of orgmode package. All data is published as nodes in a GNOWSYS server, either installed on your local machine or on the Internet.
Current version of gnowsys-mode opens a gnowsys buffer with all org-mode functionality. If you are not yet familiar with Org-mode, please first get at least working experience with them. orgmode site contains excellent documentation, and tutorials to begin.
GNOWSYS-mode works on any operating system on which Emacs works. Since Emacs works on all major operating systems, you can use GNOWSYS-mode on all of them. Emacs installation procedures may differ. Please read about how to install Emacs, if you do not have it already, from Emacs official site.
2 Installation Instructions
2.1 GNOWSYS server
Installation of GNOWSYS server is optional, since you can use an already installed servers where you can create an account and begin working. Once you get used to working with GNOWSYS-mode, and you think it is useful for your work, you may install GNOWSYS-server either on your own PC or on your office server depending on your requirement. Please check out more documentation on GNOWSYS at lab.gnowledge.org site.
Alternatively, you may try and test gnwosys-mode using the sandbox instance at the gnowledge.org server. The server is accessible from http://sandboxat.gnowledge.org. Register your account from the website before accessing through Emacs.
2.2 Setting up GNOWSYS-mode
- Download gnowsys-mode from svn using
svn co svn://svn.savannah.gnu.org/gnowsys/gnowsys-mode".
- Include the gnowsys-mode in the load-path of emacs.
(setq load-path (cons "THE PATH WHERE YOUR GNOWSYS-MODE IS SAVED" load-path))
- Make the following entries in the .emacs file.
(autoload 'gnowsys-mode "gnowsys" nil t)
- Install the latest version of orgmode. Refer to http://orgmode.org/index.html#sec-3 & http://orgmode.org/manual/Installation.html. Enter the following line in your .emacs file if Org is not part of the X/Emacs distribution.
(require 'org-install)
Once you are done with the setup, use the following command in emacs.
- M-x gnowsys-mode: to switch to gnowsys-mode.
- M-x gnowsys-connect: It will prompt you to enter server URL, username & password.
- M-x gnowsys-search: It will prompt you to enter the search string & display the results in gnowsys buffer.
- M-x gnowsys-addnode: It prompts to select the node type to be added & then prompts all the necessary fields required interactively.
- M-x gnowsys-setregex: It provides an inteface to add regular expression into GNOWSYS kb.
- M-x gnowsys-setlist: It provides an interface to add a list in GNOWSYS kb.
- M-x gnowsys-commit: It commits the data into GNOWSYS kb. As an alternative you can use the keymap "C-c C-c".
- M-x gnowsys-getSelectionlists: It retrieves all the selection-list in the GNOWSYS kb.
- M-x gnowsys-insert: It allows to select node type to be added & then presents the mandotory template initially. After selecting the initial values, press "C-n C-t" get the entire template. After filling up the form press C-c C-c to commit it to gnowsys.
- M-x generate-template: Generates template for the context node.
- Press spacebar to get the list of all possible values in the autocompletion for the RELATIONS and ATTRIBUTES drawer.
- M-x gnowsys-getversions: Prompts to select from available snapshots & replaces the current context with that particular version number.
-
Keybinding
"M-enter" --> invokes gnowsys-insert "C-n o" --> invokes gnowsys-insert-object "C-n O" --> invokes gnowsys-insert-objecttype "C-n p" --> invokes gnowsys-insert-process "C-n P" --> invokes gnowsys-insert-processtype "C-n a" --> invokes gnowsys-insert-attribute "C-n A" --> invokes gnowsys-insert-attributetype "C-n r" --> invokes gnowsys-insert-relation "C-n R" --> invokes gnowsys-insert-relationtype "C-n m" --> invokes gnowsys-insert-metatype "C-n C-s" --> invokes gnowsys-search "C-n C-g" --> invokes gnowsys-getnodes "C-n C-n o" --> invokes gnowsys-getnodes-object "C-n C-n O" --> invokes gnowsys-getnodes-objecttype "C-n C-n a" --> invokes gnowsys-getnodes-attribute "C-n C-n A" --> invokes gnowsys-getnodes-attributetype "C-n C-n r" --> invokes gnowsys-getnodes-relation "C-n C-n R" --> invokes gnowsys-getnodes-relationtype "C-n C-n p" --> invokes gnowsys-getnodes-process "C-n C-n P" --> invokes gnowsys-getnodes-processtype "C-n C-n m" --> invokes gnowsys-getnodes-metatype "C-n C-n u" --> invokes gnowsys-getnodes-user "C-n C-n U" --> invokes gnowsys-getnodes-usertype "C-n C-n e" --> invokes gnowsys-export "C-n d" --> invokes gnowsys-n3-export "C-n v" --> invokes gnowsys-getversions
3 Links
Date: 2009-06-07 Sun
HTML generated by org-mode 6.33trans in emacs 23