From ab939244c26743512763f64c5f4292826e4470c2 Mon Sep 17 00:00:00 2001 From: hukl Date: Sun, 15 Feb 2009 21:08:02 +0100 Subject: renamed readme so it will render nicely on github --- README | 120 ------------------------------------------------------------ README.rdoc | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+), 120 deletions(-) delete mode 100644 README create mode 100644 README.rdoc diff --git a/README b/README deleted file mode 100644 index c52596f..0000000 --- a/README +++ /dev/null @@ -1,120 +0,0 @@ -=CCCMS - -==Setup - -git clone git://github.com/hukl/cccms.git - -git checkout --track -b poc1 origin/poc1 - -git submodule init - -git submodule update - -==Import old xml files - -extract db/updates.tbz - -start a script/console and execute the following commands: - -i = UpdateImporter.new("#{RAILS_ROOT}/db/updates") -i.import_xml - -==Documentation - -User stories in doc/success_stories.txt - -execute: rake doc:app on the command line to get a html api documentation in -doc/app - -==General - -===Nodes - -The whole structure of the website is built from nodes. They live within a -nested set structure. Therefor a given node has parents, children, descendants -etc. - -The position of a node within the nested set corresponds directly to the URL -under which that node is accessible: - -root - \__updates - \__2009 - \___ultra_important_news - -http://domain/de/updates/2009/ultra_important_news - -Note that the first parameter after the domain is the locale. Everything after -the locale identifier is the unique path of a given node. The unique path itself -is generated from the slugs of the ancestors of a node. The last part of the -unique path is taken from the slug of the node. - -Once a node is added to the nested set or moved within, the unique path of that -node is generated from all its ancestors up to the root node. The computed path -is then saved on the node object itself, allowing the system to retrieve a -node simply by looking for the right url in the unique_path column. This is a -lot faster then walking down the tree. - -Nodes are really just proxy objects. They point to information but they don't -hold that information themselves. Instead they have pages associated to them. -When you want to render a particular node, you actually render a page associated -to that node. When multiple pages are attached to a node, they act as one page -with many revisions. The node itself holds the pointer to current or head -revision. - -===Pages - -Although there is really one Page class, the pages associated to one node differ -slightly. Obviously there is a slight difference between the head and the other -revisions. While the head is always the most recent page which is publicly -available, all the older revisions are only kind of a history. - -Now when a user wants to modify or edit the content of the head revision he or -she is editing a new revision instead. This new revision is considered a draft -and has the current content of the head revision copied onto itself. - -====Draft - -A draft has an author attached to it which makes sure that only the creator of -that draft is able to edit it. This is a form of pessimistic locking as it -prevents more than one user from editing and saving the same page. - -However, if an author should choose to abandon his draft or to let somebody else -finish it, the author can withdraw his lock. In this case, the draft has no -longer an author associated to itself which enables another user to edit this -draft. - -To abandon or revert a draft, the author can also delete it entirely so that -when another user is editing, he or she would get a fresh copy from the current -head revision. - -Of course a admin user can always override or remove locks on drafts. In case -an author created a draft but simply didn't care anymore, an admin could remove -that draft or the lock on it, enabling other users to edit that page again. - -===Tags - -Pages of course come with meta data attatched to them. Tags are one kind of -meta data. They can be understood and used as keywords, categories, tags or any -similar concept. - -===Templates - -Althought there is only one, simple and unified, template for editing pages, it -is possible to select from different templates for public display. This -selection of templates allows slight alterations of the layout. For example one -template would display every attribute of a page (like date, author, abstract) -while another template would hide this information away. One would show the tags -of a page, another wouldn't. - -===Aggregation - -Keywords and other meta data can be used to aggregate any ammount of pages -into the body of another page. - - \ No newline at end of file diff --git a/README.rdoc b/README.rdoc new file mode 100644 index 0000000..c52596f --- /dev/null +++ b/README.rdoc @@ -0,0 +1,120 @@ +=CCCMS + +==Setup + +git clone git://github.com/hukl/cccms.git + +git checkout --track -b poc1 origin/poc1 + +git submodule init + +git submodule update + +==Import old xml files + +extract db/updates.tbz + +start a script/console and execute the following commands: + +i = UpdateImporter.new("#{RAILS_ROOT}/db/updates") +i.import_xml + +==Documentation + +User stories in doc/success_stories.txt + +execute: rake doc:app on the command line to get a html api documentation in +doc/app + +==General + +===Nodes + +The whole structure of the website is built from nodes. They live within a +nested set structure. Therefor a given node has parents, children, descendants +etc. + +The position of a node within the nested set corresponds directly to the URL +under which that node is accessible: + +root + \__updates + \__2009 + \___ultra_important_news + +http://domain/de/updates/2009/ultra_important_news + +Note that the first parameter after the domain is the locale. Everything after +the locale identifier is the unique path of a given node. The unique path itself +is generated from the slugs of the ancestors of a node. The last part of the +unique path is taken from the slug of the node. + +Once a node is added to the nested set or moved within, the unique path of that +node is generated from all its ancestors up to the root node. The computed path +is then saved on the node object itself, allowing the system to retrieve a +node simply by looking for the right url in the unique_path column. This is a +lot faster then walking down the tree. + +Nodes are really just proxy objects. They point to information but they don't +hold that information themselves. Instead they have pages associated to them. +When you want to render a particular node, you actually render a page associated +to that node. When multiple pages are attached to a node, they act as one page +with many revisions. The node itself holds the pointer to current or head +revision. + +===Pages + +Although there is really one Page class, the pages associated to one node differ +slightly. Obviously there is a slight difference between the head and the other +revisions. While the head is always the most recent page which is publicly +available, all the older revisions are only kind of a history. + +Now when a user wants to modify or edit the content of the head revision he or +she is editing a new revision instead. This new revision is considered a draft +and has the current content of the head revision copied onto itself. + +====Draft + +A draft has an author attached to it which makes sure that only the creator of +that draft is able to edit it. This is a form of pessimistic locking as it +prevents more than one user from editing and saving the same page. + +However, if an author should choose to abandon his draft or to let somebody else +finish it, the author can withdraw his lock. In this case, the draft has no +longer an author associated to itself which enables another user to edit this +draft. + +To abandon or revert a draft, the author can also delete it entirely so that +when another user is editing, he or she would get a fresh copy from the current +head revision. + +Of course a admin user can always override or remove locks on drafts. In case +an author created a draft but simply didn't care anymore, an admin could remove +that draft or the lock on it, enabling other users to edit that page again. + +===Tags + +Pages of course come with meta data attatched to them. Tags are one kind of +meta data. They can be understood and used as keywords, categories, tags or any +similar concept. + +===Templates + +Althought there is only one, simple and unified, template for editing pages, it +is possible to select from different templates for public display. This +selection of templates allows slight alterations of the layout. For example one +template would display every attribute of a page (like date, author, abstract) +while another template would hide this information away. One would show the tags +of a page, another wouldn't. + +===Aggregation + +Keywords and other meta data can be used to aggregate any ammount of pages +into the body of another page. + + \ No newline at end of file -- cgit v1.3