Skip to content

Latest commit

 

History

History
215 lines (178 loc) · 8.08 KB

NOTES

File metadata and controls

215 lines (178 loc) · 8.08 KB
Raw

Usage

Installation and Configuration Instructions

You will need Emacs 24.3 or later, Emacs Web Server and Org-mode which are available from https://github.com/eschulte/emacs-web-server and http://orgmode.org/org-mode-download.html respectively.

  1. Optionally install with ELPA from http://melpa.milkbox.net/. 
    (mapc (lambda (package) (add-to-list  'package-archives package))
      '(("org"       . "http://orgmode.org/elpa/")
        ("melpa"     . "http://melpa.milkbox.net/packages/")))
(unless (package-installed-p 'org-ehtml) (package-install 'org-ehtml))
  2. Run the tests to make sure everything is working. 
    (require 'test-org-ehtml)
(ert "org-ehtml")
  3. Set the root of your directory of Org-mode files. For now we’ll just use the example files used in the tests, later you can customize this variable. 
    (setq org-ehtml-docroot test-org-ehtml-example-dir)
  4. Start up the web server. 
    (ws-start org-ehtml-handler 8888)
  5. Point your browser to http://localhost:8888/simple.org and move your mouse over the page. Editable portions of the page will be highlighted, click on these to edit.

Run over your own local Org-mode files

Warning: Be sure you backup your files before you start editing them through this experimental web interface as it could trash your files.

(require 'org-ehtml)

;; Configure the server
(setq
 org-ehtml-everything-editable t
 org-ehtml-docroot "~/path/to/your/files"
 my-org-ehtml-port 3333
 )

;; Start the server
(ws-start 'org-ehtml-handler my-org-ehtml-port)

;; Stop the server
;; (mapc #'ws-stop ws-servers)

User Authentication

Integration with version control

Warning: This could screw up your version control system as well as your flat files.

org-ehtml provides an org-ehtml-after-save-hook which can be used to commit all changes to a local version control system.

(require 'vc)

(add-hook
 'org-ehtml-after-save-hook
 (lambda ()
   (let ((file (buffer-file-name (current-buffer))))
     (vc-checkin (list file) (vc-backend file) nil "edit through org-ehtml"))))

Agenda View

org-ehtml supports viewing the Agenda buffer. It can be enabled by setting org-ehtml-allow-agenda to a non-nil value. The agenda can be viewed by adding /agenda/CMD to the url with CMD being one of

day, week, fortnight, month, year
Show org-agenda-list in that range. An additional argument can be provided to set the start date. E.g., http://localhost:8888/agenda/day/2013-11-11 to view the agenda for the day of [2013-11-11 Mon]
any natural number ($n>0$)
Show org-agenda-list for that many days. Similar to using day, week, etc.
todo
Show org-todo-list.
tags
Show org-tags-view. It requires an additional argument (separated by a /) specifying the tag. Using todo as first argument will limit the search to TODO entries. E.g., http://localhost:8888/agenda/tags/work to show all headlines tagged :work: and http://localhost:8888/agenda/tags/todo/work to only show headlines tagged :work: and marked TODO.

Using the Makefile

Using the Makefile is not required in any way. However, it may be used to either compile the Emacs Lisp source, or to run a simple web server. To do so, set ORGMODE environment variable to point to the development directories of Org-mode. You can then run “make” to build the Emacs Lisp source or run “make example” to launch an example web server.

Issues

Doesn’t work with some versions of Chrome

Specifically Version 21.0.1180.79 (151411) of chrome sends empty text fields to the server resulting in the deletion of the edited portion of the Org-mode file.

This is due to Chrome’s miss-evaluation of line 14 or so of src/ox-ehtml.js.

Tasks [6/9]

CANCELED upload package to marmalade after Org 7.9 release

  • State “CANCELED” from “DONE” [2014-01-03 Fri 12:35]
    using melpa
  • update the Org-mode dependency in the Makefile
  • upload to marmalade

would be good to allow the addition of new handlers

and to include some default handlers in the repo, e.g.,

  • adding a new file when not present
  • adding a new heading
  • searching

how to add a new headline

running through heroku

  • a single instance on heroku is free
  • nicferrier has forked technomancy’s heroku elisp package

Try to make it easy to run org-ehtml on heroku.

possibly more cl-* wrinkles as Emacs dev continues

> Note that there’s yet a new wrinkle with the upcoming release of the > 24.2 version (which hasn’t made the change yet), so 24.1.50 and > 24.2.50 and later have new-style cl libraries…

find good instructions for running behind a https proxy

This would be required for secure use of authentication.

This (setting-up-apache-as-a-ssl-front-end-for-play) look pretty good

<VirtualHost *:443>
    ProxyPreserveHost On
    ServerName yourserver.com

    SSLEngine On
    SSLCertificateFile /etc/httpd/conf/server.crt
    SSLCertificateKeyFile /etc/httpd/conf/server.key

    # Require SSL for all pages
    <Location/>
        SSLRequireSSL
    </Location>

    ProxyPass / http://127.0.0.1:8888/
    ProxyPassReverse / http://127.0.0.1:8888/
</VirtualHost>

don’t re-export if the html is newer than the org

AJAX offset cleanup

After every edit, we will need to map through every element in the html document changing the contents-[begin|end] which are larger than the contents-end of the edited element to reflect the new offset.

specialized editable html export for source code blocks

Rather than using (def-ehtml-wrap org-e-html-src-block), write a specialized function for exporting code blocks to editable html.

  • should have an [execute] button

something special for “notebook” functionality with sessions?

When code blocks have a :session, how difficult would it be to add functionality like the python web notebook interface.

replace on-click edit with side edit button

This will be much nicer for html elements that require clicks, like links in an editable paragraph.

offer to add new files when they don’t exist

This would require another case in the `org-ehtml-file-handler’.

suggestions on testing from nicferrier

15:29 < nicferrier> _schulte_:
                    https://github.com/nicferrier/elnode/blob/master/elnode-client.el#L534
15:29 < _schulte_> nicferrier: great, thanks
15:29 < nicferrier> beware, that module has had a lot removed from it - the child emacs
                    stuff has been removed to this rle module I'm working on
15:30 < nicferrier> but that test should hold up. it works in my automated tests anyway.
15:30 < nicferrier> having said that, the fakir stuff is really very good, it's mostly a
                    full stack test.
15:31 < nicferrier> just uses a fake process.
...
15:34 < _schulte_> oh, turns out `sit-for' was all I needed (for my very simple test)
                   http://sprunge.us/eSGA
...
15:35 < nicferrier> _schulte_: if you're gonna do this you might also be interested in my
                    phantomjs stuff - let's you test elnode apps in a headless browser.

CANCELED authentication with elnode

  • State “CANCELED” from “” [2014-01-03 Fri 12:37]
    no longer user elnode

I have the code in a branch on github. There is an example of doing authentication here:

https://github.com/nicferrier/elnode/blob/auth/elnode-wiki.el#L240

that shows how to set up a declared authentication scheme which can then be used to protect bits of code.