# HG changeset patch # User neko259 # Date 2015-05-20 14:42:37 # Node ID 4961f75de9da702a2126d4074578b692ca4b52bc # Parent 762bb5078ec527226a73a8295e1225f4dbc581de Added sample document with post model reference diff --git a/docs/dip-2.markdown b/docs/dip-2.markdown new file mode 100644 --- /dev/null +++ b/docs/dip-2.markdown @@ -0,0 +1,29 @@ +# 0 Title # + +"post" model reference + +# 1 Description # + +"post" is a model that defines an imageboard message, or post. + +# 2 Fields # + +# 2.1 Mandatory fields # + +* title -- text field. +* text -- text field. +* pub-time -- timestamp (TBD: Define format). + +# 2.2 Optional fields # + +* attachments -- defines attachments such as images. +* attachment -- contains and attachment or link to attachment to be downloaded +manually. Required attributes are mimetype and name. + +This field is used for the opening post (thread): + +* tags -- text tag name list. + +This field is used for non-opening post: + +* thread -- ID of a post model that this post is related to.