org-wiki

1.7.1.1 Method 1 - Bootstrap installer

(let ((url "https://raw.githubusercontent.com/caiorss/org-wiki/master/org-wiki.el"))     
      (with-current-buffer (url-retrieve-synchronously url)
    (goto-char (point-min))
    (re-search-forward "^$")
    (delete-region (point) (point-min))
    (kill-whole-line)
    (package-install-from-buffer)))

1.7.1.2 Method 2 - El-get

(el-get-bundle org-wiki
  :url "https://raw.githubusercontent.com/caiorss/org-wiki/master/org-wiki.el"
  :description "Emacs' desktop wiki built with org-mode"
  :features org-wiki
  )

1.7.1.3 Method 3 - Manual installation

mkdir -p ~/.emacs.d/packages/ 

cd ~/.emacs.d/packages/ 

git clone  https://github.com/caiorss/org-wiki

mkdir -p ~/org/wiki    # Make wiki location.

1.7.2.1 Basic settings

(require 'org-wiki)

1.7.2.2 Paths to Wiki locations

;;
;; (setq org-wiki-location "~/org/wiki")

(setq org-wiki-location-list
      '(
        "~/Documents/wiki"    ;; First wiki (root directory) is the default. 
        "~/Documents/wiki2 "
        "~/Documents/wiki3"
        ))

;; Initialize first org-wiki-directory or default org-wiki 
(setq org-wiki-location (car org-wiki-location-list))

'("~/org/wiki")

;; (setq org-wiki-location "e:/projects/org-wiki-test.emacs")

(setq org-wiki-location-list
      '(
        "C:\\Users\\john\\Documents\\wiki-main"    ;; First wiki is the default. 
        "F:/storage/wiki2"
        "G:\\Documents\\wiki3"
        ))

1.7.2.3 Open org-wiki pages in read-only

(setq org-wiki-default-read-only t)

(setq org-wiki-default-read-only nil)  ;; Default value

1.7.2.4 Close all wiki pages when switching wiki

(setq org-wiki-close-root-switch t)

(setq org-wiki-close-root-switch nil)

1.7.2.5 Server settings

(setq org-wiki-server-port "8000") ;; 8000 - default value

(setq org-wiki-server-host "0.0.0.0")   ;; Listen all hosts (default value)
(setq org-wiki-server-host "127.0.0.1") ;; Listen only localhost

1.7.2.6 Export Settings

(setq org-wiki-emacs-path "c:/Users/arch/opt/emacs/bin/runemacs.exe")

(org-wiki-make-menu)

1.7.2.7 Template

#+TITLE: %n
#+DESCRIPTION:
#+KEYWORDS:
#+STARTUP:  content


- Index

- Related: 

* %n

