Configuration

JCar makes it easy to embed archived items within Joomla!.

NOTE: Some of the following topics assume you have a working knowledge of configuring components and creating menu items.

Component Options

JCar provides various component-wide settings; these are available from the "Options" button in the JCar control panel.

SEF Generation

Generate Menu Item: When a user browses an archived item from a category, JCar can create a menu item and redirect to it. This generates a search-engine-friendly (SEF) url which improves search engine indexing and makes it easy to find information on your web site. Select "Yes" to enable this feature.

If "Generate Menu Item" is set to "Yes", the following settings are also available:

Menu: Select the menu under which new items should be created.

Parent Id: Select the parent menu item under which new items should be created.

Assets

Version 1.1.0 introduces new configuration options for streaming files such as PDFs straight to the browser without users being prompted for action via the Save As... dialog box.

Maximum Inline Size: The maximum size (in bytes) of a file that will open automatically in the web browser when clicked on in the item page.

Inline Mime Types: A comma-separated list of mime types of files which will open automatically in the web browser when selected from the item page.

Both these values must be set for a file to open automatically; for example, if a PDF file which is 1 megabyte in size should open in the browser window using the browser's PDF viewer plugin, Maximum Inline Size must be set to larger than 1 megabyte and Inline Mime Types must contain application/pdf in its list.

Display Archived Information in Joomla!

JCar enables you to display entire collections, item lists and item information within Joomla!.

Display All Categories

JCar uses the Joomla! term "categories" to group items with common attributes whilst archives may use terms such as "sets" or "collections".

To display a list of all categories via the Menu Manager;

• Create a menu item. Select the menu item type "JCar - List All Categories".

Display a Single Category

A single category displays details about the specified category as well as a list of items which belong to the category.

To display a list of all categories via the Menu Manager;

• Create a menu item. Select the menu item type "JCar - Category List",
• Under Category Id, specify the category type (DSpace, OAI, etc) and a valid category identifier. For example, if you are displaying a collection from DSpace with the id of 1000, you would select the category type "JCar - DSpace" and specify an id of 100.

Display a Single Item

A single item contains descriptive information about what is archived (metadata) and allows users to download the archived files that make up the item.

To display a list of all categories via the Menu Manager;

• Create a menu item. Select the menu item type "JCar - Category List",
• Under Item Id, specify the item type (DSpace, OAI, etc) and a valid item identifier. For example, if you are displaying an item from DSpace with the id of 1000, you would select the item type "JCar - DSpace" and specify an id of 100.

Embed an Archived Item in a Joomla! Article

Archived items can be embedded in Joomla! articles using the {jcar} embed code. In its simplest form, the jcar embed code requires one value, the identifier:

{jcar item-type:identifier}

Some valid jcar embed codes:

```{jcar dspace:123}

{jcar oai:oai.domain.tld/123456789/100}```

JCar comes with an editor button which provides an easy way to generate the embed code.

Additional attributes can be used to further customize how the item is retrieved. Which attributes are available will depend on the JCar plugin specified in the identifier.