More Readme.md updates
More Readme.md updates

Updates to Readme.md
Updates to Readme.md

Merge branch 'master' of gitlab.com:harishankarv/biaweb2

Readme.md updates
Readme.md updates

Started work on the Readme.md file
Started work on the Readme.md file for the basic documentation
on how to use BiaWeb2.

Started work on the Readme.md file
Started work on the Readme.md file for the basic documentation
on how to use BiaWeb2.

Minor Fix: Fixed bug for MAX_RSS_FEED
Fixed small bug in MAX_RSS_FEED - fixed the comparison operator
to < from <=

Minor fix: fixed the link text in NavigationBit generation
Fixed the link text to "title" of the DocumentTree rather than
the "stub" for better readability

Refactored DocListItem to take Document in constructor
Refactored DocListItem class to take Document in the
constructor instead of individual fields. Also fixed
minor issue in link in feed.xml link in DocumentTree
generation.

Check added for symlink - to avoid symlinks in the source path
Added check to prevent symlink from being followed in the
document tree generation to avoid complications. Also minor
change to rss item template

Minor change - fixed program args string
Fixed the program args string to include the -q option
which was missed out earlier

Made site template mobile friendly and added title to RSS feed
Added the category/page title to the RSS feed and also made the
site mobile template mobile friendly with CSS media queries and
meta viewport

Added RSS feed to each category
Added RSS feed to each category in the document tree

Program now takes options instead of hardcoded inputs
Used getopt() to take command line option for the source,
destination path and also template directory from the end user

Replaced cmake with scons
Replaced cmake build with scons

Minor change to CMakeLists.txt
Minor changes to CMakeLists.txt

Added some template changes - Document List now shows description
The document list now shows the brief description below the link
in the generate HTML

Refactored template loading to its own class for performance
Refactored template string loading to its own class to avoid
reading the template directory for every call to to_html() or
output_to_html ()

Separated the strings used for document tree generation from code
Separated the string bits used for document tree generation from
constant in-code strings to a separate template file
stringbits.txt. This will allow for customizability of common
strings.

Added Navigation bit to the top of documents for the categories
Added navigation bit for easier navigation to parent categories
from any page

Included functionality to describe the document in the input file
All input files (except index) require to be of the format
Title
Description
keywords
date of creation (YYYY-MM-DD HH:II Z) format

Changed the rendering code for templating output
Changed from the C sprintf to using library libfmt::format in C++
to use named parameters in the template. NOTE: This means the
template file cannot contain any { or } other than the template
variables otherwise it screws up. So moved the CSS stylesheet to its
own template

Functionality for generating website completed
TODO: add command line option for the tool instead of hard-coded
strings
TODO: add RSS feed XML template and classes to generate the RSS
feed for the site

Tree Website generation implemented
Completed the functionality to generate the HTML tree from a
source tree, using templates. TODO: further refinement of
generated HTML code

Added summary to the document tree index
Added summary field for the document tree index which will add
a summary content for the index before the list of documents

Document tree generation to HTML output completed
Completed the document tree generation - now the tree is created
along with all children and also the documents in the tree

Cleaned up the generation of document tree index
Cleaned up the generation of document tree by including a
destination dir and separating URL path from destination dir

First Commit
First commit of BiaWeb2 project