Index: openacs-4/packages/attachments/www/doc/index.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/attachments/www/doc/index.adp,v diff -u -r1.1.2.5 -r1.1.2.6 --- openacs-4/packages/attachments/www/doc/index.adp 9 Jun 2016 13:03:12 -0000 1.1.2.5 +++ openacs-4/packages/attachments/www/doc/index.adp 5 Jul 2016 16:52:02 -0000 1.1.2.6 @@ -35,17 +35,17 @@ attachments is a service package that allows you to attach one or more file-storage files to any acs_object. attachments is mounted below a package that uses it, and -the application provides links into the attachments package's +the application provides links into the attachments package's UI.

1.1.2 At a high level, how does attachments work?

Before you can use the attachments package, each instance of your package must be mapped to a file-storage root folder.

-

The root folder is a "super folder" for all the files in that -specific instance of file-storage, and it is created automatically -when the file-storage package is instanciated.

+

The root folder is a "super folder" for all the files +in that specific instance of file-storage, and it is created +automatically when the file-storage package is instanciated.

When a user wants to make an attachment to an object in your package, she is shown the contents of the file-storage root folder mapped to your package instance. The user is also given the option @@ -55,14 +55,16 @@

1.2.1 Mount attachments under your package

-

The first step is to mount the attachments package under -your package. In the site-map, you should create a new -site-node (sub-folder) under your package called "attach".

-

"attach" is the standard URL, however URL this can be changed on -a site-wide basis by changing the "RelativeUrl" parameter of -any of the attachments packages (this works since there's -only one instance of attachments in the entire system. The same -instance is just re-mounted)

+

The first step is to mount the attachments package +under your package. In the site-map, you +should create a new site-node (sub-folder) under your package +called "attach".

+

"attach" is the standard URL, however URL this can be +changed on a site-wide basis by changing the +"RelativeUrl" parameter of any of the +attachments packages (this works since there's only one +instance of attachments in the entire system. The same instance is +just re-mounted)

1.2.2 Map an file-storage root folder to your package instance

@@ -87,8 +89,8 @@

Most likely, you want your package to work even if the attachments package is not installed on the system or if attachments is not properly mounted. To do this, add the following -proc to your package's API and wrap all calls to the attachments -package with it:

+proc to your package's API and wrap all calls to the +attachments package with it:

     ad_proc -private attachments_enabled_p {} {
         set package_id [site_node_apm_integration::child_package_exists_p \
@@ -118,7 +120,7 @@
 

1.2.4 Viewing attached files

-

You can use the "attachments::get_attachments" proc to see the -list of attachments to a given object.

+

You can use the "attachments::get_attachments" proc to +see the list of attachments to a given object.

Release Notes

Please file bugs in the Bug Tracker.