acclaim documentation

62
ACCLAiM Documentation Release 1.0 eResearch Centre, James Cook University June 17, 2014

Upload: others

Post on 09-Dec-2021

6 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: ACCLAiM Documentation

ACCLAiM DocumentationRelease 1.0

eResearch Centre, James Cook University

June 17, 2014

Page 2: ACCLAiM Documentation

Contents

1 Introducing ACCLAiM and Plone 21.1 Site Layout: An Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2 Much ado about content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3 Navigation within the site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.4 Compared to other CMS platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Getting started 52.1 Logging in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2 Permissions and access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Working with ACCLAiM 93.1 Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93.2 Creating and managing forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93.3 Working with videos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4 Adding and editing content 124.1 Creating new content items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124.2 Editing existing content items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134.3 Uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144.4 Adding images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154.5 Uploading an updated version of a file or image . . . . . . . . . . . . . . . . . . . . . . . . . . . 154.6 Organise your content using folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164.7 Setting the document metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174.8 Setting advanced metadata properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184.9 Renaming content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

5 Managing and publishing content 215.1 Permissions overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215.2 Granting access to your content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225.3 Workflows and document publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245.4 Creating public content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255.5 Reviewing content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265.6 Editing a published document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275.7 Publishing a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275.8 Checking access permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

6 Using other types of content 296.1 Adding and editing events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296.2 Adding and editing news items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306.3 Adding links as content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306.4 Adding a Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316.5 Creating online forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

i

Page 3: ACCLAiM Documentation

7 Customising layout and design 427.1 Folder display options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427.2 Change the home page for a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437.3 Sorting a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447.4 Enabling next/previous folder navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457.5 Managing portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

8 Interacting with content 508.1 Commenting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508.2 Searching for content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518.3 Transferring multiple files and folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

9 Frequently Asked Questions - FAQ 569.1 I’ve created a page, but my custom script/embed/Flash/widget is being stripped . . . . . . . . . . 569.2 The title bar covers or obscures my logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569.3 I can’t edit or modify content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569.4 How can I grant access to my documents? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579.5 How can I find a page that I created? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579.6 How can I reorder content within a folder? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

10 Glossary 58

11 Indices and tables 59

ii

Page 4: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

