Changeset - r15:5283cf0a1096
[Not reviewed]
default
0 1 0
Wolfgang Scherer (ws) - 13 years ago 2012-03-30 23:38:52
wolfgang.scherer@gmx.de
doc/index.txt: change image links to use `tip` as revision.
1 file changed with 4 insertions and 3 deletions:
0 comments (0 inline, 0 general)
doc/index.txt
Show inline comments
 
.. -*- coding: utf-8 -*-
 
.. \||<-snip->|| start
 
.. Copyright (C) 2012, Wolfgang Scherer, <Wolfgang.Scherer at gmx.de>
 
.. Sponsored by WIEDENMANN SEILE GMBH, http://www.wiedenmannseile.de
 
..
 
.. This file is part of Wiedenmann Vacation.
 
..
 
.. Permission is granted to copy, distribute and/or modify this
 
.. document under the terms of the GNU Free Documentation License,
 
.. Version 1.3 or any later version published by the Free Software
 
.. Foundation; with no Invariant Sections, no Front-Cover Texts, and
 
.. no Back-Cover Texts.  A copy of the license is included in the main
 
.. documentation of Wiedenmann Vacation.
 

	
 
.. (progn (forward-line 1)(snip-insert-mode "rst_t.inline-comments" t))
 
.. inline comments (with ws_docutils)
 
.. role:: rem(span)
 
   :format: ''
 
.. role:: html(span)
 
   :format: html
 
   :raw:
 

	
 
.. role:: ihtml(span)
 
   :format: html
 
.. role:: nhtml(span)
 
   :format: !html
 

	
 
##################################################
 
:rem:`|||:sec:|||`\ Wiedenmann Vacation
 
##################################################
 
Web Front-End to Manage vacation(1) Settings
 
##################################################
 
.. \||<-snap->|| skip
 

	
 
:Author: `Wolfgang Scherer`_
 

	
 
.. contents::
 
.. \||<-snap->|| skip
 
.. \||<-snap->|| include ^index-header.snip$
 

	
 
==================================================
 
:rem:`|||:sec:|||`\ Purpose
 
==================================================
 

	
 
This program is a front end written in PHP to manage the vacation(1)
 
auto reply command.
 

	
 
The content of the message file $HOME/.virtual.msg can be edited in a
 
browser.
 

	
 
It is also possible to appoint another user to receive a copy of all
 
emails, when the vacation(1) filter is active.
 

	
 
The auto reply history from vacation(1) is also shown and can be
 
deleted.
 

	
 
==================================================
 
:rem:`|||:sec:|||`\ Screenshot
 
==================================================
 

	
 
.. image:: http://bitbucket.org/wolfmanx/ws-vacation/raw/e60cce377e32/doc/ws-vacation-t.jpg
 

	
 
View image in `full size`_
 
|screenshot|_
 

	
 
==================================================
 
:rem:`|||:sec:|||`\ Features
 
==================================================
 

	
 
The edited message is converted to a message file using
 

	
 
- Content-Type: text/plain; charset="utf-8"
 
- Content-Transfer-Encoding: quoted-printable
 

	
 
Therefore international characters do not pose a problem.
 

	
 
If the filter is activated, file $HOME/.forward is created from the
 
settings, otherwise the .forward file is deleted.
 

	
 
The program comes with a preconfigured sudoers(5) configuration file,
 
which allows the www server user to execute the vacation(1) command on
 
behalf of a system user.
 

	
 
There is also an apache2(8) configuration file included.
 

	
 
==================================================
 
:rem:`|||:sec:|||`\ Source Code and Installation
 
==================================================
 

	
 
The source code is available in a mercurial repository at
 
`ws-vacation`_.
 

	
 
Clone the repository with::
 

	
 
    $ hg clone https://bitbucket.org/wolfmanx/ws-vacation
 

	
 
See the `Administrator Manual`_ for installation instructions.
 

	
 
.. ==================================================
 
.. :rem:`|||:sec:|||`\ Footnotes
 
.. ==================================================
 

	
 
:html:`<hr>`
 

	
 
