Index: openacs-4/packages/acs-content-repository/www/doc/guide/file-system.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/www/doc/guide/file-system.html,v diff -u -N -r1.1.1.1 -r1.1.1.1.30.1 --- openacs-4/packages/acs-content-repository/www/doc/guide/file-system.html 13 Mar 2001 22:59:26 -0000 1.1.1.1 +++ openacs-4/packages/acs-content-repository/www/doc/guide/file-system.html 22 Jun 2016 07:40:41 -0000 1.1.1.1.30.1 @@ -6,8 +6,8 @@

Organizing Content Items

- ACS Documentation : - Content Repository : Developer Guide + ACS Documentation : + Content Repository : Developer Guide

The content repository organizes content items in a hierarchical @@ -16,7 +16,7 @@

A freshly installed content repository consists of a single "root" - folder (analogous to the root directory / in UNIX or an + folder (analogous to the root directory / in UNIX or an empty partition in Windows or MacOS).
You organize items by creating subfolders under the root. @@ -29,8 +29,8 @@
Each item has a "file name" and an absolute "path" that is determined by its location on a particular branch of the repository tree. For example, the path to an item named - widget in the folder products would be - /products/widget. + widget in the folder products would be + /products/widget.

The content repository adds an additional twist to a traditional @@ -54,25 +54,25 @@

Consider a simple repository structure with the following contents:

Note the following:

The root folder of the content repository has a special ID which is - returned by the function content_item.get_root_folder. + returned by the function content_item.get_root_folder. -
Regular content items such as index and about +
Regular content items such as index and about may be stored directly under the root folder.
The "About Us" page has a photo as a child item. Note that the - path to the photo is /about/photo. Internally, the - photo's parent_id (in the cr_items table) is set to - the item_id of the "About Us" page. + path to the photo is /about/photo. Internally, the + photo's parent_id (in the cr_items table) is set to + the item_id of the "About Us" page.
The "Press" folder contains two items. Internally, the - parent_id of the "Press Index" and "Release One" items - are set to the item_id of the "Press" folder. + parent_id of the "Press Index" and "Release One" items + are set to the item_id of the "Press" folder.

Note that the same effective organization could have been achieved @@ -108,7 +108,7 @@

We only talk about creating content roots from here on — creating template roots is completely analogous. You create your own - content root by calling content_folder.new in PL/SQL: + content root by calling content_folder.new in PL/SQL:

 declare
@@ -122,22 +122,22 @@
   -- Store v_my_content_root in a safe place
 end;
 /

The important point is that you have to pass in 0 for the - parent_id. This parent_id is special in that it +

The important point is that you have to pass in 0 for the + parent_id. This parent_id is special in that it indicates folders with no parent.

The content repository does not keep track of who created what root folders. You have to do that yourself. In the above example, you need - to store the value v_my_content_root somewhere, for example + to store the value v_my_content_root somewhere, for example a table that is specific for your package, otherwise you won't have a reliable way of accessing your new content root.

With multiple content roots, there can be many items with - item_path '/news/article' and you need to tell the + item_path '/news/article' and you need to tell the content repository which root you are talking about. For example, to - retrieve content through content_item.get_id, you pass the - id of your content root as the root_folder_id parameter to - specify the content root under which the item_path should be + retrieve content through content_item.get_id, you pass the + id of your content root as the root_folder_id parameter to + specify the content root under which the item_path should be resolved.