-*- mode: org; -*-

#+TITLE:     README for GNOWSYS-mode
#+AUTHOR:    Nagarjuna G., Rajiv nair & Divya
#+EMAIL:     nagarjun@gnowledge.org, nair331@gmail.com, divyas15@gmail.com
#+DATE:      2009-06-07 Sun
#+DESCRIPTION: 
#+KEYWORDS: GNOWSYS-mode, installation instructions, emacs
#+LANGUAGE:  en
#+OPTIONS:   H:3 num:t toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+OPTIONS:   TeX:t LaTeX:nil skip:nil d:nil todo:t pri:nil tags:not-in-toc
#+INFOJS_OPT: view:nil toc:nil ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js
#+EXPORT_SELECT_TAGS: export
#+EXPORT_EXCLUDE_TAGS: noexport
#+LINK_UP:t   
#+LINK_HOME:t

* GNOWSYS Mode

  gnowsys-mode is a an application for knowledge networking and
  organization of the
  [[http://www.gnu.org/software/gnowsys/][GNOWSYS]] knowledge base
  using emacs environment as a major mode.  It is an extension of
  [[http://orgmode.org][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.
  [[http://orgmode.org][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 [[http://www.gnu.org/software/emacs/][Emacs official site.]] 

* Installation Instructions 

** 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
   [[http://lab.gnowledge.org/][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.
   
** Setting up GNOWSYS-mode

  1. Download gnowsys-mode from svn using 

#+BEGIN_EXAMPLE
     svn co svn://svn.savannah.gnu.org/gnowsys/gnowsys-mode".
#+END_EXAMPLE

  2. Include the gnowsys-mode in the load-path of emacs.
#+BEGIN_EXAMPLE
(setq load-path 
      (cons "THE PATH WHERE YOUR GNOWSYS-MODE IS SAVED"
	    load-path))
#+END_EXAMPLE

  3. Make the following entries in the .emacs file.

#+BEGIN_EXAMPLE
(autoload 'gnowsys-mode "gnowsys" nil t)
#+END_EXAMPLE

  4. 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.

#+BEGIN_EXAMPLE
(require 'org-install)
#+END_EXAMPLE

     Once you are done with the setup, use the following command in emacs.

     1. M-x gnowsys-mode: to switch to gnowsys-mode.

     2. M-x gnowsys-connect: It will prompt you to enter server URL,
        username & password.
	
     3. M-x gnowsys-search: It will prompt you to enter the search string &
     	display the results in *gnowsys* buffer.
	
     4. M-x gnowsys-addnode: It prompts to select the node type to be added &
	then prompts all the necessary fields required interactively.

     5. M-x gnowsys-setregex: It provides an inteface to add regular expression 
	into GNOWSYS kb.

     6. M-x gnowsys-setlist: It provides an interface to add a list in GNOWSYS kb.

     7. M-x gnowsys-commit: It commits the data into GNOWSYS kb. As an alternative 
	you can use the keymap "C-c C-c".
	
     8. M-x gnowsys-getSelectionlists: It retrieves all the selection-list in the
	GNOWSYS kb.

     9. 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.
	
     10. M-x generate-template: Generates template for the context node.
	 
     11. Press spacebar to get the list of all possible values in the autocompletion
	 for the RELATIONS and ATTRIBUTES drawer.

     12. M-x gnowsys-getversions: Prompts to select from available snapshots & replaces
	 the current context with that particular version number.

     13. Keybinding
         #+BEGIN_EXAMPLE
	 "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
	 #+END_EXAMPLE

* Links
  1. Documentation: http://lab.gnowledge.org/projects/software-development/gnowsys-mode \\
  2. Screencasts: http://lab.gnowledge.org/download/gnowsys-mode-screencasts