(setq org-wiki-template
      (string-trim
"
#+TITLE: %n
#+DESCRIPTION:
#+KEYWORDS:
#+STARTUP:  content
#+DATE: %d

- [[wiki:index][Index]]

- Related: 

* %n
"))

1.9.2.1 M-x org-wiki-index

1.9.2.2 M-x org-wiki-index-frame

1.9.3.1 M-x org-wiki-helm

1.9.3.2 M-x org-wiki-switch

1.9.3.3 M-x org-wiki-helm-frame

1.9.3.4 M-x org-wiki-helm-read-only

1.9.3.5 M-x org-wiki-make-page

1.9.3.6 M-x org-wiki-close

1.9.3.7 M-x org-wiki-close-image

1.9.4.1 M-x org-wiki-insert-link

[[wiki:The%20Art%20of%20Unix%20Programming][The Art of Unix Programming]]

1.9.4.2 M-x org-wiki-header

#+TITLE: <PAGE TITLE>
#+DESCRIPTION:
#+KEYWORDS:
#+STARTUP:  overview

Related:

[[wiki:index][Index]]\n\n

1.9.4.3 M-x org-wiki-asset-insert

1.9.5.1 Commands to open page's asset directory

1. M-x org-wiki-assets-dired
   

   Open page's asset directory in Emacs dired mode.

2. M-x org-wiki-assets-open
   
   • M-x org-wiki-assets-open - Open asset directory of current page with system's default file manager.
3. M-x org-wiki-assets-helm
   
   • M-x org-wiki-assets-helm - Select a wiki page and open its assets directory.

1.9.5.2 Commands to insert hyperlink to files

1. M-x org-wiki-asset-create
   

   Prompts the user for a file name that doesn't exist yet and insert it at point. Unlike the commands `org-wiki-asset-insert` or ` org-wiki-asset-insert-file` this command asks the user for a file that doesn't exist yet and inserts a hyperlink to it at point.

   Example: If the user enter this command and he is in the page Linux and types scriptDemoQT.py it will insert a link at point like this Linux/scriptDemoQT.py that doesn't exist yet. The user can then open the link and edit the file.

2. M-x org-wiki-asset-insert
   
   • M-x org-wiki-asset-insert - Insert a link to asset file of current page at current cursor position. This link when clicked opens with default system application.

   Example: Inserts a a link such as the code below. User is in the page Linux and with this command selects in the Helm menu the file Manual.pdf.

   [[wiki-asset-sys:Linux;Manual.pdf][Manual.pdf]]
   

3. M-x org-wiki-asset-insert-file
   
   • M-x org-wiki-asset-insert-file - Insert a link to an asset file that can be opened with Emacs at cursor position. This is an ordinary org-mode link.

   Use this file for files supposed to be opened with Emacs such as Python, bash scripts or source codes.

   Note: Don't use this command to insert images, use M-x org-wiki-insert-image instead of this.

   Example: If the current page is Python and user selects the file pyscript.py it will insert a hyperlink at point as this.

   pyscript.py
   

   It will be rendenred as this:

   • pyscript.py
4. M-x org-wiki-asset-insert-image
   
   • M-x org-wiki-asset-insert-file - Insert a link to an image file at point.

   Example: If the current page is Python and the user selects the file QTScreenshot.png it will insert a hyperlink to this file that will be rendered as an image when current page is exported to html.

   file:python/QTScreenshot.png
   

5. M-x org-wiki-asset-insert-block
   

   Insert code block with contents of some asset file as an org-mode block:

   Example:

   If the current page is 'Smalltalk programming' it the user select the file 'extendingClasses-number1.gst' it will insert a code block with the file contents and a hyperlink to it at point.

    - File: file:Smalltalk programming/extendingClasses-number1.gst
   
   #+BEGIN_SRC text
     Number extend [
             inv [ 1.0 / ^self
             ]
   
             neg [ - ^self
             ] 
     ]
   #+END_SRC
   

   It would insert a content like this:

   • File: Smalltalk programming/extendingClasses-number1.gst

   Number extend [
           inv [ 1.0 / ^self
           ]
   
           neg [ - ^self
           ] 
   ]
   

1.9.5.3 Commands to open files directly

1. M-x org-wiki-asset-find-file
   

   It will open a helm menu containing the assets files of current page. It will open the selected file with Emacs.

   Example: If the current page is 'Smalltalk programming' and the user select the file 'extendingClasses-number1.gst' it will open the file below with Emacs.

   • Smalltalk programming/'extendingClasses-number1.gst
2. M-x org-wiki-asset-find-sys
   

   Open a menu to select an asset file of current page and open it with system's app.

   Example: If the current page is 'Smalltalk programming' and the user select the file 'numerical-methods-in-smalltalk.pdf' it will be opened with the default system's application like Foxit PDF or Okular reader.

1.9.5.4 Commands to Download Files

1. M-x org-wiki-asset-download-insert1
   
   • M-x org-wiki-asset-download-insert1 - Ask the user the url to download a file suggesting the url stored in the clipboard and then asks the file name. After download it inserts a hyperlink at point to open the file with systems' default application.

   Example:

   1. User is in the page Linux that corresponds to the file <org-wiki-location>/Linux.org
   2. User copy the url https://inst.eecs.berkeley.edu/~cs61b/fa13/ta-materials/unix-concise-ref.pdf
   3. User enter M-x org-wiki-asset-download-insert1
      1. Confirm the first prompt asking for the url. The suggested url is the copied url.
      2. Confirm the second prompt asking the file name. The suggested name is unix-concise-ref.pdf
   4. It will insert at current point the hyperlink bellow. That points to the file <org-wiki-location>/Linux/unix-concise-ref.pdf.

   [[wiki-asset-sys:Linux;unix-concise-ref.pdf][unix-concise-ref.pdf]]
   

   Note: This command is synchronous and it can hang Emacs, therefore downloading heavy files can freeze Emacs. If it happesn type C-g to cancel the current download.

2. M-x org-wiki-asset-download-insert2
   
   • M-x org-wiki-asset-download-insert2 - Similar to M-x org-wiki-asset-download-insert1, however it inserts a hyperlink of type file:<org-wiki-page>/<file-name>.

   Example:

   1. User is in the page Linux and copies the url: http://i1-linux.softpedia-static.com/screenshots/htop_1.jpg
   2. User enter the command M-x org-wiki-asset-download-insert1 and answers all prompts.
   3. It will insert the hyperlink bellow at point.

   file:Linux/htop_1.jpg
   

1.9.6.1 M-x org-wiki-dired

1.9.6.2 M-x org-wiki-dired-all

1.9.7.1 M-x org-wiki-export-html

1.9.7.2 M-x org-wiki-index-html

1.9.12.1 Insert greek letters, math, physics and currency symbols

1.9.12.2 Insert org-mode code blocks, tables, quotes and etc.

\begin{equation} 
\end{equation}

|   |   |   |
|---+---+---|
|   |   |   |
|   |   |   |

#+BEGIN_SRC python 

#+END_SRC

1.9.12.3 Insert math formula, latex template, equations, greek letters and etc.

1.9.12.4 Web Server

1.9.12.5 Panel - org-wiki-panel

1.9.12.6 Menu

1.9.12.7 Backup Commands

1. Backup Settings
   

   Org-wiki can create backups of org-wiki snapshots stored in zip files that can be useful to avoid losses or revert to a previous state.

   Set the org-wiki-backup directory. The variable org-wiki-backup-location is initially set to nil.

   If the backup directory doesn't exist yet, it is created whenever the user runs any backup command.

   Note: It is assumed that the $ zip command line application is the $PATH variable.

   (setq org-wiki-backup-location "~/Documents/org-wiki-backup")
   

1.9.12.8 Paste Image

1. Overview
   

   This command requires the utility clip.jar and Java runtime to be available at the $PATH variable.

   The custom variable org-wiki-clip-jar-path holds the path to clip.jar utility has the default value: ~/bin/Clip.jar.

   If you wish to install in Clip.jar in a different path set the variable org-wiki-clip-jar-path like this in the init file:

   (setq org-wiki-clip-jar-path "~/bin/opt/Clip.jar")
   

   You can download a binary release with:

   mkdir  ~/bin && cd ~/bin 
   curl -O -L https://github.com/caiorss/clip.jar/blob/build/Clip.jar
   

2. M-x org-wiki-paste-image
   
   • M-x org-wiki-paste-image Ask the user for the image file name and writes the image from clipboard to the file.

   Example:

   • User copies an image with mouse right click to clipboard.

   • User type the command M-x org-wiki-paste-image and choses the name Unix.png and he is on the page Linux (Linux.org). It will write the image to the file ./Linux/Unix.png and will insert a this block at current cursor position:

   #+CAPTION: 
   file:Linux/Unix.png
   

3. M-x org-wiki-paste-image-uuid
   
   • M-x org-wiki-paste-image-uuid Paste an image from clipboard with automatically generated name (uuid).

   Example:

   • User copies an image from clipboard and type the command M-x org-wiki-paste-image-uuid. It will insert at point this block containing a hyperlink to the image like:

   #+CAPTION: 
   file:Linux/fba53c12-3f23-4728-9f52-a26a3d285d7c.png
   

1.10.5.1 Store, organize, and index documents, citations and etc.

1.10.5.2 Write very formal thesis, paper, books, manuals and etc …