more file documentation

master
BodgeMaster 2020-03-12 22:57:54 +01:00
parent e6e61dd1ed
commit d70cf6e3db
1 changed files with 19 additions and 0 deletions

19
threadr/board/README.md Normal file
View File

@ -0,0 +1,19 @@
# A short overview of the files:
### index.php
Somewhat obvious...
$_GET values:
* id → the board id
* action → what action file should be loaded in the bottom section (see below)
* valid actions: [not present], post, submit, edit
### board.php
the top part of a board page, displays the posts, loaded via include()
### post.php
one of the action files for the bottom of the page, displays a form to add a post, loaded via include()
### submit.php
displays a message in the bottom of the page and submits a new post, loaded via include()
### edit.php
? [Will look into it later, seems not to do very much ATM]
### default.php
displays a button giving the user the option to post something
### README.md
this file