diff --git a/doc/setting_up_orng.html b/doc/setting_up_orng.html index 6438de25..53acd05f 100644 --- a/doc/setting_up_orng.html +++ b/doc/setting_up_orng.html @@ -35,20 +35,32 @@

-

Table of Contents

+

Table of Contents

-
    -
  1. Create database tables and procedures
    2. -
  2. Create configuration directory and key file
    3. -
  3. Modify Tomcat settings
    4. -
  4. Configure VIVO
    5. -
  5. Run the deployment script
    6. -
  6. Does it work?
    7. +
      +
    1. Installing and Configuring +
        +
      1. Create database tables and procedures
        2. +
      2. Create configuration directory and key file
        3. +
      3. Modify Tomcat settings
        4. +
      4. Configure VIVO
        5. +
      5. Run the deployment script
        6. +
      6. Does it work?
        7. +
      +
      2. +
    2. Setting up the Gadgets +
        +
      1. The shindig_apps database table
        2. +
      2. The shindig_app_views database table
        3. +
      +
    -

    I. Create database tables and procedures

    +

    I. Installing and Configuring

    + +

    I.i. Create database tables and procedures

    Shindig uses several database tables in MySQL to store its data: which gadgets appear on which pages, how large are the gadgets, @@ -85,7 +97,7 @@ process the file.

    -

    II. Create configuration directory and key file

    +

    I.ii. Create configuration directory and key file

    In your VIVO home directory, create a directory called shindig. Under that, create directories called conf and openssl. @@ -124,7 +136,7 @@ issue the command above, and copy the resulting file to your Windows machine.

    -

    III. Modify Tomcat settings

    +

    I.iii. Modify Tomcat settings

    The Shindig application must know where to find the configuration file that you created in Step I. @@ -149,7 +161,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080' export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.headless=true -Xms1024m -Xmx1024m -XX:MaxPermSize=128m'

    -

    IV. Configure VIVO

    +

    I.iv Configure VIVO

    In the VIVO distribution directory, the file called deploy.properties contains configuration options for the VIVO application. @@ -200,7 +212,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he -

    V. Run the deployment script

    +

    I.v. Run the deployment script

    At the command line, from the top level of the VIVO distribution directory, type: @@ -210,7 +222,7 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he to configure the ORNG Shindig application and deploy it to Tomcat's webapps directory.

    -

    VI. Does it work?

    +

    I.vi Does it work?

    Start VIVO. Enter a search term in the search box, and view the results. Check the gadgets there. Navigate to a person's profile page. Again, check for the expected gadgets. @@ -341,7 +353,191 @@ export CATALINA_OPTS='-Dshindig.host=localhost -Dshindig.port=8080 -Djava.awt.he + +

    II. Setting up the Gadgets

    + +

    + VIVO will look at tables in MySQL to determine what gadgets should be made available, + where they should appear, how big they will be, and much more. + At this time, VIVO doesn't provide a user interface to edit the contents of these tables. + Administrators will need to use a MySQL admin client, or SQL commands, to set these + parameters. +

    +

    + The tables are named shindig_apps and shindig_app_views, + and are described in the following sections. +

    + +

    II.i The shindig_apps database table

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeUsage
    appidint(11) + Identifies the gadget. + In particular, this will be used to determine which rows in the + shindig_app_views table should apply to this gadget. +
    namevarchar(255) + A user-friendly name for the gadget. + This will be displayed in the gadget's "Title Bar". +
    urlvarchar(255) + The location where the gadget's contents and behavior are defined. +
    PersonFilterIDint(11)unknown
    enabledtinyint(1) + If set to 0, this gadget will never be displayed. + If set to 1, it is displayed according to the rules in the shindig_app_views table. +
    channelsvarchar(255)unknown
    + +

    II.ii The shindig_app_views database table

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeUsage
    appidint(11) + Determines which gadget in shindig_apps is affected by this rule. +
    viewer_reqchar(1) + unknown +
    owner_reqchar(1) + unknown +
    pagevarchar(50) + What page does this rule apply to? + A single gadget might have several views, but no more than one view per page. + Recognized values are +
      +
    • + individual -- The profile page of an individual, when it is not in "edit" mode. + This applies when the viewer is not logged in, or does not have the right to edit the profile page. +
      • +
    • + individual-EDIT-MODE -- The profile page of an individual, when it is in "edit" mode. + This applies when the viewer is logged in as an administrator or other privileged user, or + as the owner of the profile page. +
      • +
    • + search -- The search results page. +
      • +
    • + gadgetDetails -- A page that contains only the selected gadget. This usually occurs when + the user clicks on an icon or a link that expands the gadget to full-page mode. +
      • +
    +
    viewvarchar(50) + What is the view-mode of the gadget? These are defined as part of the OpenSocial standards. +
      +
    • + profile -- The "standard" view, commonly used on the profile page of an individual +
      • +
    • + small -- The "condensed" view. +
      • +
    • + home -- The view which allows the user to change the gadget's settings. +
      • +
    • + canvas -- The "expanded", commonly used when the gadget is the only thing on a page. +
      • +
    +
    closed_widthint(11) + How wide is the gadget when it is closed? (in pixels) +
    open_widthint(11) + How wide is the gadget when it is open? (in pixels) +
    start_closedtinyint(1) + When the page is first loaded, is the gadget open or closed (1 = closed, 0 = open) +
    chromeIdvarchar(50) + The gadget will be displayed on the page inside a <div> with this id. + Note: the page must contain this <div> and its contents + will be replaced with this gadget (or gadgets). +
    display_orderint(11) + If more than one gadget has the same chromeId, they will be displayed in order by this field. +
    + + \ No newline at end of file