This documentation covers the most important aspects to ACCLAiM (https://acclaim.edu.au), including an intro-duction to content managment, a layout overview, and information about site management.

Contents 1

Page 5: ACCLAiM Documentation

CHAPTER 1

Introducing ACCLAiM and Plone

ACCLAiM utilises open-source CMS (Content Management System) called Plone (http://www.plone.org) to al-low users to easily share content, files, and other digital objects within a web environment without needing to learnweb authoring technologies. Being a CMS, Plone can be used to constructure a flexible, content-driven website,interactive web portal, or a secure collaborative workspace.

Access ACCLAiM at https://acclaim.edu.au to get started.

1.1 Site Layout: An Overview

The ACCLAiM site will be laid out in a similar fashion to that shown below, depending on what features andcustomisations have been made. Remember that the image of the site will almost certainly look slightly differentto what is shown below as both content and overall theme, including fonts, colours, layout, may have potentiallybeen customised.

This example shows a user with full access. How ACCLAiM appears to you depends on whether you are loggedin, and what permissions your user account has in any particular area of the site. Permissions are dynamic and canchange across different folder or content, depending on the site.

1. Top navigation tabs are links across the top of a page are the top-level of navigation. Primary foldersor other types of content can be added or changed here with appropriate permissions. Typically, a siteadministrator will configure these top-level links. For the general public or normal users, however, theseserve as a quick way to access the main areas of information on the portal.

2

Page 6: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

2. Content management views are the tools for editing and managing content that you have access to. If thisset of tabs is not present, then it is likely that you only have view access to the current folder or content item.

3. Content action menus is a set of menus that perform various actions relating to the management of content:

State This controls the workflow state (and thus permissions) for content.

Add new Create and upload of new content, images, folders and more. Content is created by type, and thismenu lists all types of content a user can create.

Display Controls the appearance of a folder or a content item. For example, folders can be configured toshow dynamic listings or tables, or otherwise have a content item show as its home page.

Actions Provides the ability to cut, copy, and paste content items within a site, as well as the ability todelete and rename items. Other custom actions may be present underneath this menu.

4. Search is a search engine for content on the site. Users can enter keywords from any part of content,including titles, descriptions, and full text to find results. Content inside of various files, including PDFs,Microsoft Office files and more, are searchable.

5. Main page content displays the primary body of information on a given page is displayed here, which willchange dependent on the type of content being viewed. If the current content item is a Page, then the body ofthe document will be displayed. If the current item is an Image, then a thumbnail and picture metadata willbe shown. If the current page is a Folder, then this may display a listing of content present or be configuredto show just a single page.

6. Portlets are small windows of information may be configured on the left or right-hand side of any page.Portlets typically display snippets of content and links to other information on a site. One such example is aNews portlet, which will aggregrate information about news items that exist on the site. There are a numberof different portlets available by default, including some that can pull in information from external sourceslike RSS feeds.

7. Personal menu is a drop-down menu revealing access to personal preferences, the user dashboard, andthe ability to log out. Site administrators can use this menu to access the site control panel. Certain otheroptions may be available depending on your level of access.

1.2 Much ado about content

There are many types of content that can be created, viewed, downloaded or commented upon with a site, includ-ing:

Event An upcoming event, meeting, conference, or some other incident. Objects of this type typically appearunder events listings on the site.

File Individual content uploaded from a local computer. Users may download or access the given file via linksinside Pages or directly from Folder listings.

Folder Similar to those on a hard drive, folders contain content and are used to give a site structure. Folders canbe nested to any depth required and will typically be displayed in navigation listings for ease of access byusers.

Image Storage type for pictures uploaded from a local computer. Images can be inserted into Page content,displayed in albums and lists, and otherwise stored for viewing. Supported image types include JPEG, GIF,PNG and TIFF.

Link Automatic link to another web address, which may be another item in the portal or to an external resource.

Page The main content for a site is contained within Pages, which can feature text, images, hyperlinks, and otherrich HTML.

News Item A piece of related to a notable occurrence, such as a press release or update. Objects of this typetypically appear under news listings on the site.

There may be others based on the site configuration and your user’s level of access.

1.2. Much ado about content 3

Page 7: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

By default, content that is created will be displayed in navigation listings for ease of access. This behaviour iscustomisable either on a site-wide basis or for individual content items or folders.

For in-depth information about content management, see Adding and editing content (page 12).

1.3 Navigation within the site

ACCLAiM is similar to other sites and web-based systems: they consist of structure and content and feature aweb-based editor to add and modify content. For example, a site may have any number of folders, images, pages,files, and other types of content. The structure can be nested in any format, and as deep as required, much likestructuring a computer’s hard drive or a network share.

As new content is added, it will appear either in the top-level navigation of the site, or if placed into sub-foldersand nested, then in the Navigation portlet listing, which appears automatically as required.

Read more about Customising layout and design (page 42).

If unsure of the location of a particular file or folder, use the Search box at the top of an page. Just type in a nameor keyword, and a list of all related documents will be displayed.

1.4 Compared to other CMS platforms

If you’re familiar with other open-source CMS platforms, such as Joomla, Wordpress or Drupal, ACCLAiM issimilar and performs in a simliar fashion. Plone, the platform that ACCLAiM is built on, is notably more secure,and provides a number of interactive, collaborative workspace tools for users to interact.

1.3. Navigation within the site 4

Page 8: ACCLAiM Documentation

CHAPTER 2

Getting started

2.1 Logging in

In order to make any changes or perform actions on ACCLAiM, the first and most significant step is to access thesite and log in. To perform any content management tasks, such as creating content or modifying existing items,or to access secured content, you also must have been granted suitable permissions.

Because ACCLAiM utilises Single Sign On (SSO) you will utilise an existing set of credentials to log in. Due tothe nature of this process, in order to share content with colleagues, each individual must log in to ACCLAiM atleast once before they can be given access.

Most users will use their existing institutional username and password (or other credentials) to log in via theAustralian Access Federation (AAF).

2.1.1 Institutional Authentication

Important: Before proceeding, ensure that your credentials have been provided by an institution or researchorganisation, rather than being local to ACCLAiM. If you attempt to sign in to an institution’s authenticationsystem using local ACCLAiM credentials, this process will fail.

1. The login link is located in the top-right hand corner of the page:

2. You will be presented with the option to utilise AAF authentication to log in.

3. Select your institution or organisation from the dropdown box.

Note: If your institution or organisation doesn’t appear in the list, then you should contact your IT sup-port staff about whether you are part of the Australian Access Federation (AAF). If you are a collaborator

5

Page 9: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

associated with an organisation subscribed to the AAF, then you can obtain an AAF Virtual Home accountby following the instructions in the AAF Virtual Home User Guide (https://vho.aaf.edu.au/guides/user-guide.pdf).

4. Click the Login button.

5. Enter your institutional or organisational credentials and login.

Note: This is a screen shot of the James Cook University login page - your institution’s page will lookdifferent and may behave in a slightly different manner.

6. You may be prompted to release certain details about yourself from your organisation, including name,email address, and other particulars. You must accept this to continue so that you can be identified withinour system.

7. Once logged in, notice that your name is displayed at the top-right hand corner and that you can click onthis to display the user actions menu.

2.1.2 Local Authentication

For local authentication, use the instructions that follow.

If you are visiting your site for the first time, the site administrator needs to have provided you with a usernameand temporary password. Otherwise, ensure that you know your pre-existing credentials.

1. The login link is located in the top right hand corner of the page.

2. Click on the Local Login link.

3. Enter the user name and password that you have for the portal.

2.1. Logging in 6

Page 10: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

4. Click on the login button.

5. If you are unable to login, you can retry your login. If you have forgotten your password, follow the givenlink to start the reset process.

2.1.3 Logging out

When you’re finished working with ACCLAiM, you should always ensure that you log out.

1. Click your username in the top-right hand corner of the site to reveal the user actions menu.

2. Click the Log out link.

Note: If you are logged in via your instutional credentials, you can log out of the portal, but yourbrowser will remember you for use on other Australian Access Federation (AAF) services. To log outentirely, either quit the browser you use are using, or clear all cookies relating to aaf.edu.au and|project-server-host|.

2.1.4 If you cannot log in

Insitutional Authentication

Since authentication is provided by your institution directly, please refer to your local helpdesk for troubleshootingand password reset requests. For details on how to contact your helpdesk, please refer to your insitution’s website.

Local Login

If you are unable to login to the portal, you may have forgotten your password. If you believe this is the case, clickonto the Local Login link, and then click on Forgot your password? and follow the steps.

If you still can’t log in, or have forgotten your username, then contact the site administration for assistance.

2.2 Permissions and access

Each user can be granted specific role (page 21) in different areas of the site. Roles can be granted either site-wide(called global roles (page 22)), which are the managed by site administrators, or granted within a specific area ofthe site (called local roles (page 22)), which can be managed by users that already have permissions.

Access can be granted either to a specific user or a group of users. Creation and management of groups of users ismanaged by site administrators.

2.2. Permissions and access 7

Page 11: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Issues or concerns about insufficient access should be directed towards your site administrator or nominated rep-resentative.

For more information on granting and controlling access, see Granting access to your content (page 22).

2.2. Permissions and access 8

Page 12: ACCLAiM Documentation

CHAPTER 3

Working with ACCLAiM

ACCLAiM is a collaborative venture between medical schools in Australia and New Zealand that focuses onbenchmarking graduate outcomes in the clinical domain. The ACCLAiM portal provides several key aspects offunctionality, which are detailed below.

3.1 Getting started

Make sure you have perused the documentation on Logging in (page 5) and have authenticated to ACCLAiM. Thefollowing documentation covers topics related to ACCLAiM-specific functionality. For all other information aboutcontent management and other general functionality, see Adding and editing content (page 12) and subsequentpages.

3.2 Creating and managing forms

For full details about how to manage online forms, see Creating online forms (page 32). This documentationincludes how to create forms, add and modify form fields, and work with captured data.

3.3 Working with videos

Videos can be uploaded to the site following the same methodology as creating any other content. It will be helpfulfor you to review the documentation on Adding and editing content (page 12) first before proceeding, as this willhelp you understand the basics of content management.

3.3.1 Adding a new video

Important: Because the ACCLAiM site is designed for examiner training, you should take care when addinginformation to the uploaded video. Aspects like the title and summary are displayed to users and thus you shouldtake care not to give away the expected results. For example, use more generic names about training stations andvideo numbers rather than explaining what grade the video pertains to.

1. Browse to the location in the site you wish to add the video.

2. Click Add new → Video.

3. Add suitable metadata to the video, including a title and a summary of the content of the video. Pay attentionto the important note above.

4. Choose the Video File to upload from your computer. See Technical suggestions (page 10) for detailson formats and settings.

9

Page 13: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

5. Configure the width and height for the video display in pixels. This is the size at which the video will beshown on the page initially, and users have the ability to make the video full-screen on their device. Smallersettings (or using the defaults) is suggested for mobile users.

6. Ignore the YouTube URL and Subtitle file fields.

7. Add any rich text you would like to be displayed underneath the video into the Transcript area. Thiscould include images, links, or to other sites that might relate to the video.

In particular, adding a link to a given form the user needs to fill out is especially useful, and you may wishto configure the link to open in a new window, for ease of use by a visitor.

8. Configure any other metadata required. See Setting advanced metadata properties (page 18) for moreinformation.

9. Click the Save button to create your video content item. This content item can now be linked to, shared,and otherwise used as any other piece of content on the site.

3.3.2 Technical suggestions

• Videos must be uploaded in .mp4 format for maximum compatibility with a viewer’s browser (standardH264 video codec and AAC audio codec). Without this configuration, videos are likely to fail to play ormay exhibit unusual behaviour.

• Viewers may be looking at your video on many different devices, so a high level of video compression (or alower video bitrate) is recommended. Contact your video production or technical staff for more information.

• Maximum resolution of around 720p should be sufficient for both a detailed experience on desktopbrowsers, but small enough for viewing on mobile devices as well.

• ACCLAiM uses MediaElement.js to integrate the playback of videos in the site. This open-source projectaims to enable HTML5 video support in a common fashion across all browsers and devices. For browsersand platforms that lack H264 capabilities, either a Flash-based or Silverlight-based player will be used as afallback.

• Blank video playback or videos failing to play at all are likely an indicator of incorrect video or audio codecspresent within your uploaded video. Check the codec information using a program like VLC Media Playeror the command-line avprobe on Mac or Linux and confirm as per the Technical suggestions (page 10)above.

3.3.3 Editing a video

1. Browse to the location in the site you wish to modify.

2. Click the Edit link on the page.

3. Modify the relevant settings on the page. For example, you could upload a new version of a video or changethe video’s title or description.

4. Click Save to make your changes.

3.3.4 Viewing a video

Note: If you experience issues with displaying a video, check to make sure you’re using the latest version ofyour browser. For platforms that do not support MP4 natively (earlier versions of Internet Explorer and someLinux browsers), ensure your Adobe Flash Player (http://get.adobe.com/flashplayer) and Microsoft Silverlight(http://www.microsoft.com/silverlight) (if on a Windows platform) plugins are installed and up-to-date.

1. Browse to the location in the site where the video is located, or use the direct web address provided to you.

2. Click or tap the large play icon in the middle of the video.

3.3. Working with videos 10

Page 14: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

3. The video will begin playing.

4. Use the controls provided to play, pause and skip to another part of the video. Videos can be made full-screen using the button at the right.

5. For mobile devices such as smartphones and tablets, the video will likely display full-screen whilst playing.Click the relevant button to minimise and close the video once done.

3.3.5 Troubleshooting

If a video fails to playback in your browser, contact the site administrator to have them ensure the video is in thecorrect format. If a file is of the MP4 format, the video must be produced accordingly to the Technical suggestions(page 10) above.

3.3. Working with videos 11

Page 15: ACCLAiM Documentation

CHAPTER 4

Adding and editing content

ACCLAiM is built to be a fully-featured Content Management System (CMS), meaning that users are able to addand edit content directly via the web. Within ACCLAiM, all content management is done in-place, unlike someother content management systems which require you to use an administration interface or similar. Simply put,where you put the content is where it will appear and exist.

4.1 Creating new content items

ACCLAiM stores content as individual objects that can be accessed by a site visitor. Essentially, as a user, youcreate a content item and it is stored by ACCLAiM. For example, you may wish to store a web page that someonecan view, an image that could be included in a page, or a file that can be downloaded. There are several ways ofcreating content on ACCLAiM - the most commonly used method is via the web interface.

4.1.1 What kind of content can I post?

Before getting started, take a moment to become familiar with the different types of content that the site can hold.The following lists the basic types that ACCLAiM can store.

Event An upcoming event, meeting, conference, or some other incident. Objects of this type typically appearunder events listings on the site.

File Individual content uploaded from a local computer. Users may download or access the given file via linksinside Pages or directly from Folder listings.

Folder Similar to those on a hard drive, folders contain content and are used to give a site structure. Folders canbe nested to any depth required and will typically be displayed in navigation listings for ease of access byusers.

Image Storage type for pictures uploaded from a local computer. Images can be inserted into Page content,displayed in albums and lists, and otherwise stored for viewing. Supported image types include JPEG, GIF,PNG and TIFF.

Link Automatic link to another web address, which may be another item in the portal or to an external resource.

Page The main content for a site is contained within Pages, which can feature text, images, hyperlinks, and otherrich HTML.

News Item A piece of related to a notable occurrence, such as a press release or update. Objects of this typetypically appear under news listings on the site.

There may be others based on the site configuration and your user’s level of access.

By default, content that is created will be displayed in navigation listings for ease of access. This behaviour iscustomisable either on a site-wide basis or for individual content items or folders.

12

Page 16: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

4.1.2 Special types

ACCLAiM also features several content types that perform specialised tasks. These include:

Collection A grouping of other content. Similar to a saved search, in that content of a certain type is groupedtogether. Collections can only be added by an administrator.

Form Folder A special folder that is used to build a form. Form folders can have fields, data capture tools, andspecial pages added to them. Forms are especially useful for making a site interactive.

4.1.3 Creating new content

Note: In order to create new content on ACCLAiM, your user account requires specific permissions in the areaof the site you wish to add the content. Depending on the site’s security configuration, you may already have thisaccess or may need to request it from your site administrator.

To determine whether you have access, browse to the area that you wish to add content. If you can see the Addnew drop-down menu, permission has been granted.

Follow the steps below to create a new content item.

1. Ensure that you are logged in.

2. Browse to the location you wish to create the new content item.

For example, if you would like to create a new Page in a section called About Us, then you would browseto the About Us section in order to create it there.

3. Locate the Add new drop-down menu and click it. You will see a list of content types that you can choose:

4. Choose the appropriate type of content you wish to create.

5. Fill in the fields on the creation page. Note that some fields may be marked as required.

6. Click the Save button to create the content. This may take a moment as your content is created.

7. The page will reload and display your new content item.

4.2 Editing existing content items

You can edit any item that you have created or that you have been granted access to. Editing most types of contentwill track historical changes, allowing you to jump back to any point in the content’s history and either view thatold version or restore it.

Important: File and Image content items will not track previous versions, due to the potential for significantstorage required.

To edit a content item:

1. Browse to the content item you wish to edit.

4.2. Editing existing content items 13

Page 17: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

2. Click on the Edit tab.

1. Edit the content item, changing the relevant fields that displayed.

2. For most content items, you have the ability to add comments in the Change Note field. If you add adescription of your changes, they will be recorded against the content item’s history, which can assist if youever need to revert these changes.

3. Click the Save button to commit the modifications.

4. The page will reload and display your modified content item.

4.3 Uploading a file

You can upload any files accessible on your local computer to ACCLAiM, including files that might be located ona network share drive.

The instructions below describe the steps to add a pre-existing file to the site. The steps are similar for other typesof content, such as images.

1. Browse to the location you wish to upload one or more files.

2. Click Add new → File, following the same process as creating other content.

4.3. Uploading a file 14

Page 18: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

3. Add relevant file metadata, and browse for a file to upload. Adding extra information as a title and descrip-tion will make the file easily discoverable and improve its appearance in navigation and listings.

4. Click the Save button to upload the file to the site.

5. The page will reload and display the uploaded file, and show how it can be downloaded later.

If you have multiple files to upload, it is possible to connect to ACCLAiM using WebDAV using the instructionsin Transferring multiple files and folders (page 52).

The resulting page shows what visitors to the page will see, including extra details such as the file’s type, size anddate modified.

4.4 Adding images

Images can be uploaded to ACCLAiM for inclusion in your Pages or for separate display in collections, such asphoto albums or image galleries.

1. Follow the same process for Uploading a file (page 14), except that rather than choosing the File contenttype, use Add new → Image.

2. All other steps are the same as the above process and the metadata required matches that required for Filecontent.

Once created, if the image is a browser-compatible format (GIF, JPEG, or PNG) then it will be displayed oncontent view pages. The image can now be inserted into Page content using the visual editor.

4.5 Uploading an updated version of a file or image

A common task is updating a given file or image with a fresh version. The process follows the same methods asEditing existing content items (page 13).

4.4. Adding images 15

Page 19: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Important: File and Image content items will not track previous versions, due to the potential for significantstorage required. This means that by uploading a new version of a file you will permanently replace the oldercopy.

1. Browse to the content item you wish to edit.

2. Click on the Edit tab.

3. Only the marked fields are required, as was the case when you created the content originally. Note thatfields are already populated with the existing content metadata.

4. To update your file, click the Replace with new button, and click the Browse button to select the newversion of the file.

5. Click the Save button to commit your changes and replace the file.

4.6 Organise your content using folders

Folders are typically used to structure your content items in a logical, structured fashion, much as you would usethem on a computer’s desktop or hard drive. ACCLAiM supports creating any number of folders, and these canbe nested or organised in any fashion that fits best. To add a new folder:

1. Browse to the location you wish to create the folder. This might involve traversing down several levels offolders to find the right spot for your folder.

2. Click Add new → Folder, following the same process as creating other content.

4.6. Organise your content using folders 16

Page 20: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

3. Enter the relevant metadata for the folder; a title that will be displayed in navigation and a description forexplaining what the folder contains.

4. Click the Save button to finish the creation process.

You can now add content into this folder, including folders as well, following the Creating new content (page 13)process.

4.7 Setting the document metadata

Important: Document metadata is very important because users and visitors to the site need to be able to easilylocate and identify your content.

Appropriate titles and rich descriptions will improve the appearance of your pages and content, and will improvesearchability both on the site, and if the content is public, via search engines.

Each item on ACCLAiM has specific properties, called metadata. This metadata is displayed in various fashionson the site, such as titles being displayed as a heading when viewing a page and in navigation, and descriptionsallowing documents to be found easily via searches. As you experiment with managing content, you will noticehow changing metadata fields affect the display of content on the site.

If you’ve gone ahead and created content or edited existing content, you’ve already experienced modifying meta-data. Although it’s a fancy word, metadata just means data about the content that you’ve created.

4.7.1 Types of metadata

Note: Keep in mind that metadata will vary from one content type to another.

In general, however, the most common metadata consist of the following:

Title The title of the item, which is displayed in the title, as a heading, in navigation and listings.

Description A short description of the content, which will be displayed as a subtitle on content, as well as beingused in searches and search engine metadata.

Body text Rich text which can be crafted to be displayed on the content item. For content types such as Page,News Item, and Event, this will feature as the main content on the page. It is possible to cut and pastecontent in from other documents and applications. Note that not all content types have this field.

Change note A textual note that describes changes that are being made to a given content item at one particu-lar time. Making change notes enables you to easily ascertain what happened to a content item, when ithappened, and who performed the action.

4.7. Setting the document metadata 17

Page 21: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

4.8 Setting advanced metadata properties

You can control your content even further with advanced metadata properties.

In order to control various aspects of how your content interacts with ACCLAiM, there are many other metadataaspects that can be modified. To see the complete overview of what metadata can be modified for a given contentitem:

1. Browse to the content item you wish to modify.

2. Click on the Edit tab to access the edit interface.

3. Look for these collapsed tabs on the page:

The extra metadata items are described below. Keep in mind that some of these aspects won’t appear on all contenttypes, or might appear under different tabs for certain content types.

4.8.1 Categorisation

Tags Categories that the given content it should be associated with. Content associated with the same tags can befound via search. Tags will also be displayed when viewing the content item.

Related items Associate one item to other content that exists on the site. Related items will be displayed whenviewing the content item.

Location A textual location string associated with the content. This will be displayed beneath the content item’smetadata when viewed.

Language Specify the language that the content item has been written in or for. By default, content on ACCLAiMwill default to English. Note this is a metadata-only field and has no effect on the actual text of the content.

4.8.2 Dates

Publishing Date Configure a publishing date to hide the content from navigation until the date and time haspassed. For instance, use this for a news item that should be visible after a certain time. Also known as theEffective Date.

Expiration Date Configure to hide the content from navigation once the date and time has passed. For instance,use this for a news item that should only be visible until a certain time.

4.8.3 Creators

Creators A line-by-line list of user IDs (or full names, if no user exists) of creators for the given content item.The principal creator - the user listed first - will be displayed in the content item’s byline as by [user’sname].

4.8. Setting advanced metadata properties 18

Page 22: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Contributors A line-by-line list of names of contributors to this piece of content. Contributors are displayed inthe content item’s byline.

Rights A statement of copyright or other information regarding the content object. Rights are displayed in thecontent item’s byline.

4.8.4 Settings

Allow comments Toggle whether other users can comment on the given contnet item. For some content types,this will be enabled by default. Enabling this will display a comments form at the bottom of the contentitem.

Exclude from navigation Explicitly exclude the current content item or folder from appearing in navigationlistings, including navigation portlets or the top-level navigation tabs

Presentation mode For Page content items only. Displays a special presentation link that automatically generatesa slideshow from page content. This relies on a well-structured document with headings and lists to workwell.

Table of contents For Page content items only. Displays a table of contents on the page, drawn from headingsand subheadings included in the body text. This is a quick and easy way of helping users navigate your page,especially if the given page is lengthy. Ensure that your page content is divided up into logical sections,with appropriate headings and subheadings for this to be most effective.

4.9 Renaming content

Within ACCLAiM, content is identified using short names, which are unique within any given folder or area andare used as part of the item’s URL; you’ll see the identifier in your web browser’s address bar.

This ID is automatically generated based upon the Title that was specified when the content was first created.This will automatically remove any special characters that are disallowed in URLs and attempt to normalise theshort name.

In some cases, the default short name assigned will be either overly complicated or simply not indicative of whatthe content consists of. The good news is that you can easily adjust the short name to be anything you’d like.

Note: Don’t worry about existing links to your content! ACCLAiM will automatically keep track of all ofyour old short names and URLs such that anyone still using old links will be redirected automatically to the newaddress. Any links within your own content on ACCLAiM will automatically point to the new short.

To do this, decide whether you wish to rename just one item or several:

4.9.1 Renaming one content item or folder

Note: If you’re attempting to rename a folder and the folder has a default view, the site will ask you to renamethe default view itself, rather than the surrounding folder. To access the folder explicitly, see Renaming severalitems at once (page 20) and access the folder using its parent. Read more about Default views (page 43).

1. Browse to the given content item or folder you wish to rename.

2. Click Actions → Rename.

3. Adjust the short name or title as required.

4. Click Rename all to complete the process.

5. Your content is now accessible using the new short name and URL. See the note above (page 20) for details.

4.9. Renaming content 19

Page 23: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

4.9.2 Renaming several items at once

1. Browse to the folder that holds the content items or folders you wish to rename.

2. Click Contents to view the main contents listing for the folder.

3. Select the checkboxes next to each item in the listing you wish to rename.

4. Click the Rename button at the very bottom of the listing.

5. Adjust the short names or titles as required. You do not need to change every field that is present, only whatyou want to modify.

6. Click Rename all to complete the process.

7. Your content is now accessible using the new short name and URL. See the note above (page 20) for details.

4.9.3 Benefits

Benefits of simple, descriptive short names will help in several ways:

• Shorter identifiers make for shorter URLs. Google and other search engines will value shorter, descriptiveaddresses and rank your content higher.

• Remember that users may be typing in your web URL directly. Shorter URLs will help anyone doing this.This is especially useful if you’re creating publications or emailing links to people.

• Having a shorter URL with clear words will make identifying what your page is about easier.

4.9. Renaming content 20

Page 24: ACCLAiM Documentation

CHAPTER 5

Managing and publishing content

ACCLAiM offers extremely flexible and granular security for content items that are stored on the site. Content canbe shared with individuals or groups of users following Granting access to your content (page 22), and contentcan be published to the public with Creating public content (page 25).

5.1 Permissions overview

First, make sure you’re aware of what roles can be granted to individuals or groups of users. A level of accessbelow corresponds to a role for a particular area of the site.

Important: Take care when assigning access to other users. Always double-check the person or group you aresharing with is correct and that you trust them with the access you’re providing. Also make sure you are grantinga suitable level of access to the right range of content.

Warning: Granting users more access than they require can be both useful, and potentially dangerous. Takecare.

5.1.1 Access types

Ac-cess

Description

Canadd

Allows new content objects to be created in this folder, granting access to the Add new menu. Thishas no effect on non-folder content. Corresponds to the Contributor role.

Canedit

Allows editing of existing content, granting access to the Edit tab against content. Corresponds tothe Editor role.

Canreview

Allows the user to publish and review content, granting access to extra controls in the State menu.Corresponds to the Reviewer role.

Canview

Allows the user to see private content. Use this permission to grant access to specific folders andcontent areas on a portal. Corresponds to the Viewer role.

5.1.2 Roles

The core content-centric roles are as follows:

Contributor Users can create content in the areas they have been granted this role. This provides access to theAdd new menu.

Editor Users can modify and delete content where they have been granted this role. This provides access to theEdit tab and controls for deleting and moving content.

21

Page 25: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Reviewer Users with this role can publish and retract content from being accessible to the public. This providesaccess to the State menu.

Viewer Users with this role can see content that is in the Private workflow state.

For site administration purposes, there are two additional special roles:

Site Adminstrator Special site-wide role for administrators granting access to all content and all content man-agement abilities. Can adjust most site setup configuration options, with the exception of managing complexand lower-level system settings such as the Zope Management Interface (ZMI).

Manager Special site-wide role with all permissions and abilities. Users with this permission are effectivelysuper users and can do everything, everywhere.

5.1.3 Local and site-wide roles

Roles can be applied to grant users permissions in one of two different ways, either as local roles or assite-wide roles. Local roles are applied just for a specific area on the site, being either a specific con-tent item, or for an entire folder. This is the most typical manner in which to grant users access to content becauseit can be controlled on a very granular level. For example, a certain user or set of users should have access to acertain folder or file, whilst other users should not. This is the process described under Granting access to yourcontent (page 22) and users are able to self-manage permissions without requiring a site administrator’s assistance.Site-wide or global roles are applied by a system administrator and grant a given user or set of users access across

the entire site. This is useful in the situation where a user is a content administrator or review personnel for allcontent across a site. Care should always be taken which granting any unrestricted access across a site.

5.2 Granting access to your content

Important: The creation of groups for sharing is not supported by ACCLAiM.

Sometimes you’ll want to give access to individuals rather than the whole Internet; you can choose to share yourdocument with a particular person.

Important: Keep in mind if you see this message:

then you should take care to decide whether you want permissions to apply to this content item (the default viewfor the folder) or whether you want the permissions to apply to the whole folder. In almost all cases, you will wantto click the go here link and apply permissions to the folder.

5.2. Granting access to your content 22

Page 26: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

In order to selectively grant access to some content:

1. Browse to the piece of content that you’d like to share, or browse to the folder that surrounds the content ifyou’d like to grant access to the entire folder.

2. Click on the Sharing tab

3. Search for a name by typing it into the search box and clicking the Search button. You can also search forpartial names, email addresses, or user IDs as well.

4. When the appropriate entry appears, select the permissions in the same row to grant different types of access.You should refer to Access types (page 21) mentioned above if you’re unsure what each permission does.

5. Click the Save button to make the changes. Permission changes take effect immediately.

5.2.1 Sharing with all logged in users

Note: Be extremely careful and ensure this behaviour is what you want. Contact your site administrator if you’reunsure.

It is possible to share content with anyone who is able to log into ACCLAiM by selecting the Logged-inUsers entry that appears on the Sharing tab, and granting permissions to this special group of users.

Keep in mind that by providing access in this way, all users on your site (which may be many different users) willbe granted permission to your content.

5.2.2 Inheriting permissions

The Inherit permissions from higher level checkbox controls whether the current content itemor folder uses the same permissions as the parent folder. This means that the permissions are inherited downwardsfrom higher levels.

You may wish to enable or disable this functionality depending on your security requirements. For example, ifyou want one specific area to have customised security, then you may want to disable this option. Alternatively,if you want security to automatically apply from the higher-level folder, leave this enabled. For sharing-basedaccess, the page will always display the resultant security settings for you to peruse.

5.2. Granting access to your content 23

Page 27: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

To enable or disable this functionality:

1. Select or deselect the checkbox on the Sharing page.

2. Click the Save button to make the changes. The page will refresh and show you the resulting accesspermissions for the content item or folder.

5.3 Workflows and document publishing

Note: Workflows play an important role in content security and control who can see the content, inclduingwhether it is accessible to the public.

5.3.1 What is a state and what is a workflow?

A state is a condition that a piece of content is in as part of a workflow, which is a process that your content passesthrough before it becomes available to others on ACCLAiM.

The state controls visibility and overarching permission to access the content. When an item is first created, itsstate is Private. Typically, users will require their content to be reviewed (placed into the Pending state) beforeit is published to the public (the Published state). Full details about what each of these relates to are outlined inWorkflow states (page 24).

Users without the Can review permission (or Reviewer role) are prevented from making content availableto the public. This process commonly requires a content manager or site administrator to be part of the workflowto ensure that content posted meets standards set by you or your group. In some cases, this may not be veryimportant, if all users should be able to publish documents, but is imperative in others, such as when all contentmust remain private or when content must be reviewed prior to posting.

Note: Whilst this sounds onerous, in the case of simpler environments, the workflow process may be as simpleas ‘all content is private’ or ‘no approval is necessary’ with the appropriate configuration in place.

5.3.2 Workflow states

At each point in the workflow your document will have a different state. These states are listed below:

5.3. Workflows and document publishing 24

Page 28: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

State DescriptionPrivate

• Only visible/editable by creator and site admin-istrators

• Can be shared with individuals via Sharingtab

• Must be published before being visible to public• Content managers can publish immediately

Pending• Has been submitted for review through work-

flow• Awaiting a decision from content manager or

site administrator• User with Reviewer role may publish or re-

ject this• Accessed in the same way as other Private con-

tent

Published• Are available to all site visitors• Visible to the public, without login• Content managers can retract back to being Pri-

vate.

For ACCLAiM, File and Image content types are configured specially to inherit the parent folder’s workflowstate. This means that if the surrounding folder is Private then the files or images will be as well. The sameapplies to publishing content - in order to publish files or images, then the surrounding folder must be published.

5.3.3 The State menu

Changes to a piece of content’s workflow state (and thus its visibility) are controlled via the State drop-downmenu, visible when you are viewing that piece of content.

This menu also displays the current state of your content, which is colour-coded to suit. This colourisation willbe shown elsewhere on ACCLAiM, such as in navigation and in folder listings, to help you identify the state ofcontent.

In addition to being able to change the state of the current content item, when looking at folders, the menu alsoprovides an Advanced link. This advanced page allows fine-grained control over changing several items at once,and changing all items within sub-folders.

5.4 Creating public content

Private content is extremely useful for many purposes, but there will typically come a time that you need to publishcontent to the public.

1. If you haven’t already, proceed with the instructions for Creating new content (page 13) first.

2. Browse to the content item that you would like to make public. It is also possible to publish a folder as wellusing the same process.

3. Click State → Publish.

5.4. Creating public content 25

Page 29: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

(a) If you can’t see this, then you don’t have access to publish documents. If you feel you should havethis access, you’ll need to contact your content manager or site administrator for access.

(b) If you see Submit for publication under the menu instead, then click this and the contentwill be submitted to your content manager for approval. You will need to now alert the relevant personto publish the content for you.

5.5 Reviewing content

Note: If you have suitable permissions, you’ll have the ability to review content for yourself and other users.Content manager and site administrators have this permission by default.

The review list is shown on your dashboard when you have review permissions and there are items to review. Thislist contains items that have been submitted by other users for review. Your dashboard can be accessed via Usermenu (your name) → Dashboard.

If you don’t see this on your dashboard, you can add it easily via Edit → Add portlet – it’s called a Reviewlist portlet.

5.5.1 Reviewing an item

In order to review a given content item:

1. Visit your dashboard and click the link to the item for review. Otherwise, browse to the content item to bereviewed.

2. Use the State drop-down menu (see The State menu (page 25)) to make a decision regarding either publishingor rejecting this item.

5.5. Reviewing content 26

Page 30: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

At this point you have the following choices for this item:

Reject the item Reject the item by selecting Send back from the State drop-down menu.

• You would reject the item if you feel that it is not appropriate for the site, or if it requires more work.

• This returns the item to the Private state.

• If you want to add comments describing why the document was rejected, click onto State → Advancedfirst before rejecting it. Enter your comments here and select Reject to change the document’s state.

Approve the item

Important: Keep in mind that you may need to adhere to organisational policies or procedures whenpublishing documents on the web. The publishing process is your responsibility and your username isassociated with all publications.

Approve the item by selecting Publish from the State drop-down menu.

• This changes the content into the Published state.

• The content is now publicly available on the Internet.

Edit the item As the reviewer, you have permission to edit the document yourself. You can make any changesthat are necessary and then approve the item.

Do nothing If you’re not sure whether this item is suitable or not, you can simply leave it as it is.

This will leave the document in its Pending state for the time being. Keep in mind that it will eventuallyneed to be either approved, edited or rejected. You may wish to seek advice from another site administratoror reviewer about the content.

5.6 Editing a published document

In order to make an edit to a previously published document, there are two choices, depending on who you are:

Content authors

• The original author can choose Retract from the State drop-down menu, which moves the documentback into the Private state.

• The author can then make changes and save the content, and add it back to the review list using theState menu.

• It must be approved by the reviewer or content manager and to be published again.

Content managers

• Content managers or site administrators can edit any document or content.

• Upon editing content, it is republished without the need to go through the workflow process again.

• Take care when making changes as they become immediately visible.

5.7 Publishing a folder

You can choose to make folders public if you would like to share the data within it. As with all other publicationof content, this can be reviewed later if necessary.

Important: On ACCLAiM, file and image content items inherit the workflow state of their parent folder. Thismeans that if you include these content items inside pages or otherwise link to them, they will not be available tothe public until you publish their folder (or move them into a published folder).

5.6. Editing a published document 27

Page 31: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

The same workflow associated with normal content applies to folders, so refer to Creating public content (page 25)for more information.

5.8 Checking access permissions

There are a number of different areas where permissions can be granted in order to allow other users or the publicaccess to your content. The following is a summary of where to look and what to check if you’re experiencing anyissues with access:

1. Check the workflow state of the item (the State menu). In order to only share with select people, ensure thestate is set to private.

2. Check the Sharing tab on the content item. This view displays all applicable customised permissions,including those that are being inherited from parent or higher-level folders.

3. Check the permission inheritance setting on the Sharing view. This can be toggled on or off to controlwhether permissions from parent folders are inherited by this content.

5.8. Checking access permissions 28

Page 32: ACCLAiM Documentation

CHAPTER 6

Using other types of content

6.1 Adding and editing events

The Event content type allows you to create events for others to see. These events can be automatically includedon the calendar portlet, and in other locations. In order to add an event:

1. Browse to the location in the site you wish to add this. Typically, there will be a dedicated Events folderthat already exists. If not, consider creating one as a way of grouping your content items.

2. Create the new event via Add new → Event

3. Complete the information as required to construct your event item. The following is a guide on whatmetadata corresponds to what aspect of the event:

Metadataitem

Description

Title The name of the eventDescription A short description with details about the eventEvent location Where the event is going to be heldEvent starts Date/time in the formatEvent ends Date/time in the formatEvent bodytext

Rich text with full details about the event. Can include images, formatted text, linksand more.

Attendees List of people who are to be attendingEvent URL A web address related to the eventContactDetails

Various details about whom to contact about the event.

4. Click Save to create your content item.

5. If the resulting content needs to be published, then follow the instructions for Creating public content(page 25).

29

Page 33: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

6.2 Adding and editing news items

The News Item content type allows you to create news items (or content to be highlighted) on ACCLAiM. Newscan be automatically displayed in a special portlet, which is automatically updated as updated news is created.News items can have a special leading image associated with them, which is automatically displayed in Summarylistings and when viewing the news item itself.

In order to add a news item:

1. Browse to the location in the site you wish to add this. Typically, there will be a dedicated News folder thatalready exists. If not, consider creating one as a way of grouping your content items.

2. Create the new event via Add new → News Item

3. Complete the information as required to construct your content item. The following is a guide on whatmetadata corresponds to what aspect:

Metadataitem

Description

Title A short descriptive title of the news contentDescription A short introduction to the news itemBody text Rich text with full details of the content. Can include images, formatted text, links

and more.Image An image to appear as part of the news itemImage Caption The text that will appear under the image as a caption

4. Click Save to create your content item.

5. If the resulting content needs to be published, then follow the instructions for Creating public content(page 25).

6.3 Adding links as content

Link content items can be created within ACCLAiM and essentially act as bookmarks or pointers to other webpages and sites. They are useful as they appear in navigation listings, as top-level tabs, and elsewhere, and whena user clicks on them, they will be automatically taken to the target page.

Note: If the user has access to edit a given Link, then they’ll be taken to a view explaining the link. This helpscontent editors and managers if they need to change the target URL.

1. Browse to the location in the site you wish to add this.

2. Create the new event via Add new → Link

6.2. Adding and editing news items 30

Page 34: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

3. Complete the information as required to construct your content item. The following is a guide on whatmetadata corresponds to what aspect:

Meta-data

Description

Title A short descriptive title for the linkDe-scrip-tion

A longer outline of the link. Whilst this is not shown directly to the user, it will be shown as atooltip if users hold their mouse over the link in navigation.

URL The absolute URL for the link

4. Click Save to create your content item.

6.4 Adding a Collection

Note: Collections can only be created by site administrators. If you require a Collection to be configured, pleasecontact your site administration accordingly.

Collections are effectively a saved search, allowing a set of pre-configured criteria to be applied to site content inorder to display a list of items. Some examples of Collection applications are:

• New content - all content created on the site in the last 7 days

• Content nearing expiry - all content with an expiration date with the next 7 days

• Your content - all content created on the site by the current user

Essentially, any aspect of content metadata can be used to configure a Collection. To add a Collection:

1. Browse to the location in the site you wish to add this.

2. Create the new event via Add new → Collection

3. Enter a title for the collection, other metadata as required, and configure search terms to control the resultlisting.

6.4. Adding a Collection 31

Page 35: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

In the example above, the Collection displays all content created in the last 7 days. Use the selection boxesto add different search criteria. A preview of the results will be displayed and updated as your configurationchanges.

4. Once you are satisfied with the results, click Save to finish creating the Collection.

6.4.1 Search criteria

The search criteria for the collection can be based on any of the metadata associated with content. Some of themost common are listed below:

Title The standard title of a content item

Description The description associated with a content item

Tag The keywords used to describe an item

Creation Date The time and date an item was created

Creator The user ID of the person who created the content

Review State The content item’s workflow state, such as private, pending or published

Effective Date The publishing time and date for a content item

Expiration Date The time and date the content will no longer be available

Location The path to where in the site the content resides on the site

6.5 Creating online forms

You can easily create web-based forms to capture information from users. Forms can be created such that theresults are either emailed to a user or group of users on submission, or else saved in a local file on the site,available for download at any time. Forms on ACCLAiM have a large number of field types available, and onenotable benefit is that your forms can be used within your site’s existing security, rather than relying on a third-party provider.

6.5.1 Basic concepts

A web form has this general workflow:

6.5. Creating online forms 32

Page 36: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

• Display the front-facing form to a user. This form typically consists of a number of fields, which mightinclude input boxes, drop-down or radio button lists, file uploads, and more.

• The user visits the form and fills out the details.

• The user clicks the submit button to send form information to the server.

• The server processes the form submission, validating it (if configured) and returns any errors to the user.This might happen if a field is configured as Required but the user did not enter a value.

• This continues until the form submission is correctly submitted.

• The server then processes the form submission according to the actions on the form. For a typical form, thisis either emailing the results to someone or storing in an online CSV file.

• The server displays a thank-you page or similar to the user.

There can be variations on the above, given a specific form, but typically, this is the general process.

6.5.2 Creating a new form

To add a new form:

1. Browse to the location in the site you wish to add the form.

2. Use Add new → Form Folder to begin creating your form.

3. Configure the form accordingly.

The only option you’re required to specify is the Title field, which will dictate the heading and name ofthe form being displayed to users, exactly the same way as other Title fields on other content do.

For other options, see Form options (page 34)

4. Click Save to create the form.

Once your form is created, you’ll see a default form that looks a little like this:

6.5. Creating online forms 33

Page 37: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

6.5.3 Form options

Here’s a description of the options available for forms, which can be configured by editing the given form via theEdit link.

6.5. Creating online forms 34

Page 38: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Option DescriptionTitle Short, descriptive title of the formDescription A medium-length description of the form’s purpose or action.SubmitButtonLabel

The text to display on the form’s submit button

Show ResetButton

Select to show a reset button on the form, allowing the user to clear their entry and start overReset Button Label

ResetButtonLabel

The text to display on the form’s reset button, if enabled.

ActionAdapter

Select which of the actions the form should take after submit. If first creating a form, you’lljust see ‘Mailer’ for emailing results. Others can be added later.

ThanksPage

Configure which page to show after the form has been submitted. Typically, this will thank theuser, or give them further instructions.

Force SSLconnection

Force the form to be shown over a secure (SSL) connection. Your site must be configuredspecifically for this functionality. Consult your site administrator if in doubt.

FormPrologue

Rich text to display above the form. You may want to introduce your form, explain what itdoes, add friendly images, and more.

FormEpilogue

Rich text to display below the form. You may want to sign off and say thanks here.

6.5.4 Using the Quick Editor

Your form also comes with a simple Quick Editor, which allows you to drag and drop fields onto your page, aswell as easily edit and update your other form features. You should familiarise yourself with Form fields (page 35)and Form features (page 38) so you know what functionality is available.

6.5.5 Form fields

Once your form is created, you can add any number of fields to the form. Each of the fields has a different purpose.To add any of these to the form, either use the Quick Editor (see Using the Quick Editor (page 35)), or otherwise

6.5. Creating online forms 35

Page 39: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

click Add new → [field type], selecting the type of field you wish to add. You can hover your mouse over a fieldto see its description rather than needing to rely on this list.

6.5. Creating online forms 36

Page 40: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

6.5. Creating online forms 37

Page 41: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Field DescriptionCaptcha Field Verification field the user must complete. This prevents misuse and spam.CheckboxField

True or false field where the user can choose to select or deselct the box.

Date/TimeField

Field that captures either a date, or date and time.

DecimalNumber Field

Text field that validates input to ensure decimal numbers are entered.

FieldsetBegin

Marker indicating the start of a fieldset (group of fields)

Fieldset End Marker indicating the end of fieldset (group of fields)FieldsetFolder

Folder-like entity that can contain fields.

File Field Upload field for files from the user. Use with caution as users may upload undesirable files.Files uploaded are attached to mail sent on form submission.

Label Field Basic label-only text field. Useful for displaying some short text.Lines Field Input field for multiple lines of text (such as a list of text values)Multi-SelectField

Selection list or checkbox list for multiple values.

PasswordField

Input field for passwords (protects visible input with stars or dots).

Rating-ScaleField

Multi-question field for rating a number of questions

Rich LabelField

Basic rich-text content to display on the form (no input).

RichTextField

Rich-text content editor for capturing formatted content from the user.

SelectionField

Single-selection field using either a drop-down list or radio buttons.

String Field Basic single-line text input field.Text Field Multi-line text input field.WholeNumber Field

Text field that validates input to ensure integers are entered.

For each field, you will be presented with a number of different options for customising that field. Have a read ofeach different option to get an idea as to what they do. The most common options across fields are:

Option DescriptionFieldlabel

Short, descriptive title of the field for display on the form.

Fieldhelp

A medium-length description of the field’s purpose or similar help text.

Re-quired

Whether the field is required or not. If this is enabled for a field and the user does not enter a value,the form will error during user submission.

De-fault

The default value to display on the form. This can be used to help guide the user.

Other fields will have options like maximum length (for text fields), available options (for selection or multi-selection fields), and so forth. You can add new fields and change options with the knowledge you can easilychange things as you need at any time.

Once you’ve added your form field, you can see the result of the rendered field by clicking back to your form.

6.5.6 Form features

In addition to fields, there are also a number of form helpers that you can use. These are added into your form inthe same way as fields, by using the Add new drop-down menu, and locating the relevant entry.

6.5. Creating online forms 38

Page 42: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

SpecialfeaturesImage Standard image for inclusion in pages or thank you pages.Page Standard page content. May be useful for extra help pages for forms.Thanks Page A thank-you page that can be displayed after a form submission is successful. One is added

automatically to new forms. Configure which Thanks page to use via the Edit tab on yourmain form.

MailerAdapter

Enables a form to email submission results to recipients. Enabled by default for forms, butyou will need to configure your email address for sending.

Save DataAdapter

Enables a form to save its data in a online-stored file. Users’ submissions are added into thisCSV or TSV file and it can be downloaded at any time by a suitable user.

CustomScriptAdapter

Run custom script upon a form submission. Requires Manager rights to create and use.

6.5.7 Common tasks

Form submissions should be emailed

Your form can be configured such that data being entered gets emailed to you, or a number of specific emailaddresses (or email aliases or lists). To do this:

1. Browse to the form on your site.

2. Your form may already have a Mailer Adapter configured. Click the Contents tab and look for anitem called Mailer in the listing.

(a) If this exists, you should click its link, and click Edit to edit this instead.

(b) If not, use Add new → Mailer Adapter to add this feature to your form.

3. Configure the mailer adapter accordingly. Look under each of the collapsed sections to reveal options. Forexample, you can:

• Configure the Recipient and their email address

• Add CC and BCC recipients

• Configure the email’s subject

• Add extra text to display in the body of the email

• Configure which fields should be sent within the emails

4. Use the Save button to either update or create your mail configuration. Any form submissions will startsending email immediately.

It is possible to add multiple Mailer Adapters onto your form if you have specific email requirements todifferent people. For instance, you may want only a certain subset of people to be emailed with certain data orwith a specific subject line. Make sure you test your form before making it live!

Form submissions should be securely saved online

Your form can be configured such that data being entered gets saved into a secure location on your site, and is ableto be downloaded by users with appropriate permission later.

Important: Forms that capture files from users using a File Field can only be emailed as attachments. Theycannot be stored on your site or associated with a Save Data Adapter.

6.5. Creating online forms 39

Page 43: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Warning: Your saved data structure will get out of sync with existing data if you change your form’s structure,add fields or remove fields, after receiving submissions. If you plan to update your form, ensure you Clearingsaved form submissions (page 41) first.

To do this:

1. Browse to the form on your site.

2. Your form may already have a Save Data Adapter configured. Click the Contents tab and look foran item called Saved Data (or similar) in the listing.

(a) If this exists, you should click its link, and click Edit to edit this instead.

(b) If not, use Add new → Save Data Adapter to add this feature to your form.

3. Configure the save data adapter accordingly. Look under each of the collapsed sections to reveal options.For example, you can:

• Configure the fields to be saved

• Configure extra technical data to be saved. The REMOTE_ADDR and HTTP_X_FORWARDED_FORrecord the IP address of the incoming submission, and the HTTP_USER_AGENT field captures theuser’s reported browser.

• Select the download format for your file (either comma-separated or tab-separated). Don’t change thisafter receiving form submissions.

• Include column names in the output as the first line of the file.

4. Use the Save button to either update or create your configuration. Any form submissions will start captur-ing data immediately.

6.5.8 Testing your form

After adding some fields, and customising the form helpers, view your form using the standard View link toensure it appears as you’d expect.

The form is fully functional as you see it, so you can interact with the form and even submit it to check the resultsand ensure it works correctly.

Important: Remember that if you have a Save Data Adaptor within your form any testing you performwill be saved inside its local storage. Thus, you may want to clear your tests before considering the form live. SeeClearing saved form submissions (page 41) for details.

Similarly, if you have configured a Mailer Adaptor to send email responses, then these will be triggered aswell.

6.5.9 Downloading saved form submissions

Note: This is only applicable if you created a Save Data Adapter for your form.

Once visitors have been submitting your form, you will either find yourself wanting to get access to the saved data.

1. Browse to the form on your site.

2. Click Contents to locate the Save Data Adapter on the form.

3. Click the link for the Save Data Adapter in the listing.

4. Click the saved input link in the middle of the page.

The downloaded file can now be opened in any desktop program for analysis, including Microsoft Excel, Libre-Office, or anything that supports CSV or TSV file formats.

6.5. Creating online forms 40

Page 44: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

6.5.10 Clearing saved form submissions

Note: This is only applicable if you created a Save Data Adapter for your form.

Warning: Clearing data is permanent and irreversible. Always take a copy of your data before performingthis action.

1. Browse to the form on your site.

2. Click Contents to locate the Save Data Adapter on the form.

3. Click the link for the Save Data Adapter in the listing.

4. Click the Clear Saved Input button on the page.

6.5. Creating online forms 41

Page 45: ACCLAiM Documentation

CHAPTER 7

Customising layout and design

ACCLAiM provides allows for full control over how content is displayed, and where it is displayed on the site.

7.1 Folder display options

7.1.1 Display View

Within ACCLAiM, site structure is developed using folders, some of which can be nested inside of each other andmoved around as required. How each folder appears to a visitor or site user depends on what content items areinside that folder and how the folder’s display view is configured. For instance, a folder with a number of imagesinside could be displayed as a gallery; a folder with files could list those files; or a folder with a page inside canbe customised to display a home-page instead of an automated list.

ACCLAiM provides several different manners in which to display the contents within a folder. The standard viewsare listed below.

Note: Keed in mind that the top-level of any site is also a folder, and has the same configurability for display.

Folder view DescriptionSummaryview

Lists the title and description of the content

Tabular view Lists the content items in a table formatThumbnailview

Lists images in thumbnail form and other items below the thumbnail gallery.

Standardview

Lists all content items in the folder and gives title, description, creator and date details in acompact format.

All content Displays the underlying main text from all content items inside the folder. For example, if youhave a folder with several Page items, then the folder would then display the full text of eachof these pages, one after the other.

Content itemas default

Lets you set a particular item as the home page (default view) for this folder. SeeChange the home page for a folder (page 43) for more information.

7.1.2 Determining the current view

In order to determine the current view for a given folder:

1. Browse to the given folder you would like to change.

2. Click the Display drop-down menu.

3. Note the highlighted view in the menu listing. This is the current view configuration.

42

Page 46: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

7.1.3 Changing the view

In order to change the view of a given folder:

1. Browse to the given folder you would like to change.

2. Click the Display drop-down menu, and choose the different view you would like to apply.

3. The page will reload and display the new style of view. Other visitors to the content item will see thischange immediately.

Each type of folder view can easily be changed as required, especially in order to try out other appearances.

7.1.4 Deselecting a default view

If a folder has a default view configured, you can de-select this by simply selecting another Display View (page 42).If you’d like the default appearance for a folder to be restored, choose Summary view.

7.2 Change the home page for a folder

By default, ACCLAiM displays a list of the contents of all folders and a brief description. In order to change thisview, you will need to create a new page and set the folder to use this page as the default view for the folder.

Note: If you’re ever curious or unsure about how a folder is configured for display, click the Display drop-down menu and note the selection. This explains whether a folder is configured as an automated listing or with adefault view set.

1. After logging in to the portal, click into the folder you’d like to change. Make sure you’ve already createda page to set as its default view.

2. Click Display → Select a content item as default view.

7.2. Change the home page for a folder 43

Page 47: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

1. Select the item that you would like to be displayed as the default page of the folder and click the Savebutton.

2. You should now be able to see the page appear as the default view for the folder. Keep in mind that you willneed to publish this page for other users to see it.

7.3 Sorting a folder

7.3.1 Sorting manually

The contents of a given folder are displayed in numerous ways across the site, including in navigation portlets, astop-level tabs, and in folder listings displayed on pages. There will come times where the ordering is incorrect andyou’d like to change this. To manually adjust ordering:

1. Browse to the folder that contains the content to be reordered.

2. Click onto the Contents link.

3. Click and drag the handle at the far-left of any content item up and down to reorder the content. Note howyour cursor changes into an up-down arrow when hovering over the handle. The content can be ordered inany fashion you would like.

4. Once finished, click your browser’s reload button, or browse to another folder where a listing appears.Notice how the order has now adjusted to suit your changes.

5. Repeat as required if the ordering isn’t quite right

Note: If there are many content items in the folder, the Contents view may paginate the listing intogroups. If this is the case, you can view the complete listing using the Show all items link at thebottom of the page.

7.3.2 Sorting based on criteria

ACCLAiM provides a helpful view for re-ordering the contents of folders, and allows sorting on a number ofdifferent criteria, including title, modification date, and more.

Note: Remember that folder ordering is not automatically applied. You will need to follow this process wheneverthe order should be updated.

To access the sorting view:

1. Browse to the folder that you wish to re-order. Ensure you are looking at the View tab, which will be themain folder view.

7.3. Sorting a folder 44

Page 48: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

2. Click to Actions → Sort folder to access the sorting controls.

3. Choose the criteria you wish to sort on, including enabling the reverse sorting option, if so desired.

4. Click Sort to complete the process.

5. Inspect the results in the contents listing. To re-order contents, click back to the View tab and start again.

7.4 Enabling next/previous folder navigation

To make viewing the contents of a large folder more intuitive, you may wish to enable the ability for users toskip forwards and backwards through a folder’s contents. This is called the Next/Previous Navigation featureand enabling this for a folder displays controls to jump to the next or previous page when looking at a folder’scontents.

To add enable next/previous navigation:

1. Browse to the folder you wish to apply navigation to.

2. Click the Edit tab.

3. Click the Settings tab.

4. Enable the checkbox marked Enable next previous navigation.

5. Click the Save button.

7.5 Managing portlets

7.5.1 What are portlets?

Portlets are small panels of information that you can display to either help your users or improve page display. Ifyou’ve used ACCLAiM, you’ll already have used portlets - likely without even knowing. Here’s an example:

7.4. Enabling next/previous folder navigation 45

Page 49: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

The area highlighted in red contains the portlets. Portlets may exist (by default) on the right hand side of the page.On the example image, you can see a Navigation portlet on the right.

You can customise your portlets to suit by adding static information, live updated listings (such as events, news,or collections), RSS feeds from external sites, flexible navigation, search and more.

7.5.2 Behaviour and inheritance

Portlets applied to a given folder (or the top-level of the site) will, by default, be shown for all content itemsbeneath that folder. For example, if a navigation portlet is configured on a folder called News, then all newsitems inside that folder will also see the same portlet. It is possible to override this behaviour on sub-folders orindividual content items, however.

7.5. Managing portlets 46

Page 50: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

7.5.3 Permission to change portlets

By default, portlet management is only available to users that are Site administrators. However, for ACCLAiMthis restriction has been relaxed to allow content editors the ability to control their portlets.

To determine if you can add or edit portlets, look for the Manage portlets link. If you see it, then you havesufficient permission. If not, then you’ll need to contact a site administrator to have them make the changes foryou or otherwise give you access.

7.5.4 Adding new portlets

To add a new portlet:

1. Browse to the area of the site the portlet should be shown. For example, if you add a portlet at the top-levelof your site, it will appear everywhere, except when overriden.

2. Click the Manage portlets link at the bottom of the page, or at the bottom of either left or right portletcolumn.

3. On the Manage portlets page, click the Add portlet menu at the top of the column you’d like toadd a portlet to.

4. Examine the different types of available portlets. Most are simple and self-descriptive as to what that theyprovide. For example, if you want to add some static content like images or text, then choose StaticText Portlet. Feel free to experiment here. You can easily remove new portlets later.

5. Click the name of the portlet you’d like to add.

6. On the next page, configure the portlet accordingly. Each portlet is different in their options. Configurationfields will customise how the portlet and its information are displayed. You can come back at any time toadjust settings further.

7. Once you’re ready, click the Save Settings button to create the portlet.

8. Click the Return link of the Manage portlets page to go back to see your results. You may need toclear your cache (or hold the Shift key and click your browser’s Refresh button) to see the change.

7.5. Managing portlets 47

Page 51: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

7.5.5 Editing existing portlets

To edit an existing portlet:

1. Browse to the area of the site that the portlet is applied to. If you can’t find specifically where this is, don’tworry - just browse to somewhere you see the portlet as the site directs you accordingly.

2. Click the Manage portlets link at the bottom of either left or right portlet column.

3. On the Manage portlets page, click the name of portlet you’d like to modify. In the example givenhere, you could click Calendar or RSS: ABC News to modify the options.

4. Change the options you’d like to modify. Each portlet’s options are different, so we encourage you toexperiment with different configurations. You can always come back.

5. Once you’re ready, click the Save button to save modifications to the portlet.

6. Click the Return link of the Manage portlets page to go back to see your results. You may need toclear your cache (or hold the Shift key and click your browser’s Refresh button) to see the change.

7.5.6 Managing portlets

You can also re-order, hide, override and remove portlets from your site or from a specific area on the site. Tomanage your portlets:

7.5. Managing portlets 48

Page 52: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

1. Browse to the area of the site that you’d like to manage portlets for.

2. Click the Manage portlets link at the bottom of the portlet column.

3. On the Manage portlets page, you’ll see a list of existing portlets. There are several actions you cannow perform:

To re-order portlets: Use the up and down arrows in the listing. Up arrows move the given portlet up oneposition, and down arrows move the given portlet down one position.

To hide a portlet: Click the Hide link next to the portlet’s name. This is a safe alternative to removing aportlet if you think you might want to show it again at some point.

To remove a portlet: Click the ’X’ icon next to the portlet’s name. This will remove the portlet and is notreversible. If you think you might need the portlet later, we suggest you just Hide it.

To override the portlets in an area: Click the relevant drop down menu under ’Block/unblockportlets’ and choose the option you’d like. By selecting Block under Parent portletsfor instance, you will prevent parent folders’ portlets from being displayed here. Remember that bydefault, portlets from parent folders are applied to child content.

4. Once you’re done managing your portlets, click the Save settings button at the bottom of the column.

7.5. Managing portlets 49

Page 53: ACCLAiM Documentation

CHAPTER 8

Interacting with content

8.1 Commenting

Comments are an important part of collaboration and allow you to provide feedback or visibly expression opinions.

With the exception of folders, almost all types of content can be enabled to allow comments. If comments are en-abled for a particular content item you will see a comments section underneath the content, and an Add commentbutton. If this isn’t visible, see Enabling or disabling comments (page 50) for how to turn commenting on.

8.1.1 Enabling or disabling comments

Note: You requre access to edit a given content item in order to control comments.

1. Browse to the content item you wish to adjust comments for.

2. Click on the Edit tab.

3. Click onto the Settings tab on the page to reveal extra settings for this content.

4. Enable or disable the Allow comments field as required.

If you can’t find the field here, it might be under a different tab, such as Properties. Some customcontent types can adjust where options are displayed.

5. Click the Save button to make the change.

6. The page will reload and display your content with its new settings applied.

If you enabled commenting, the comments field will be displayed. Likewise, if you disabled commenting, com-ments will no longer be shown and the ability to add comments will be removed.

50

Page 54: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

8.1.2 Adding comments

Note: The content item you wish to add comments to must have commenting enabled first.

1. Browse to the content item you wish to add a comment to.

2. Locate the Comments section at the bottom of the page. Depending on how long your page content is, youmay need to scroll down the page.

3. Type your comments in to the field provided.

4. To save the comment, click the Comment button. You have the option of having ACCLAiM notify you viaemail of new comments made on the content by selecting the option provided.

5. Your comments will appear underneath the content on the page.

8.1.3 Replying to comments

Replying to existing comments follows the same process as Adding comments (page 51) above.

1. Browse to the content item you wish to add a comment to.

2. Locate the Comments section at the bottom of the page. Depending on how long your page content is, youmay need to scroll down the page.

3. Locate the comment that you wish to respond to and click the Reply button against the comment.

4. Follow the remaining steps for Adding comments (page 51).

8.1.4 Removing comments

Note: You must have access as a Reviewer (Can Review permission) in order to remove existing commentsfrom content. If you cannot see the Delete button, you need to contact your site administrator for access.

1. Browse to the content item you wish to add a comment to.

2. Locate the Comments section at the bottom of the page. Depending on how long your page content is, youmay need to scroll down the page.

3. Locate the comment that you wish to respond to and click the Delete button against the comment.

4. The page will reload and show that the given comment has been removed.

8.2 Searching for content

ACCLAiM features a full-text search engine for quickly locating documents and other content within the site.

8.2. Searching for content 51

Page 55: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

Enter text in the search box, and press the Enter or Return key on your keyboard. The site will search forall content which includes that string in either the metadata or the text of the content. This includes aspects suchas the title of documents, descriptions, tags, and even full-text inside files such as PDFs and Microsoft Officedocuments.

Important: The search results will only ever show items that you have access to. This also applies when loggedout. No private content will ever be revealed to users unless permission has been granted.

8.3 Transferring multiple files and folders

The ACCLAiM service provides a WebDAV interface for the transfer of multiple files and folders.

8.3.1 Obtaining your username and password

On ACCLAiM, authentication occurs either with existing research institution credentials using Single-Sign-On,or with local accounts that are independently managed inside ACCLAiM.

If your account has not been issued by a research institution (university, CSIRO and so forth), then you shouldalready know your username and password as you’ll be using them to log into ACCLAiM. If this applies to you,ignore the following instructions.

If your credentials are managed by your institution, you must utilise special credentials on ACCLAiM. To findthese details:

• Username:

Important: Your username is your Shared Token. This is a long alphanumeric set of characters and isnot your local institutional login.

1. On your ACCLAiM site, locate any content item and click on Sharing.

2. You will see a list of users, including your name. Your username is displayed next to your name. It isa long alphanumeric string, and excludes the brackets.

3. If your name is not displayed here, use the search box to find your own account.

8.3. Transferring multiple files and folders 52

Page 56: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

• Password:

1. On ACCLAiM, ensure that you are logged in.

2. Click onto the top-right menu showing your name.

3. Click Preferences.

4. Click on the Password tab.

5. Click the Generate new password button.

6. Take note of your generated password for use later.

8.3.2 WebDAV clients

Any standards-compliant WebDAV client should be able to connect to ACCLAiM in order to transfer files andfolders. However, whilst there are many clients that exist, including those which may be built-in to certain operat-ing systems (such as Windows and Mac), we recommend you use our suggestions for an improved experience.

8.3.3 Tips and suggestions

After uploading content, you may find that content is present within your site (such as the Contents listings),but you cannot link to it from within Page content. If you experience this, you should add a Title to the given filesand documents, following the instructions for Renaming content (page 19).

8.3.4 Transferring multiple files (Microsoft Windows and Apple Mac)

The recommended client is Cyberduck.

1. Go to http://cyberduck.io/ and download Cyberduck.

2. For Windows, open the setup file you downloaded and install Cyberduck. For Mac, open the downloadeddisk image and copy the Cyberduck application to your local computer. Typically, you should copy this intoyour Applications folder.

3. Launch Cyberduck from the desktop or start menu (Windows) or from your Applications folder (Mac).

4. Click onto the Open Connection button on the toolbar.

5. In the pop-up window, configure the connection as follows:

8.3. Transferring multiple files and folders 53

Page 57: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

(a) Select WebDAV (HTTP/SSL) from the top drop-down menu.

(b) Server: acclaim.edu.au

(c) Port: 443

(d) Uncheck Anonymous Login

(e) Username: see Obtaining your username and password (page 52).

(f) Password: see Obtaining your username and password (page 52).

(g) Path: The path entered here will be the starting folder that you connect to. For example, to connectto the top-level of the site, leave this empty; or, to connect to a specific folder or sub-site, enter/path/to/folder, adjusting this example to fit your given URL.

6. Click onto Connect and you will be connected to ACCLAiM.

Now, you can drag and drop files from your local computer both to and from your site using this connectionwindow.

To save this connection, click onto the Bookmark menu, and then New Bookmark. Confirm that the detailsentered are correct and save your bookmark. Your bookmark is ready for easy access from Cyberduck’s mainlisting.

8.3.5 Uploading Multiple Files and Folders (Linux)

Linux distributions vary widely, but on any system with access to the command line and ability to install software,you can follow these instructions.

The recommended client is a command line tool called cadaver. Distributions that operate using GNOME withNautilus as their file manager can also utilise the built-in Connect to Server functionality, should you wantto use a GUI.

1. Install cadaver. Two common installation commands are:

yum install cadaver

or:

8.3. Transferring multiple files and folders 54

Page 58: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

apt-get install cadaver

2. Launch or otherwise access a terminal on your machine.

3. Start and connect to ACCLAiM with cadaver, specifying the first argument to the command as the URLyou want to connect to. This example demonstrates connecting directly to a folder on ACCLAiM:

cadaver |project-url|/my-site/folder

4. If you are prompted to accept the certificate, enter y for yes.

5. Enter your site credentials when prompted. See Obtaining your username and password (page 52) if yourequire these credentials.

6. This tool operates in a similar fashion to the ftp or sftp commands, with get, put and ls commands.Enter help for more information.

8.3. Transferring multiple files and folders 55

Page 59: ACCLAiM Documentation

CHAPTER 9

Frequently Asked Questions - FAQ

9.1 I’ve created a page, but my custom script/embed/Flash/widgetis being stripped

By default, ACCLAiM is configured to strip out all potentially dangerous HTML from content being included.The reason for this is that untrusted input, especially from iframe and script elements can compromise sitesecurity.

Contact your site administrator for more information and details about what other options you may have forincluding your content.

9.2 The title bar covers or obscures my logo

The title bar layout applies to all areas on ACCLAiM and is designed for improve accessibilty. If your logo ishidden or obscured as shown below, we recommend reducing the number of first level items in your site andkeeping content titles short and descriptive.

The top-level navigation items also represent the menu on mobile devices. Due to limited space on these smallerscreens, keeping the length and number of top-level navigation tabs down will improve the experience for yourvisitors.

Here are some suggestions for improving your site at the same time:

1. Structure and group content into logically-separated areas, using folders at the top-level of the site.

2. Use clear, concise titles for your folders to explain what is inside.

3. Always ensure your content is placed into the correct areas within your site. This will ensure the site stayswell-structured.

The same philosophies are applicable to other web-based systems as well, not just ACCLAiM. Following thesesuggestions will aid in the usability and presentation of your site and at the same time ensure your logo is visible.

9.3 I can’t edit or modify content

Each content item on the ACCLAiM has certain, assigned access rights. Only creators, editors, and site adminis-trators are typically allowed to edit content, unless explicit permission is granted to a specific user or group.

56

Page 60: ACCLAiM Documentation

ACCLAiM Documentation, Release 1.0

If you would like edit access on a particular content item, you should contact the creator of the content and requestthat you be granted access. is listed just below the title and description of the item.

9.4 How can I grant access to my documents?

For full details on how to grant specific users access to your content, see Granting access to your content (page 22).

9.5 How can I find a page that I created?

Use the search functionality, available at the top of any (and every) page. Enter keywords into the search box andpress Enter or Return to start your search.

Otherwise, if you know where the content should be, remember to check the Contents tab against the givenfolder. You may have inadvertently enabled the Exclude from navigation option on your content, causingit to be hidden from standard listings.

9.6 How can I reorder content within a folder?

See Sorting a folder (page 44) for details on how to adjust the ordering of content within a given folder.

9.4. How can I grant access to my documents? 57

Page 61: ACCLAiM Documentation

CHAPTER 10

Glossary

Australian Access Federation (AAF) The independent organisation that provides shared authentication infras-tructure for Australian higher-education and research institutions. See http://aaf.edu.au for more informa-tion.

Content Management System (CMS) An online platform used for the management of web-based content, in-cluding web pages, images, files, and potentially other types of information. A CMS is in essence a dynamicset of web pages, typically all utilising the same structure, theme or layout. A typical CMS requires littletechnical experience writing low-level web languages and allows non-technical users the opportunity tobuild rich web portals and sites.

Single Sign On (SSO) The process of using a common authentication mechanism across multiple services. Forexample, using the same login and password once and being able to sign into several different serviceswithout entering them again.

State The workflow state of an object is the condition in which a content object is configured to be in at any givenpoint in time. The state of an object dictates which users can access the content and what level of accessthey have. For example, Public content typically accessible by all visitors and Private content is restricted.

Workflow A workflow is a generalised step-by-step process. In the context of ACCLAiM, a workflow refers tothe review steps a piece of content may be required to progress through to be approved for access by a wideraudience.

Zope Management Interface (ZMI) A set of low-level, web-based management and configuration pages usedby technical administrators of the Plone CMS. The ZMI can be used to modify the structure of pages,including underlying scripts, styles and formatting for the site.

58

Page 62: ACCLAiM Documentation

CHAPTER 11

Indices and tables

• search

59