SciBook

Introduction

SciBook is a framework for xslt transformation. The transformation can be extended by adding plugins. The software comes with a xhtml to html stylesheet to generate static html pages from xml template files.

Installation

Download the sources from the project page http://sourceforge.net/projects/scibook/ and unpack them with: tar xfz scibook-X.X.X.tar.gz To install SciBook run the script setup.py as root: ./setup.py install Use the option --prefix to change the installation directory. ./setup.py install --prefix=/usr/local

install as rpm

Run ./setup.py bdist_rpm instead. You will find the rpm under dist/.

CVS

CVS: http://cvs.sourceforge.net/viewcvs.py/scibook/scibook/

Requirements

SciBook requires Python 2.3 and the Pynana packegae, see http://pyana.sourceforge.net/

There is currently no Pyana rpm package available for all distributions. The pyana requirement will be added later to the SciBook package.

Usage

SciBook is called via commandline, run "scibook -h" to see all options. Write a simple index.xhtml Document like this:

        
<?xml version="1.0" encoding="ISO-8859-1" ?>

<html xmlns:scibook="http://scibook.sourceforge.net/2005/Extensions" >
<body>
    <h1>Hello World</h1>
    <scibook:latex>$\sqrt{2}$</scibook:latex>
</body>
</html>

run: "scibook -v index.xhtml -o index.html", output:

        
SciBook version 0.5.0
Copyright (C) 2005 Thomas Volk <thomas@my-volk.de>
tempdir: '/home/tom/tmp/tmpOYGFgM'
loading module 'SciBook.latex_plugin'
transform  'index.xhtml'
create image '70c3c6ee6627e49b9e84d99c689cf334.png'

run: "cat index.html" and you get:

        
<html xmlns:scibook="http://scibook.sourceforge.net/2005/Extensions">
<body>
<h1>Hello World</h1>
    <img src="70c3c6ee6627e49b9e84d99c689cf334.png">
</body>
</html>

The LaTeX generated image looks like this: $\sqrt{2}$

Reference

<scibook:include> include external documents
attributes: disable-escaping: the allowed values are "yes" or "no"; the default is no; if the value is yes, the text will be included without any escaping
href: document url

<scibook:insert> insert xml documents for transformation
attributes: href: document url

<scibook:latex> convert LaTeX code or complete files to images
childs: text(): LaTeX code like "$a + b = \sqrt{5}$"
attributes: disable-document-frame: the allowed values are "yes" or "no"; the default is no; if the value is yes, the LaTeX code will not put into a document frame

<scibook:time> returns current system time
childs: text(): format string; example format "%a, %d %b %Y %H:%M:%S" results to "Mon, 07 Mar 2005 17:49:37"; if the scibook:time element ist empty, scibook returns a string representing local time. see Python module time function strftime and ctime

Backlog

BackLog
=======
  - scibook:include new attributes: from-line - to-line, from-expression - to-expression
  - documentation (complete API doc)
  - img convert module
  - syntax highlight for sourcecode include module
  - support for Mathematical Markup Language (MathML)
  - support for Chemical Markup Language (CML)

Author

Thomas Volk

email: thomas@my-volk.de
homepage: http://www.my-volk.de



last modified: Wed Apr 6 16:40:26 2005