X-Git-Url: https://harishankar.org/repos/?p=biaweb2.git;a=blobdiff_plain;f=Readme.md;fp=Readme.md;h=679cdf22df621fdae19c28f60b0b88b65d435185;hp=3ec7e8ea7f25e4d9e50d739fcda90ee952ba5f46;hb=ca54cd9a481727176c82a43e7ca452cdbbdbc408;hpb=66b989cb0160f108446c772082d08af292c48327 diff --git a/Readme.md b/Readme.md index 3ec7e8e..679cdf2 100644 --- a/Readme.md +++ b/Readme.md @@ -67,11 +67,17 @@ If not, check whether you have installed all the requirements. ## Usage -### Getting started +### Getting started - creating the sources -Once you have successfully compiled BiaWeb2, you will want to create your website. +Once you have successfully compiled BiaWeb2, you will want to create your website +sources. +This is probably the longest step, since you need to create the directory structure +of your website (you probably want to plan this properly, though you can of course +easily change the structure by rearranging or moving the folders as needed). You also +need to create the content of your website. +A typical workflow is described below: 1. First create a base directory for your entire website project (including sources, templates, static resources like images etc.) Replace `~/path/to/mywebsite` with @@ -148,7 +154,8 @@ Once you have successfully compiled BiaWeb2, you will want to create your websit ### Setting up the templates -The _templates_ folder have the following files: +If you copied the _templates_ folder correctly from the BiaWeb2 sources, the _templates_ folder +within your `~/path/to/mywebsite/~ will have the following files: * doclistitem.tpl.html * doclist.tpl.html @@ -162,7 +169,138 @@ The _templates_ folder have the following files: * stringbits.txt * style.tpl.css -The minimum required files to be edited to get your website working are __main.tpl.html__, +The minimum necessary files to be edited to get your website working are __main.tpl.html__, __rssitem.tpl.xml__ and __rss.tpl.xml__ as those files need your website URL in the right places to work properly. The __style.tpl.css__ file is also of interest if you -want to modify the default look and feel of your site. \ No newline at end of file +want to modify the default look and feel of your site. + +__main.tpl.html__ is the base template and the file looks like this by default (only the key +parts are highlighted for clarity): + + + ... + +