ejs stuff

README.md

@@ -6,7 +6,7 @@ See the software in action: [deadvey.com](https://deadvey.com)<br/>
 # Confiuration
 Read the [configuation guide](CONFIG.md) for configuration help (in config.json)
 
-# features
+# Features
 * post creation via the web frontend (no need to remote to your server to make a post)
 * multi user
 * powerful customisation
@@ -17,17 +17,16 @@ Read the [configuation guide](CONFIG.md) for configuration help (in config.json)
 * Markdown syntax in posts
 * Commenting on posts
 * sign up and delete account
+* ejs
 
 # Bugs
 * probably scales like shit
 * probably insecure as hell
 
-# planned features/todo list
+# Planned features/todo list
 * custom CSS _file_
 * custom strings use format indicators
 * seperate functions into modules
-* builtin crypto
-* ejs
 * user specific RSS feeds
 * atom
 * federation (looks tricky)
@@ -37,30 +36,15 @@ Read the [configuation guide](CONFIG.md) for configuration help (in config.json)
 * inline comments and docs
 * give each post a hard postID to prevent potential issues
 * clean up code a bit
+* comment pages?
 
-# format indicators
-* %% - A literal %
-* %A - List of tags
-* %B - List of tags, each one with a hyperlink to that tag page
-* %C - Post content
-* %D - Published date in the format specified by date_format
-* %E - Edited date in the format specified by date_format
-* %F - Pretty name
-* %G - Tag name (used for the tag page only)
-* %H - Frontpage hit count
-* %I - User description
-* %J - URL delete account
-* %L - URL Permanent link to the post
-* %M - comments
-* %N - the username of the user (poster)
-* %P - URL to create a new post
-* %O - URL to edit this post
-* %Q - URL to sign up
-* %R - Site wide RSS feed
-* %S - post seperator as defined by post_seperator
-* %T - Title
-* %U - URL the the user (poster)
-* %W - Site Description as defined by site_description
-* %X - Comment submission box
-* %Y - Site Name as defined by site_name
-* %Z - Attribution (to me) and source code link and license
+TODO (not finished)
+# EJS variable names
+* config.variable_name - pass any variable in config.json
+* hitcount - value in hitcount.txt (a single number)
+## Posts (/views/posts/)
+* post - an object that includes the data for that post, eg post.title, post.content etc
+* user - the object of the user who posted this
+* index - an int that refers to the index of the current post
+## Comments (/views/partials/comment.ejs)
+* comment - an object storing the comment, eg comment.name, comment.content