Micro Olive - Blogging application

[eluser]timaksu[/eluser]
hey guys, im working on a straight-forward blogging application at the moment. nothing functional to present yet but i figured i'd just post details about it up and see what you guys thought. i usually have a habit of not planning at all about how the application will work so this time i've done a little bit of documentation. its not as throughout as it should be but then again ive never done one.. hope it will suffice. its stopped me from making up features as i go along so far anyway! Once the first version is out, i might open source the project and see if i can get others to help. its heavily JavaScript/Ajax orientated and that isn't my strongest point.

heres the documentation stuff. it covers the very first version of the application. plugin support etc will be added later if it goes successfully. ive built it in a way (i hope anyway, since ive never done it before) that'll make it possible for this to be integrate.

Please note:
Since i have never run a proper project like this, i would like to hear your experianced opinion on how i can document and keep track of all the code efficiently. (i over heard something about phpdoc somewhere but wasnt sure exactly what it was about.).



Logo

• Incomplete doc - doc not yet complete.
• Outdated - scripted differently, doc needs updating.
• completed - coding is completed

Aim
MicroOlive will be a simple, easy to use blog that required very little fiddling and clicking around. It'll recapture the magic of blogging that bigger applications such as Wordpress have left behind in return for a larger feature range.


Pages

Home
shows all published posts
Unpublished (Admin)
shows all unpublished posts
Crumple Pile (Admin)
Shows all deleted posts which may be recovered.
Category A,B,C...
shows posts from that category. Both published + unpublished..
Post A,B,C...
shows individual posts and their comments.


Features

Making a post
1)Enter category page
2)Click options on the category page → menu opens up
3)new post button → new post form appears
4)Fill in fields: Post name, Content
5)Click publish button. → form disappears, becomes regular post.
1.May also leave unpublished.
Unpublishing a post
1)find post
2)click options → menu opens up.
3)Click unpublish from within the menu → confirmation popup box.
4)confirm confirmation. → post is styled as unpublished.
5)posts are retained.
Making comments
1)Go to the posts page
2)click on new comment → comment form appears
3)fill in comment form. Name, email (optional), message.
4)Publish. → comment form disappears; posts are refreshed and new one added on.
Removing comments
1)Find comment
2)click delete. → slide down box which shows “Reason” field, and confirmation button.
3)If provided author has provided email, he is informed with the custom message via email (or a default “Your comment on POSTNAME has been removed.”. The comment will be quoted and placed on the bottom of the email in either case. → comment fades out
Removing posts
1)Go to the post
2)click options → menu opens up.
3)Click delete from within the menu → confirmation popup box.
4)confirm confirmation. → post fades out
1.if on post page, redirect to home page.
6)all comments are deleted. No email sent.
Recovering posts
1)go to crumple pile page
2)pick post and click options → option menu appears
3)choose to recover either current date or created date.
4)Will get redirected to post page, with deleted post now recovered
5)review
6)republish → form disappears, becomes actual post
1.or leave unpublished.
Create Category
1)click on new category on under the category heading on the sidebar. → untitled category is added to sidebar.
2)Fill in name
3)confirm → category becomes text – form is removed.
Remove Category
1)Click on delete next to category name → confirmation popup box.
2)confirm confirmation. → category fades out
1.if on categories page, redirect to home page.
Login
1)click login button → login form popup
2)Fill in form and submit.
3)Error if not correct, log in and refresh page if it is (refresh required to reload content)
Logout
1)click logout button → confirmation popup
2)if yes, refresh page and logout. If no, close popup → confirmation fades out.


Models
The function names are unchanged but paramaters are a little different in the actual code (hence outdated.). will update soon once code is finalized..)
Posts →
1)get_latest(limit)
2)get_category(category_id , limit)
3)get_id(post_id)
4)save(post object , message) → creates new post if object→id is not supplied or does not exist
5)delete(post_id) → permanent
Categories →
1)get_all()
2)save(category object , message) → creates new post if object→id is not supplied or does not exist
3)delete(category_id)
Comments →
1)get_posts(post_id)
2)save(comment object , message) → creates new comment if object→id is not supplied or does not exist
3)delete(comment_id) → permanent

Controllers

Home
1)index
Crumple Pile
1)Index
2)_recover
3)_delete
Category
1)Index
2)_save
3)_delete
Post
1)Index
2)_save
3)_delete