diff --git a/contrib/templates/default/attachment.mustache b/contrib/templates/default/attachment.mustache deleted file mode 100644 index e69de29..0000000 diff --git a/contrib/templates/default/board.mustache b/contrib/templates/default/board.mustache index c2e49fb..1458b39 100644 --- a/contrib/templates/default/board.mustache +++ b/contrib/templates/default/board.mustache @@ -1,3 +1,16 @@ +{{! + board.mustache, displays the contents of page N of the board + + template parameters: + - board ( the model of the current page ) + - page ( the page number of the current page ) + + board has the properties: + - Prefix ( absolute path like //site.tld/ or /path/ ) + - Board ( the name of the board ) + - Navar ( a function that renders the navbar, should not be escaped ) + - Threads ( a list of Thread Models with the last few replies ) +}} @@ -7,7 +20,7 @@ - {{{board.RenderNavbar}}} + {{{board.Navbar}}} diff --git a/contrib/templates/default/keygen.mustache b/contrib/templates/default/keygen.mustache index c9765f0..d3136ea 100644 --- a/contrib/templates/default/keygen.mustache +++ b/contrib/templates/default/keygen.mustache @@ -1,3 +1,11 @@ +{{! + keygen.mustache -- page containing a newly generated tripcode + template parameters: + - prefix ( the site prefix ) + - public ( the public key in hex ) + - secret ( the secret key in hex ) + - tripcode ( html version of the public key ) +}} diff --git a/contrib/templates/default/modlogin_result.mustache b/contrib/templates/default/modlogin_result.mustache index e422b75..885677d 100644 --- a/contrib/templates/default/modlogin_result.mustache +++ b/contrib/templates/default/modlogin_result.mustache @@ -1,3 +1,11 @@ +{{! + modlogin_result.mustache -- shows the result of a login attempt + template parameters: + - prefix ( the site prefix ) + - mod_prefix ( the prefix to the mod panel, could be something like https://mod.site.tld/ or /mod/ ) + - message ( the message returned from the login attempt ) + - fail ( present if the login failed ) +}} diff --git a/contrib/templates/default/modpage.mustache b/contrib/templates/default/modpage.mustache index 2084838..3cd6437 100644 --- a/contrib/templates/default/modpage.mustache +++ b/contrib/templates/default/modpage.mustache @@ -1,3 +1,9 @@ +{{! + modpage.mustache -- the moderator panel when logged in + template parameters: + - prefix ( the site's prefix ) + +}} diff --git a/contrib/templates/default/navbar.mustache b/contrib/templates/default/navbar.mustache index 9e453da..90d6b06 100644 --- a/contrib/templates/default/navbar.mustache +++ b/contrib/templates/default/navbar.mustache @@ -1,7 +1,17 @@ -
+{{! + navbar.mustache -- element on the top of each nod-mod page + + TODO: make this not suck, have a board list, have board page list + + template parameters: + - name ( the name of whatever resource we are on, board/thread ) + - frontend ( the name of the frontend we are on ) + - links ( a list of Link Models to display ) + +}}
- {{{board.Name}}} + {{name}} on - {{{board.Frontend}}} + {{frontend}}
\ No newline at end of file diff --git a/contrib/templates/default/post_success.mustache b/contrib/templates/default/post_success.mustache index 5f0718f..8ea0136 100644 --- a/contrib/templates/default/post_success.mustache +++ b/contrib/templates/default/post_success.mustache @@ -1,5 +1,11 @@ +{{! + post_success.mustache -- shown when we do a successful post + template parameters: + - redirect_url ( the url of the next page we should redirect to ) + - message_id ( the value of the Message-ID header in the post we made, the truncated sha1 of this is the >>posthash ) +}} - + 
posted as {{message_id}}
diff --git a/contrib/templates/default/postform.mustache b/contrib/templates/default/postform.mustache index cb27660..f45ff4a 100644 --- a/contrib/templates/default/postform.mustache +++ b/contrib/templates/default/postform.mustache @@ -1,6 +1,7 @@ {{! - postform.mustache - template parameters: + postform.mustache -- the form for posting + + template parameters: - post_url ( the url of the post form ) - reference ( the post we are replying to, or empty string if it's an op ) - button ( the text for the reply button ) diff --git a/contrib/templates/default/static_base.mustache b/contrib/templates/default/static_base.mustache deleted file mode 100644 index 1d5d67d..0000000 --- a/contrib/templates/default/static_base.mustache +++ /dev/null @@ -1,9 +0,0 @@ - - - - {{title}} - - - {{{content}}} - - \ No newline at end of file diff --git a/contrib/templates/default/thread.mustache b/contrib/templates/default/thread.mustache index ab972e9..cd10f10 100644 --- a/contrib/templates/default/thread.mustache +++ b/contrib/templates/default/thread.mustache @@ -1,3 +1,16 @@ +{{! + thread.mustache -- renders to a thread-*.html page, shows the entire thread + template parameters: + - board ( the Board Model of the board this thread was posted in ) + - thread ( the Thread Model of the current thread being rendered ) + - form ( the post form markup ) + + Thread Model attributes: + - OP , the Post Model of the original poster + - Replies , a list of all the replies or empty if none + - Board , the name of the Board this thread is on + - BoardURL , the url that points to the board index page +}} @@ -6,6 +19,11 @@ {{thread.OP.Subject}} + + + {{{thread.Navbar}}} + +
{{{form}}} @@ -15,10 +33,10 @@
{{{thread.OP.RenderPost}}} - {{# repls}} + {{# thread.Replies}} {{{RenderPost}}}
- {{/ repls}} + {{/ thread.Replies}}

diff --git a/contrib/templates/default/ukko.mustache b/contrib/templates/default/ukko.mustache index ccfb984..5399ad3 100644 --- a/contrib/templates/default/ukko.mustache +++ b/contrib/templates/default/ukko.mustache @@ -1,6 +1,12 @@ +{{! + ukko.mustache -- overboard, contains the last threads posted regardless of newsgroup + template parameters: + - prefix ( site prefix ) + - threads ( a list of Thread Models that represent the latest threads ) +}} - ukko + ukko / overboard diff --git a/contrib/templates/keygen.mustache b/contrib/templates/keygen.mustache deleted file mode 100644 index 5624825..0000000 --- a/contrib/templates/keygen.mustache +++ /dev/null @@ -1,13 +0,0 @@ - - - - here is a new tripcode - - - 
New Tripcode:
-      secret: {{secret}}
-      public: {{public}}
-      tripcode: {{tripcode}}
-
- - \ No newline at end of file