worg-setup.org

   1 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
   2 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
   3 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
   4 #+TITLE:      Worg setup on the http://orgmode.org server
   5 #+AUTHOR:     Worg people
   6 #+EMAIL:      bzg AT altern DOT org
   7 #+LANGUAGE:   en
   8 #+PRIORITIES: A C B
   9 #+CATEGORY:   worg
  10 #+OPTIONS:    H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
  11
  12 * How Worg publishes itself as a website?
  13
  14   The server behind http://orgmode.org website takes care of publishing
  15   Worg into =HTML=.
  16
  17 ** How long does it take for a change to be published?
  18
  19    Export happens in two steps: the first step is to pull Worg
  20    repository on the server (this is cron'ed every 20 minutes, starting
  21    at 00:00), the second one is to publish the last version of Worg on
  22    the website (cron'ed every 20 minutes, starting at 00:10).
  23
  24    So for example, if you push a change in Worg at 00:37, this will be
  25    pulled on the server at 00:40 and will appear on the website at
  26    00:50.
  27
  28 ** There is a problem.  Can I check the export output?
  29
  30    The output of both cron jobs are readable here:
  31
  32    - http://orgmode.org/worg/pulling.txt
  33    - http://orgmode.org/worg/publishing.txt
  34
  35    Unmodified files are skipped during the process of exporting.
  36
  37 ** Looks like file XXX breaks the export.  What can I do?
  38
  39 1. Put this file in the FIXME directory at the root of the Worg
  40    repository.  Files in this FIXME directory won't be published.
  41
  42 2. Fix the page or contact the author of the page telling him about the
  43    problem.
  44
  45 * Are there any writting conventions?
  46
  47   Please don't use [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Specifying-File-Variables.html#Specifying-File-Variables][file variables]] in your org files.
  48
  49 * Can Worg execute code (via Babel)?
  50
  51   No.  The default automated export does not allow code execution on the
  52   server for obvious security reasons.
  53
  54   If you absolutely need code execution:
  55
  56   - double-check there is no issue when exporting this file locally
  57   - send [[bzg%20AT%20gnu%20DOT%20org][me]] an email mentionning the file you want to export
  58   - I will double-check it myself and manually export it if it's okay.
  59
  60 * What software is available on Worg for Babel code execution?
  61
  62   If babel code execution work on your machine, it doesn't mean it will
  63   work on the orgmode.org server.  Here is the list of available
  64   softwares on orgmode.org :
  65
  66   | Software     |                    Version |
  67   |--------------+----------------------------|
  68   | GNU Emacs    |                  23.1.90.1 |
  69   | shell        |                        3.1 |
  70   | R            |                     2.11.1 |
  71   | gnuplot-mode |                      O.6.0 |
  72   | gnuplot      |                        4.4 |
  73   | latex        | pdfeTeX 3.141592-1.21a-2.2 |
  74
  75 * What .emacs.el file is used on the server?
  76
  77 - http://orgmode.org/worg/sources/emacs.el
  78
  79 * I want it for my own server!
  80
  81   Here is the detailed recipe:
  82
  83   1. Configure your =~/.emacs.el= to know about your publishing projects
  84      (more information on publishing [[http://www.gnu.org/software/emacs/manual/html_node/org/Publishing.html][here]] and [[file:org-tutorials/org-publish-html-tutorial.org][here]])
  85
  86   2. Use =(setq org-export-htmlize-output-type 'css)= in ~/.emacs.el
  87
  88      (Do =C-h v org-export-htmlize-output-type= for more information
  89      about this.  Also =C-h v org-export-htmlize-generate-css= might
  90      help.)
  91
  92   3. Create =~/bin/pull-worg.sh= containing this script:
  93
  94      #+BEGIN_SRC sh-mode
  95      #!/bin/bash
  96
  97      # unless this is already done elsewhere:
  98      export PATH=$PATH:/home/you/bin/
  99
 100      # go to the place where you pull Worg
 101      cd /home/you/git/Worg/;
 102
 103      # pull Worg
 104      /home/you/bin/git-pull
 105      #+END_SRC
 106
 107   4. Create =~/bin/publish-worg.sh= containing this script:
 108
 109      #+BEGIN_SRC sh-mode
 110      #!/bin/bash
 111
 112      # Adapt it to point at your emacs executable
 113      /home/you/bin/emacs23 --batch -l ~/.emacs.el -f org-publish-all
 114      #+end_src
 115
 116   5. Cron the two scripts to run every hour, not at the same time
 117
 118      #+BEGIN_SRC generic-mode
 119      0 * * * * /home/you/bin/pull-worg.sh >> /dev/null 2>&1
 120      30 * * * * /home/you/bin/publish-worg.sh >> /dev/null 2>&1
 121      #+END_SRC
 122
 123   6. Sit and do something else while your Org repository is
 124      automagically exported to HTML