.. \[#]
 

	
 
.. ==================================================
 
.. :rem:`|||:sec:|||`\ References
 
.. ==================================================
 

	
 
.. |screenshot|  image:: http://bitbucket.org/wolfmanx/ws-vacation/raw/tip/doc/ws-vacation-t.jpg
 
.. _screenshot: http://bitbucket.org/wolfmanx/ws-vacation/raw/tip/doc/ws-vacation.jpg
 

	
 
.. _`Administrator Manual`: README.html
 
.. _`ws-vacation`: https://bitbucket.org/wolfmanx/ws-vacation
 
.. _`full size`: http://bitbucket.org/wolfmanx/ws-vacation/raw/e60cce377e32/doc/ws-vacation.jpg
 

	
 
.. \||<-snap->|| include ^index-footer.snip$
 

	
 
:rem:`|||:sec:|||`\ **Copyright**
 

	
 
Copyright (C) 2012, Wolfgang Scherer, <sw@wiedenmann-seile.de>.
 
Sponsored by `Wiedenmann-Seile GmbH`_.
 

	
 
.. div::
 
   :format: html
 

	
 
   See section |GFDL| for license conditions for the documentation.
 

	
 
   See section |GPL| for license conditions for the program.
 

	
 
.. div::
 
   :format: !html
 

	
 
   See *GNU Free Documentation License* in file `GFDL.txt` for license
 
   conditions for the documentation.
 

	
 
   See *GNU General Public License* in file `COPYING` for license
 
   conditions for the program.
 

	
 
.. |GFDL| replace:: `GNU Free Documentation License`_
 
.. |GPL| replace:: `GNU General Public License`_
 

	
 
.. _`GNU Free Documentation License`: README-GFDL.html
 
.. _`GNU General Public License`: README-COPYING.html
 
.. _`Wiedenmann-Seile GmbH`: http://www.wiedenmannseile.de
 
.. _`Wolfgang Scherer`: sw@wiedenmann-seile.de
 

	
 
.. \||<-snip->|| stop
 

	
 
.. ==================================================
 
.. :rem:`|||:sec:|||`\ END
 
.. ==================================================
 
.. 
 
.. :ide-menu: Emacs IDE Main Menu - Buffer @BUFFER@
 
.. . M-x `eIDE-menu' ()(eIDE-menu "z")
 

	
 
.. :ide: DELIM: SNIPPETS (ABOUT)       |q|<- SYM ->||,   ||<- SYM ->||,  @| SYM @
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "||<-") (cons "->||" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "||<-") (cons "->||" nil)) t) (setq symbol-tag-match-rx "sn[i]p") (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons nil "@|") (cons "@" nil)))))
 

	
 
.. :ide: DELIM: SNIPPETS (DOC)          ||<- SYM ->||,     |: SYM :|,     ` SYM `
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "|:") (cons ":|" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "||<-") (cons "->||" nil)) t) (setq symbol-tag-match-rx "sn[i]p") (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons "\\(\\`\\|[^\\]\\)" "`") (cons "`" nil)))))
 

	
 
.. :ide: DELIM: SNIPPETS (SNIP DOC)     ||<- SYM ->||,     |: SYM :|,     @ SYM @
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "|:") (cons ":|" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "||<-") (cons "->||" nil)) t) (setq symbol-tag-match-rx "sn[i]p") (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons nil "@") (cons "@" nil)))))
 

	
 
.. :ide: DELIM: SNIPPETS (FILLME)       ||<- SYM ->||,     :: SYM ::,     @ SYM @
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "::") (cons "::" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "||<-") (cons "->||" nil)) t) (setq symbol-tag-match-rx "sn[i]p") (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons nil "@") (cons "@" nil)))))
 

	
 
.. :ide: DELIM: SNIPPETS (SUBST)        ||<- SYM ->||,      @ SYM @,      @ SYM @
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "@") (cons "@" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "||<-") (cons "->||" nil)) t) (setq symbol-tag-match-rx "sn[i]p") (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons "[^\\]" "`") (cons "`" nil)))))
 

	
 
.. :ide: +#-
 
.. . Snippet Delimiter Sets ()
 

	
 
.. :ide: DELIM: ReST (links)              ` SYM `_,    .. _` SYM `,      ` SYM `
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons "[^\\]" "`") (cons "`_" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil ".. _`") (cons "`:" nil)) t) (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons "\\(\\`\\|[^\\]\\)" "`") (cons "`" nil)))))
 

	
 
.. :ide: DELIM: STANDARD (GNU quoting)    |: SYM :|,       :: SYM ::,     ` SYM '
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "::") (cons "::" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "|:") (cons ":|" nil)) t) (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons nil "`") (cons "'" nil)))))
 

	
 
.. :ide: DELIM: STANDARD (ReST quoting)   |: SYM :|,       :: SYM ::,     ` SYM `
 
.. . (let nil (symbol-tag-normalize-delimiter (cons (cons nil "::") (cons "::" nil)) t) (symbol-tag-switch-delimiter-sets) (symbol-tag-normalize-delimiter (cons (cons nil "|:") (cons ":|" nil)) t) (setq symbol-tag-enclose-delimiter-set (symbol-tag-normalize-delimiter (cons (cons "[^\\]" "`") (cons "`" nil)))))
 

	
 
.. :ide: +#-
 
.. . Delimiter Sets ()
 

	
 
.. :ide: COMPILE: render reST as LaTeX
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2latex.py --traceback | tee " fn ".tex"))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as MAN
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2man.py --traceback "))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as TXT (via MAN)
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2man.py --traceback | man -l -"))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as ODT --strip-comments
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2odt.py --traceback --strip-comments | cat >" fn ".odt "))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as LaTeX, compile PDF and view with gv
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2latex.py --traceback | tee " fn ".tex && pdflatex '\\nonstopmode\\input " fn ".tex' && gv " fn ".pdf"))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as PDF
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2pdf -e ws_docutils.raw_role >" fn ".pdf"))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as HTML
 
.. . (let* ((fp (buffer-file-name)) (fn (file-name-nondirectory fp))) (save-match-data (if (string-match-t "[.][^.]*$" fn) (setq fn (replace-match "" nil t fn)))) (let ((args (concat " " fp " | ws_rst2html.py --traceback --cloak-email-addresses | tee " fn ".html "))) (save-buffer) (compile (concat "PATH=\".:$PATH\"; cat " args))))
 

	
 
.. :ide: COMPILE: render reST as pseudoXML
0 comments (0 inline, 0 general)