Index: openacs-4/packages/acs-core-docs/www/how-do-I.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/how-do-I.html,v diff -u -r1.31 -r1.32 --- openacs-4/packages/acs-core-docs/www/how-do-I.html 25 Apr 2018 08:38:27 -0000 1.31 +++ openacs-4/packages/acs-core-docs/www/how-do-I.html 3 Sep 2024 15:37:32 -0000 1.32 @@ -1,116 +1,7 @@ -How Do I?
Alex logo
Prev Chapter 4. Configuring a new OpenACS Site Next

How Do I?

- -

How do I edit the front page of a new site through a web interface?

- -

The easiest way is to install the Edit-This-Page package.

-
  1. -

    Log in to the web site as an administrator.

    -
  2. -

    Click on Admin > Install Software > Install from OpenACS Repository / Install new application

    -
  3. -

    Choose Edit This Page and install

    -
  4. -

    Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).

    -
-
-

How do I let anybody who registers post to a weblog?

- -

Go to /admin/permissions and grant Create to Registered Users

-
-

How do I replace the front page of a new site with the front page of an application on that site

- -

Suppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.

-
  1. -

    On the front page, click the Admin button.

    -
  2. -

    On the administration page, click Parameters link.

    -
  3. -

    Change the parameter IndexRedirectUrl to be the URI of the desired application. For a default weblogger installation, this would be weblogger/. Note the trailing slash.

    -
-
-

How do I put custom functionality on front page of a new site?

- -

Every page within an OpenACS site is part of a subsite More information). The home page of the entire site is the front page is a special, default instance of a subsite, served from /var/lib/aolserver/$OPENACS_SERVICE_NAME/www. If an index page is not found there, the default index page for all subsites is used. To customize the code on the front page, copy the default index page from the Subsite package to the Main site and edit it:

-
  1. - 
    cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-subsite/www/index* /var/lib/aolserver/$OPENACS_SERVICE_NAME/www
    -
  2. -

    Edit the new index.adp to change the text; you shouldn't need to edit index.tcl unless you are adding new functionality.

    -
-
-

How do I change the site-wide style?

- -

Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files. Let's examine how this works:

-
  • -

    +How Do I?

    Alex logo
    Prev Chapter 4. Configuring a new OpenACS Site Next

    How Do I?

    How do I edit the front page of a new site through a web interface?

    The easiest way is to install the Edit-This-Page package.

    1. Log in to the web site as an administrator.

    2. Click on Admin > Install Software > Install from OpenACS Repository / Install new application

    3. Choose Edit This Page and install

    4. Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).

    How do I let anybody who registers post to a weblog?

    Go to /admin/permissions and grant Create to Registered Users

    How do I replace the front page of a new site with the front page of an application on that site

    Suppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.

    1. On the front page, click the Admin button.

    2. On the administration page, click Parameters link.

    3. Change the parameter IndexRedirectUrl to be the URI of the desired application. For a default weblogger installation, this would be weblogger/. Note the trailing slash.

    How do I put custom functionality on front page of a new site?

    Every page within an OpenACS site is part of a subsite More information). The home page of the entire site is the front page is a special, default instance of a subsite, served from /var/lib/aolserver/$OPENACS_SERVICE_NAME/www. If an index page is not found there, the default index page for all subsites is used. To customize the code on the front page, copy the default index page from the Subsite package to the Main site and edit it:

    1. cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-subsite/www/index* /var/lib/aolserver/$OPENACS_SERVICE_NAME/www

    2. Edit the new index.adp to change the text; you shouldn't need to edit index.tcl unless you are adding new functionality.

    How do I change the site-wide style?

    Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files. Let's examine how this works:

    • A templated page uses an ADP/Tcl pair. The first line in the ADP file is usually: -

      - 
      <master>
      -

      If it appears exactly like this, without any arguments, the template processor uses default-master for that subsite. For pages in /var/lib/aolserver/$OPENACS_SERVICE_NAME/www, this is /var/lib/aolserver/$OPENACS_SERVICE_NAME/www/default-master.adp and the associated .tcl file. -

      -
    • -

      The default-master is itself a normal ADP page. It draws the subsite navigation elements and invokes site-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp and .tcl)

      -
    • -

      The site-master draws site-wide navigation elements and invokes blank-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp and .tcl).

      -
    • -

      Blank-master does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.

      -
    -

    Figure 4.1. Site Templates

    - -
    Site Templates
    -

    -
    -

    How do I diagnose a permissions problem?

    - -
    • -

      - Steps to Reproduce.  - The events package does not allow users to register for new events. -

      -
      1. -

        Go to the http://yourserver.net/events as a visitor (ie, log out and, if necessary, clear cookies). This in on a 4.6.3 site with events version 0.1d3.

        -
      2. -

        Select an available event

        -
      3. -

        A link such as Registration: Deadline is 03/15/2004 10:00am. + 

        <master>

        If it appears exactly like this, without any arguments, the template processor uses default-master for that subsite. For pages in /var/lib/aolserver/$OPENACS_SERVICE_NAME/www, this is /var/lib/aolserver/$OPENACS_SERVICE_NAME/www/default-master.adp and the associated .tcl file. +

      4. The default-master is itself a normal ADP page. It draws the subsite navigation elements and invokes site-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp and .tcl)

      5. The site-master draws site-wide navigation elements and invokes blank-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp and .tcl).

      6. Blank-master does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.

    Figure 4.1. Site Templates

    Site Templates

    How do I diagnose a permissions problem?

    • Steps to Reproduce. The events package does not allow users to register for new events.

      1. Go to the http://yourserver.net/events as a visitor (ie, log out and, if necessary, clear cookies). This in on a 4.6.3 site with events version 0.1d3.

      2. Select an available event

      3. A link such as Registration: Deadline is 03/15/2004 10:00am. » Login or sign up to register for this event. is visible. Click on "Login or sign up" -

        -
      4. -

        Complete a new registration. Afterwards, you should be redirected back to the same page.

        -
      -

      Actual Results: The page says "You do not have permission to register for this event."

      -

      Expected results: A link or form to sign up for the event is shown.

      -
    • -

      - Finding the problem.  - We start with the page that has the error. In the URL it's http://myserver.net/events/event-info.tcl, so open the file /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/events/www/event-info.tcl. It contains this line: -

      - 
      set can_register_p [events::security::can_register_for_event_p -event_id $event_id]
      -

      We need to know what that procedure does, so go to /api-doc, paste events::security::can_register_for_event_p into the ACS Tcl API Search box, and click Feeling Lucky. The next pages shows the proc, and we click "show source" to see more information. The body of the proc is simply

      - 
      return [permission::permission_p -party_id $user_id -object_id $event_id -privilege write]
      -

      This means that a given user must have the write privilege on the event in order to register. Let's assume that the privileges inherit, so that if a user has the write privilege on the whole package, they will have the write privilege on the event.

      -
    • -

      - Setting Permissions.  - A permission has three parts: the privilege, the object of the privilege, and the subject being granted the privilege. In this case the privilege is "write," the object is the Events package, and the subject is all Registered Users. -

      -
      1. -

        To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".

        -
      2. -

        Click "Grant Permission"

        -
      3. -

        Grant the write permission to Registered Users.

        -

        Figure 4.2. Granting Permissions

        - -
        Granting Permissions
        -

        - -
      -

      OpenACS 5.0 offers a prettier version at /admin/applications.

      -

      Figure 4.3. Granting Permissions in 5.0

      - -
      Granting Permissions in 5.0
      -

      -
    -
    -
    Prev Home Next
    Setting Permissions on an OpenACS package Up Chapter 5. Upgrading
    docs@openacs.org
    +

  • Complete a new registration. Afterwards, you should be redirected back to the same page.

Actual Results: The page says "You do not have permission to register for this event."

Expected results: A link or form to sign up for the event is shown.

  • Finding the problem. We start with the page that has the error. In the URL it's http://myserver.net/events/event-info.tcl, so open the file /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/events/www/event-info.tcl. It contains this line:

    set can_register_p [events::security::can_register_for_event_p -event_id $event_id]

    We need to know what that procedure does, so go to /api-doc, paste events::security::can_register_for_event_p into the ACS Tcl API Search box, and click Feeling Lucky. The next pages shows the proc, and we click "show source" to see more information. The body of the proc is simply

    return [permission::permission_p -party_id $user_id -object_id $event_id -privilege write]

    This means that a given user must have the write privilege on the event in order to register. Let's assume that the privileges inherit, so that if a user has the write privilege on the whole package, they will have the write privilege on the event.

  • Setting Permissions. A permission has three parts: the privilege, the object of the privilege, and the subject being granted the privilege. In this case the privilege is "write," the object is the Events package, and the subject is all Registered Users.

    1. To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".

    2. Click "Grant Permission"

    3. Grant the write permission to Registered Users.

      Figure 4.2. Granting Permissions

      Granting Permissions

    OpenACS 5.0 offers a prettier version at /admin/applications.

    Figure 4.3. Granting Permissions in 5.0

    Granting Permissions in 5.0

    • Prev Home Next
    Setting Permissions on an OpenACS package Up Chapter 5. Upgrading
    docs@openacs.org