File: README.txt

package info (click to toggle)
pubtal 3.5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 1,296 kB
  • ctags: 910
  • sloc: python: 8,027; xml: 150; makefile: 49
file content (76 lines) | stat: -rw-r--r-- 2,747 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
PubTal 3.5
----------
A template driven web site builder for small sites.

Installation
------------
Full installation instructions for Linux, MacOS X and Windows can be found in documentation/html/installation.html.

To install PubTal under Unix:
  (Note that to perform the installation of PubTal you will probably
   have to have the Python Development package installed.)
  
  1 - Become root
  2 - Run "python setup.py install"
	
Installing Plugins
------------------
PubTal supports the addtion of new functionality through a plugin architecture.
Several plugins are installed by default with PubTal to provide support for
HTMLText, OpenOffice, Catalogue, Binary, and Raw content types.

Additional plugins that are not installed by default can be found in the
optional-plugins directory.  Currently these include:

 textile.py - provides Textile (http://www.textism.com/tools/textile/) 
 support.  This requires pyTextile (http://diveintomark.org/projects/pytextile/)
 and Python 2.2 to be installed.

 abiwordContent - provides AbiWord content support.  AbiWord currently has
 some significant bugs, which is why this plugin is not installed by default.
 
 CSVPlugin - Provides support for generating multiple web pages base on the
 contents of a .CSV file.  Documentation on how to use this plugin is included
 in the main documentation.

To install these extra plugins (or any other PubTal 2.x plugin) simply copy
 the plugin to the location of the PubTal plugin directory, beneath the Python 
site-packages directory.

(Under Debian this is can be found in: 
/usr/lib/python2.2/site-packages/pubtal/plugins/)

Alternative add the following configuration option to your site configuration
file, replacing /usr/local/PubTal/plugins/ with the path to the plugin dir:

<SiteConfig>
additional-plugins-dir /usr/local/PubTal/plugins/
</SiteConfig>


The Commands
------------
PubTal has one command used to build a site's HTML pages, and one to upload 
generated pages.

The command for generating a site is: updateSite.py configFile

To upload a site use the uploadSite.py command, details of which can be found 
in the documentation.
	
Getting Started
---------------
Documentation for PubTal can be found in the documentation/html/
directory.  

Additionally there are several example websites included for experimentation
under the examples directory.  A very straight forward example is 
in examples/homepage/ and a more complicated example demonstrating 
macros is in examples/macro-example/

Migrating between PubTal 2.x and 3.0
------------------------------------
All 2.x PubTal sites should work, without any changes, in the 3.x series.

Any custom written plugins for 2.x will need to be updated to reflect internal
API changes.