LiveWhale Documentation
http://support.livewhale.com
LiveWhale User's Guide
LiveWhale Basics
Logging into LiveWhale
To log into LiveWhale, enter the address of the web site you want to generate content for, followed by “/livewhale”.
For example, if your site is located at www.domain.edu, you will find the LiveWhale login for at:
http://www.domain.edu/livewhale
Simply type your username and password in the fields provided and then click “Sign in”.
Once logged in, you may click “Logout” at the top righthand corner of the screen to log back out. For security purposes, remember to not leave yourself logged in at an unattended computer, and avoid logging in on public terminals.
Forgotten usernames and/or passwords
If you’ve forgotten your username or password for LiveWhale, an option is provided to help you retrieve your username and reset your password.
At the LiveWhale login screen, click “Forgot password?” at the bottom righthand corner of the form.
You will be asked for the e-mail address associated with your LiveWhale account. Enter your e-mail address and click “Send e-mail”.
Check your e-mail account containing your username and instructions for resetting your password.
To reset your password, enter your new password twice and click “Reset password”.
You may now return to the login page and proceed to log in with your username and password.
About the welcome page
The LiveWhale welcome page lists the various modules that have been assigned to you (news, events, etc.) with links to their management pages.
In addition to these links, up to three sections may appear:
- Notifications. This section is labeled “Attention, please” and is highlighted in red. Notifications sent to your group or to you personally will appear here. Once you have reviewed the notification, you may click the “Dismiss” link to clear it.
- Group activity. A summary of group activity appears labeled “In your group”. This previews recent activity that has taken place within your group. Administrators will also receive a link to the activity module, which provides many more options for viewing activity.
- Pages you’ve recently edited. If you’ve been given page editing permissions, a recent edits history will appear here.
The welcome page can also be configured to display help/support information specific to your institution. This can be configured in the master LiveWhale config file (/livewhale/core/config.php).
Changing your LiveWhale password
From the LiveWhale interface, click “Settings” at the top righthand corner of the screen.
Enter your new password in the field labeled “New Password”.
Click the “Save” button.
Changing the e-mail address tied to your LiveWhale account
From the LiveWhale interface, click “Settings” at the top righthand corner of the screen.
Enter your new e-mail address in the field labeled “E-mail”.
Click the “Save” button.
Receiving e-mail notifications
From the LiveWhale interface, click “Settings” at the top righthand corner of the screen.
Check the box labeled “Receive messages via e-mail”.
Click the “Save” button.
Switching between LiveWhale groups
Switching between groups in LiveWhale is allowed only if you are an administrator, or if an administrator has assigned permission to switch to a particular set of groups.
From the LiveWhale interface, the name of your group will appear next to your name at the top righthand corner of the screen.
Click the group title. A dropdown menu will appear in which you are able to select from any of the groups you can switch to.
Select the group you wish to switch to. You will switch into that group, retaining your same user identity. Upon switching, LiveWhale will try to take you to the same page you switched from.
Searching your group’s content
Throughout the LiveWhale interface, a search bar appears near the upper righthand corner of the screen, labeled “Search your content”.
Type your search terms in this box and click the “Go” button.
Search results will be displayed in a list, with your search terms highlighted.
You may modify your search at any time using the options on the right hand side.
To adjust which content is searched, check off the boxes for searching your own content, content shared by others, and starred content only.
When searching content shared by others, an additional option will be provided to choose between all groups or a particular group.
To restrict search results by content type, use the checkboxes under “content types”.
When you’ve found what you’re looking for, click the title of an item in your group to continue to the edit screen.
If you are searching other groups’ content, an option will also be provided to make a link to or copy of matching content.
Using balloons
Balloons appear on most manager screens and are used to rank items according to importance. Widgets on your web site will factor in the number of balloons an item has when determining the sort order of the list.
Balloons will display to the right of items in manager lists. The more balloons, the higher the item appears in widget lists on your web site. Click the gray balloon to add more, and click on the red balloons to drop them back down in the list. When an item reaches the maximum ten balloons, it will become a gold balloon.
Managing Content
Managing Web Pages
Editing a web page
To edit a page, you must first be logged into LiveWhale.
Once logged in, an editor toolbar will appear at the top of every page on your web site. If you have permissions (set by an administrator) to edit the page currently being viewed, you will see a link labeled “Edit This Page”.
Click “Edit This Page”. You will see areas of the page that have been predefined as editable regions switch into an editable mode. These areas will become surrounded by a box. Click inside any one of these regions and make the desired edits.
When clicking inside an editable region a WYSIWYG toolbar will appear at the top of the page, allowing you to set text styles, alignments, create hyperlinks, add images, and more. (See “Using the page editor WYSIWYG toolbar”)
If you wish to revert to a previous version of your content, see “Reverting to an earlier version of a web page”.
If you wish to change the title of your web page, see “Editing a web page title”.
When you’ve finished making your page edits, click the “Save and publish” button. Your changes will be saved and go live immediately. If you wish to save a draft edit, so that you can return and resume work later without bringing the changes live, click “Save draft”. Upon returning to edit, you will be prompted whether you wish to resume editing the draft or edit the live copy.
If you wish to show a preview of the drafted content to other users, whether they’re LiveWhale users or not, you can distribute the public preview url associated with any drafted revision, available on the page history screen.
Note: If the web page you are editing is a detailed view of a content type item (a news story, event, etc.) and you have access to edit that item, you will get an additional “Edit this item” link in the editor toolbar providing quick access to edit the item in the backend administration interface.
Creating a new page
To create a new page, an administrator must first assign page and directory creation permissions to you.
There are two ways to create a new page. You can create a new page while adding it to a navigation, or create a page independent of its potential inclusion in a navigation.
To create a page from the navigation interface:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click “Add a top-level page or link”. (If this link does not appear, the administrator has not assigned navigation editing permissions to you.)
Click “create a new page”.
Fill out the form to create a new page.
- Provide a page title. This is required.
- Enter the file name within the path provided.
- Creating new web pages in LiveWhale requires the existence of templates to use as the basis for new page. Under “Choose a template”, navigate to and select the template you wish to use for your new page. (If no templates are available, see “Adding a page template”)
- If you wish to clear the editable regions on your new page, check the box that says “Clear content from editable regions”. Otherwise, leave it unchecked, and you’ll be able to modify the content when editing your new page.
- Set optional description and keywords for the page. This will be added as a meta tag to the web page for improved indexing in search engines.
- Use the tags field to tag the page.
- If this page should be used as a template, check the checkbox labeled “Use this page as a template”.
Click “Create this page”. The new page will be added to your navigation automatically.
To create a page, independent of navigations:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “File Browser” submenu. You will see a file system browser allowing you to navigate to the directory in which your new page should live.
Once you’re in the directory where your new page should be, click the “Add a new page here” button. (If the button does not exist, an administrator has not assigned page creation permissions to you.)
On the “Add Page” screen, fill out the form to create a new page.
- Provide a page title. This is required.
- Enter the file name within the path provided.
- Creating new web pages in LiveWhale requires the existence of templates to use as the basis for new page. Under “Choose a template”, navigate to and select the template you wish to use for your new page. (If no templates are available, see “Adding a page template”)
- If you wish to clear the editable regions on your new page, check the box that says “Clear content from editable regions”. Otherwise, leave it unchecked, and you’ll be able to modify the content when editing your new page.
- Set optional description and keywords for the page. This will be added as a meta tag to the web page for improved indexing in search engines.
- Use the tags field to tag the page.
- If you wish to receive a notification when this page is edited, check the box labeled “Subscribe to notifications about changes to this page”.
If you want LiveWhale to periodically send editors a reminder to update this page, check the checkbox labeled “Send editors a reminder to update this page”. Choose the schedule upon which you wish to be notified to update this page’s content from the dropdown (weekly, monthly, yearly). After choosing a schedule option, also choose the date to count from (for example, monthly from this Monday), as well as the users who should be notified. You may either choose “all editors for this page” to have the notification sent to all editors with access, or choose “an e-mail address” to specify a specific e-mail address to send to.
To save the new page and return to the LiveWhale interface, click “Save these changes”. If you wish to edit your page right away, click “Save changes and view page”.
Note: When creating a new page from a template, relative urls (such as to Javascript, CSS, or images) will be translated to absolute urls in order to work from any location in the directory hierarchy.
Adding a page template
Any editable page can be turned into a template to create new pages from, simply by flagging it as such. (If a new template is being created from scratch outside of LiveWhale, it must satisfy the following criteria.)
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page. (Pages already flagged as a template will appear highlighted in the Browse page’s file listings.)
From the page details screen, check the box labeled “Use this page as a template” to flag this page as a template.
Note: If a page is not valid XHTML, it cannot be used as a template. In such cases, a warning will be displayed, preventing you from checking the template checkbox. This is designed to guard against XHTML markup errors spreading throughout the site. In most cases the errors can be easily resolved. Click the “Why?” link next to “Page is not valid XHTML” to view the errors that must be fixed before the page can be marked as a template.
Click the “Save these changes” button.
Preparing a web page for page editing
When hired for web redesigns, White Whale produces a number of flexible templates that can be used for many purposes. However, a new template will occasionally be needed. When administrators first set up templates from scratch, whether using a product such as Dreamweaver, a text editor, or any other process they are comfortable with, a couple simple steps are necessary to prepare a page for editing.
- At the very top of the file, you must include a hook to the LiveWhale application. This is done by using a standard PHP include to LiveWhale: <?php require ‘/path/to/livewhale/cache.livewhale.php’;?> (The actual path differs from server to server, but you may copy the correct path from existing templates.)
- Next, a page must have sections defined as editable. Typically certain div elements are defined this way, for example a main content area and a sidebar. To do this, the element must contain a unique id attribute and the class “editable”. For example: <div id=”maincontent” class=”editable”>.
- If the editable area should not be visible unless it contains content, you may add the “optional” class to the element. For example: <div id=”maincontent” class=”editable optional”>. This is to prevent the empty element from affecting page layout when there is no content to display. This functionality is optional.
- The document should use valid XHTML syntax. Generally LiveWhale is able to repair a new template and bring it into compliance with Tidy, but starting with a valid document leaves less room for error.
Once templates are created, these steps will no longer be necessary, as each new page created from a template will automatically satisfy this criteria.
Setting page editing permissions
To set page editing permissions, you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Page editing permissions can be set at the group level (affecting all members of that group) or on a user-by-user basis.
To edit page editing permissions for a group, click on the desired group. For user permissions, click the user. (Note that page editing permissions will not appear on a user edit screen unless that user is authorized for the Pages module.)
In either case, locate the section for page editing permissions on the group or user edit page.
Next to “Add path for site”, choose the site you wish to add an authorization for. Next, enter the path to the page or directory in the text field. For example, “/biology/about.php” or “/academics/”. If a directory path is used, page editing permissions will be recursively available for all pages beneath that directory path.
If editing a user, and they should be allowed to create new pages and directories, check the box next to “User can create new pages and directories”.
When done, click the save button.
Note: If a logged in user does not have page editing permissions at either the group or user level, but has access to the Pages tab, clicking that tab will present a notice that they have not yet been granted permissions to edit any pages.
Setting page/directory creation and deletion permissions
To set page creation and deletion permissions, you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Locate the user you wish to allow page creation for and click their name.
On the user edit screen, check the box next to “User can create and delete pages and directories”.
Click the save button.
Creating a new directory
To create a new directory, an administrator must first assign page and directory creation permissions to you.
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “File Browser” submenu. You will see a file system browser allowing you to navigate to the directory in which your new subdirectory should live.
Once you’re in the directory where your new subdirectory should be, click the “Create a new subdirectory here” button. (If the button does not exist, an administrator has not assigned page creation permissions to you.)
On the “Add Directory” screen, fill out the form to create a new directory.
- Directory name should simply be the name of the new empty subdirectory being created. For example, “departments”.
- If you wish to password protect this directory, check the box labeled “Password protect this directory” and fill out the username and password required for access.
Click “Save and Return to Pages”.
Note: Password protection requires standard .htaccess authentication on your server. If per-dir .htaccess authentication is not available on your system, the password protection options will not appear.
Adding an image to a web page
From the LiveWhale page editing interface, insert your cursor in an editable region where you wish to place the image.
Click the image icon on the page editor WYSIWYG toolbar. This will bring up a list of the images currently uploaded in your LiveWhale group.
Find the image you wish to add by searching for it in the “Find images by keyword” box.
Images shared from other groups will be labeled with a globe icon. If you want to filter out images shared from other groups, uncheck the box labeled “Include shared images”.
Select the image or images you wish to add as they appear in the left column. Doing so will add them to the right column for insertion into your web page. To undo this action, uncheck the image you have selected on the left.
Once the right column contains the image(s) you wish to insert, choose a width or height for the image, as well as an alignment. You may also provide alt text for the image.
When done, click the “Insert image” button.
The image(s) will be inserted into the editable field on your page. You may align it using the alignment buttons in the WYSIWYG toolbar.
To save the changes for the page, click the “Save Changes” button.
Adding a widget to a web page
To add a widget to a web page, first make sure you have composed a widget and saved it to your widget library. (If you wish to manually add widget syntax to your web page, rather than using a saved widget, please see “Using a LiveWhale widget inside a web page, news story, etc.”)
From the LiveWhale page editing interface, insert your cursor in an editable region where you wish to add the widget.
Click the embed widget button (a gear icon) in the page editor WYSIWYG toolbar. You may search your widget library using the search field provided, and limit results by widget type. Choose a widget by clicking on it, and then click “Insert this widget”.
You will see a blue icon indicating where the widget will display in your editable field.
To save changes for the page, click the “Save Changes” button.
Using the WYSIWYG toolbar
The WYSIWYG toolbar contains a number of useful buttons to style and lay out content. It is very similar to WYSIWYG toolbars in commonly used word processing applications.
Select the text you wish to style, or place the cursor where you wish to insert an element, and then use the WYSIWYG buttons to perform the desired action.
From left to right, these include:
- Bold text
- Italicize text
- Underline text
- Add/edit link
- Remove link
- Style dropdown menu
- Remove formatting
- Unordered list
- Ordered list
- Table
- Align left
- Align right
- Align center
- Align full
- Outdent
- Indent
- Undo
- Redo
- Edit HTML source
- Insert image
- Insert media
- Insert widget
Note that when you enter text into the editable field, all HTML formatting will be done for you. If you wish to enter raw HTML syntax, you must use the “Edit HTML source” button.
Additionally, any contact pasted from Microsoft Word will automatically be cleaned up.
Client-side spell-checking in WYSIWYG areas on both the dynamic modules and the Pages editor is enabled–users of recent versions of Firefox, Safari, or Chrome will see misspelled words underlined in red and can right-click to see suggested corrections.
Users who are working with tables in WYSIWYG regions should note that right clicking on table elements, such as a table row, will bring up a custom contextual menu containing special table editing options. To use the built-in OS contextual menu instead (such as for spell checking), simply right click on an element that is not related to tables.
For details on adding images to your editable fields, see “Adding an image to a web page”.
Reverting to an earlier version of a web page
There are two ways to revert to an earlier version of your page.
First:
From the page editing interface, click “load a previously saved version” in the page editing WYSIWYG toolbar. This will display a dropdown menu allowing you to select and preview previously entered content for the editable regions on the current page. Once you have selected the version you wish to revert to, simply click “Save Changes” and the old content will be restored.
This approach is suitable in most instances.
Second:
To completely revert the page to its state on a particular date (including any template changes outside of editable regions), return to the LiveWhale interface.
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, click the “View revision history” link.
From the page history screen, use the date dropdown to find the version you wish to restore.
Once you’ve found the version you wish to restore, you may click “preview” to preview the page as it would look once restored. On the page history screen, the changes made on that date may also be displayed in green (newly added content) and red (removed content).
Once you’re ready to restore the page, click “revert to this copy”.
Moving a page to a new location
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, the current path to the page is displayed in a text field labeled “Page URL”.
Change the old path to the desired one.
Click “Save these changes”.
Editing a web page title
On the LiveWhale page editor toolbar, click “Edit This Page”. (If you do not have an “Edit This Page” link, an administrator has not given you permission to edit the currently viewed page.)
Click “Edit page title” in the page editor WYSIWYG toolbar.
Enter your new page title and click “Use this title”.
Click “Save Changes”.
Deleting a page
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, click the link “Delete this page”. The page will be deleted.
If you wish to restore a deleted page at a later date, see “Restoring a deleted page”.
Adding/editing a navigation
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If you have not yet created a navigation for your group, you will be prompted to create one for the first time. To create a new navigation, enter a title, a web-root relative path to the home directory of the navigation (containing pages to be added to this navigation), and check the main navigation checkbox. Marking a navigation as the main navigation will ensure that it displays by default when clicking the “Pages” tab. Click “Save these changes” to save your new navigation.
The navigation screen previews your navigation similar to how it would display on the public web site. If your user does not have permissions to edit navigations, you will not be able to perform any edits on this page. To authorize a user for navigation editing, see “Setting navigation editing permissions”.
For users authorized to edit navigations, follow these steps:
On the navigation screen, the navigation’s home directory, id, and edit details link (used to change the title or home directory) are listed along the top.
One navigation per group is common. If your group requires more than one navigation, use the “create a new navigation” link to add one. If your group already has more than one navigation, a dropdown will appear, allowing you to switch between them.
To add items to your navigation, click “Add a top-level page or link”.
Using the dropdown in the new navigation item entry, choose one of the following: link to an existing page in your navigation’s home directory, link to a different url (for example, on an external site), or add separator text (a non-linked menu divider). You may also click the link to create a new page and automatically add it to the menu (see “Creating a new page” for more information).
Once you’ve made a selection and filled out any additional fields, click the button to save your new item, and it will be added to the navigation.
If you wish to add a new navigation item as a submenu item, beneath an existing one, click “Add sub-link” instead of “Add a top-level page or link”, next to the item that should contain your new entry, and follow the same steps.
To rename a menu item, click the “Rename” link to the right of its title.
To hide a menu item, click the “Hide” link to toggle its visibility.
To remove a menu item entirely, click the “Remove” link.
The reorder menu items, use the crosshairs icon to drag the menu item to its new position.
Once your navigation contains menu items, you can use the collapse and expand all links to open and close the entire menu.
When changes have been made to your navigation, a save button will appear allowing you to save your changes.
Setting navigation editing permissions
To set navigation editing permissions, you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Locate the user you wish to allow navigation editing for and click their name.
On the user edit screen, check the box next to “User can create, edit, and delete navigations”.
Click the save button.
Setting template access permissions
To set template access permissions, you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Template access permissions can be set at the group level (affecting all members of that group) or on a user-by-user basis.
To edit template access permissions for a group, click on the desired group. For user permissions, click the user. (Note that template access permissions will not appear on a user edit screen unless that user is authorized for the Pages module.)
In either case, locate the section for template access permissions on the group or user edit page.
Next to “Add path for site”, choose the site you wish to authorize a template for. Next, enter the path to the page or directory in the text field. For example, “/biology/templates/generic.php” or “/biology/templates”. If a directory path is used, template access permissions will be recursively available for all pages beneath that directory path.
When done, click the save button.
Note: If you do not set explicit template access permissions for a user or group, those users will be automatically authorized for all templates in the system.
Finding recently edited pages
Recently edited pages are listed in two places, for quick access to content you may be working on.
On the welcome screen, recently edited pages are listed on the righthand side. Click the title of the page to jump to it. To view or edit the page details, click the details link. Or to view the history of changes made to the page, click the history link.
The same view is available from the Pages tab:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “Recently Edited” submenu.
Password protecting directories
LiveWhale allows you to password directories easily. This feature will appear if your server supports per-directory .htaccess file password protection.
If you wish to create a new directory with password protection, see “Creating a new directory”.
To password protect an existing directory, follow these steps:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “File Browser” submenu. You will see a file system browser allowing you to navigate to the directory you wish to password protect.
Once in the directory, click the “Password protect this directory” link.
On the directory password page, any existing password protection in place is listed. To add an additional user/password login, click “Add new user” and fill in the username and password.
Once all the usernames and passwords have been configured, click the save button.
Restoring a deleted web page
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “File Browser” submenu and navigate to the directory where the page lived.
A yellow message will tell you how many deleted pages were found in this directory. Click “show deleted items” to view them.
Each deleted page in this directory will be listed. You can preview what a deleted page looked like by clicking the preview link.
The following options are available for each deleted page:
- Update the file’s path: Click this if the page was externally moved (over FTP) and you simply wish to re-associate the stored revisions for a page with the newly named file.
- Restore from last revision: Click this to re-create the web page using the last stored revision of the page.
- Delete the record permanently: Click this to permanently delete all saved revisions of the deleted page. This will make it impossible to restore the deleted page in the future.
To restore the page, click the “restore from last revision” link.
Restoring a deleted directory
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “File Browser” submenu and navigate to the directory that contained the one you wish to restore.
A yellow message will tell you how many deleted items were found in this directory. Click “show deleted items” to view them.
Find the directory you wish to restore and click it.
To restore the entire directory, click the “restore this directory and its contents” button.
Note: If the directory and its pages do not need to be restored, and can safely be removed, you may click the “delete all page records” link next to the directory to permanently remove it.
Viewing statistics for a page
In order to view statistics, Google Analytics must first be configured for integration into LiveWhale.
Statistics for a web page may be viewed two ways:
First:
When logged into LiveWhale, the page editing toolbar will display a “Details” link. Clicking this will display statistics for the page, if any exist.
Second:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, statistics will appear on the righthand side, if any exist.
Viewing notes for a page
Notes on a web page may be viewed three ways:
First:
When logged into LiveWhale, the page editing toolbar will display an “Notes” link. Clicking this will display notes on the page, if any exist.
Second:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, notes will appear at the bottom of the page, if any exist.
Third:
You can also view an overview of all notes that have recently been posted to pages you are authorized for.
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “Notes” submenu.
All recent note activity will be listed here.
Note: New notes, on pages you can edit, will be e-mailed to you if you have opted to receive notifications by e-mail. (See “Receiving e-mail notifications”.)
Adding a note to a page
When logged into LiveWhale, the page editor toolbar will appear across the top of any page on the site, regardless of whether you have permissions to edit it or not.
After navigating to a page you wish to leave a note on, click “Notes” in the page editor toolbar. First select a reason for your comment. These classifications include:
- Needs attention
- Great work
- Outdated
- Problem
Next, write your note in the text field provided, and click “Add note”. You will see your note added to the list of notes for this page.
Any LiveWhale user can read notes on any page, regardless of editing permissions. However, the only users able to delete a note are system administrators and those with editing permissions for the page.
When a new note is posted, each user with permissions to edit that page will receive a notification by e-mail containing the note. Users who opt out of e-mail notifications will not receive these notifications.
Detecting errors with a web page
A number of things can be detected in your web pages so that you can be alerted to fix them. These include:
- Broken links.
- Invalid XHTML format for the page.
- Missing connection to the LiveWhale application.
- Invalid syntax for a LiveWhale widget.
- Pages not-writable by LiveWhale’s FTP user.
- Invalid PHP include() or require() paths.
Problems with your web pages can be detected a few ways.
First:
When logged into LiveWhale, the page editing toolbar will display a “Details” link. Clicking this will display errors on the page, if any exist.
Second:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, errors will appear on the righthand side, if any exist.
Third:
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
Click the “Errors” submenu to view all errors associated with pages your user has editing access for.
Note: Content inside HTML comments will be excluded from this analysis.
Notifying users when a page’s content becomes out-of-date
From the LiveWhale interface, click the “Pages” tab. (If the Pages tab does not appear, the administrator has not assigned page editing permissions to you.)
If the page you’re looking for is in a navigation, click its title to view the page details screen. Otherwise, click the “File Browser” submenu, navigate to the page’s directory, and then click the name of the page.
On the page details screen, check the checkbox labeled “Send editors a reminder to update this page”. Choose the schedule upon which you wish to be notified to update this page’s content from the dropdown (weekly, monthly, yearly). After choosing a schedule option, also choose the date to count from (for example, monthly from this Monday), as well as the users who should be notified. You may either choose “all editors for this page” to have the notification sent to all editors with access, or choose “an e-mail address” to specify a specific e-mail address to send to.
Click “Save these changes”.
Note that content notifications will be e-mailed to you if you have opted to receive notifications by e-mail. (See “Receiving e-mail notifications”.)
When browsing directories in the file browser, a flag will also appear next to any page with outdated content.
Managing News
Adding/editing a news story
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
If you are adding a news story, click “Add a New Story”, otherwise find the news story you wish to edit and click it.
Whether adding or editing a news story:
Fill out the form with the relevant information for your story.
- Enter a headline for the story.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Enter a brief summary describing the story. This will also appear in the meta description tag when viewing a news story’s details.
- If the story should contain a full article body, enter it in the text field labeled “Story body”. If your story should link to an external article, click “link to another page” and then enter the story url and source (for example: New York Times). External urls will be validated upon save.
- If you wish to suggest this content to other groups, select those groups under the section called “Suggest this item to the following groups”. For more information about sharing, see “Sharing your content with other groups”.
- Tag the story with any relevant tags. Tags help sort and classify news so that it can be directed to the proper location on your web site. You can click in the field labeled “Tag this story” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- If you wish to allow public comments on this story, click the checkbox labeled “Allow users to post comments”. When comments are posted, users are asked to identify themselves. Only logged-in LiveWhale users can see this identification, and can hide comments containing questionable content. Once comments are posted, you can manage them from the news editor for this story.
- Scroll back up and find the status menu at the top righthand corner of the screen. Choose the status for this story. “Live” will publish the story immediately. “Hidden” will hide it from the web site until you are ready to publish it. “Scheduled for…” will allow you to select a “go-live” date and time when the story should go live and publish itself. If your group contains news reporters, the “To Reporters” and “From Reporters” will allow you to send and receive news stories to these users.
- Beneath the status menu is a second dropdown menu allowing you to flag the story as archived or give it an expiration date. If the story is not archived, select “not archived”. If it should be placed in the archive, select “archived”. If you wish to specify an expiration date after which the story will be archived automatically, select “set to expire on…” and choose an expiration date and time.
- If you are editing an existing story, you will also see a “Delete” link next to the status, allowing you to delete this story. (See “Deleting a news story” for more information.)
- If you are editing an existing story, you will also see a “Restore from earlier version” link above the status menu. Clicking this will allow you to select an earlier revision of the news story, by date, and restore the content from that revision. (See “Restoring an earlier revision of a news story”) for more information.
- Under the section labeled “Story date”, enter the date of this news story.
- Under the section labeled “Images” you may attach images to this news story. Images are taken from your group’s image library. To choose an existing image from your image library, click “Select from your image library”. If you want to upload a new image to attach to this news story, click “Add images from your computer”. Newly uploaded images will be added to the image library and attached to this news story. Alternatively, you may attach an existing gallery to this story by clicking “Use an existing gallery”. (See “Attaching an image to a news story” for more information.)
- Under the section labeled “Related content”, use the search box provided to attach any relevant related content to this news story. What kinds of content can be added depends on what modules are installed on your system and what kinds of content are available.
- Specify any relevant contact info for this news story. If default contact info is specified for your group, this info will be suggested by default. If you enter an e-mail address but do not make it a “mailto” link, this will be done automatically for you.
When done, click the “Save this story” button.
Managing news
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
The manage news screen will list all news in your group.
From left to right, each news story displays:
- A checkbox allowing you to select multiple news stories and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, remove balloons, move to archive, add star, remove star, share, unshare, set status, and add tag. Check the checkbox next to the news stories you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- A star. Click on the star to flag the news item as “big news”. These items can optionally be highlighted on your web page, or you may choose to only display starred news with your widget. Starred news will also appear as important to other groups on the news sharing page.
- The status menu. If you wish to change the status of news stories, select the appropriate status here. “Live” will publish the item immediately, “Hidden” will hide the item from your web site until you are ready to publish it. If your group contains news reporters, selecting “To Reporters” and “From Reporters” will allow you to send and receive news stories with these users.
- The news headline. Click the headline to edit the news story.
- If the news story is tagged, a list of these tags will appear beside the headline. Clicking a tag will tell the news manager to only show news with that tag.
- Beneath the headline is the date of the news story.
- Use the preview link to preview this item as it will appear on the public web site.
- To move this news item to the archive, where it will not be shown on the public web site by default, click “Archive now”.
- To the right of the news story is the balloons feature, which will allow you to rank your news items according to their importance. The more balloons, the higher the news item appears in news lists on your web site. Click the gray balloon to add more, and click on the red balloons to drop them back down in the list. When an item reaches the maximum ten balloons, it will become a gold balloon.
When certain elements are modified (such as news status), a message saying “Your changes to this page have not been saved” will be displayed. Click the “Save These Changes” button to save the changes you have made.
If a news story is a link to an external article, it will display a small link icon before the headline. If the link appears to be broken, the link will display broken and highlighted in red.
To add a new news story, click the “Add a New Story” link.
A “Show by tag” dropdown menu is also available to display news tagged with the selected item.
The news manager is divided into sections, accessible by the links beneath the tab bar: News, Archive, Import From Feed, and Find News.
For information on managing news, please see “Managing news”.
For information on the news archive, please see “Managing archived news”.
For information on importing news from a feed, please see “Importing news from a feed”.
For information on the Find News feature, please see “Finding shared news”.
Managing archived news
Archived news is news that is no longer current and should only be accessible through a past news archive on your web site.
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
Click the “Archive” link beneath the tab bar.
The manage archived news screen will list all archived news in your group. It contains many of the same management features as the manage news page. Please see “Managing news” for reference to these features.
The news manager is divided into sections, accessible by the links beneath the tab bar: News, Archive, Import From Feed, and Find News.
For information on managing news, please see “Managing news”.
For information on the news archive, please see “Managing archived news”.
For information on importing news from a feed, please see “Importing news from a feed”.
For information on the Find News feature, please see “Finding shared news”.
Deleting a news story
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
Find the story (or stories) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the news edit screen:
From the news manager, find the story you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Importing news from a feed
News imported from a feed is copied into your group and behaves like any other news story in the system.
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
Click the “Import From Feed” link beneath the tab bar.
To list news in a feed, enter the feed url in the text field labeled “Enter a feed url” and click the “Go” button.
If feeds have been recently entered, they will appear in a box labeled “Recent Feeds” which can be clicked on for a shortcut to list news from that feed.
If a valid feed is entered, the feed’s contents will be listed with their linked headline, date, and summary.
Check off the news items you wish to import. Select “Link to stories” from the “With checked items…” dropdown menu and then click the “Go” button. The stories you selected will be imported. Use the “select all” link to select all items in the list.
The news manager is divided into sections, accessible by the links beneath the tab bar: News, Archive, Import From Feed, and Find News.
For information on managing news, please see “Managing news”.
For information on the news archive, please see “Managing archived news”.
For information on importing news from a feed, please see “Importing news from a feed”.
For information on the Find News feature, please see “Finding shared news”.
Attaching an image to a news story
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
Find the news story you wish to edit and click it.
Under the section labeled “Images” you may attach images to this news story. Images are taken from your group’s image library.
To choose an existing image from your image library, click “Select from your image library”. This will open an interface allowing you to search for and select images to attach to this news story. Enter your search terms in the text field labeled “Find images by keyword” and the resulting images will display. You may restrict results by date using the dropdown menu.
Images shared from other groups will be labeled with a globe icon. If you want to filter out images shared from other groups, uncheck the box labeled “Include shared images”.
Select or deselect images by clicking on them in this list. Selected images will appear in the box on the right side where you may enter an optional caption. When done, click “Done making changes”.
If you want to upload a new image to attach to this news story, click “Add images from your computer”. Select the images you wish to upload. When they have finished uploading, you will have the opportunity to enter a title and keywords for each image. When done, click “Add images to library”. Newly uploaded images will be added to the image library and attached to this news story.
If you want to attach an existing gallery to this story, click “Use an existing gallery”. Enter your search terms in the text field labeled “Find galleries by keyword” and the resulting galleries will display. Click on the gallery you wish to use and select “Select this gallery”.
Note: Once an image has been attached, you can customize the thumbnail that will be used by this story. To do so, navigate to the image that you wish to create the thumbnail from, then click the “Use this image for this story’s thumbnail” button. Select the portion of the image you want to generate the thumbnail from and click “Use This Thumbnail”.
Restoring an earlier revision of a news story
From the LiveWhale interface, click the “News” tab. (If the News tab does not appear, the administrator has not assigned the news module to you.)
Find the news story you wish to edit and click it.
Find and click the link labeled “Restore from earlier version” above the status menu near the upper righthand corner of your screen.
Choose the revision you wish to restore by selecting its date and time from the dropdown menu labeled “Choose a revision…” then click the “Load revision” button.
The content from the chosen revision will be loaded into the fields on this page.
You now have a chance to make any modifications necessary.
When done, click the “Save this story” button to save your changes.
Designating a user as a news reporter
To manage users and groups you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Find the user you wish to designate as a news reporter.
Check the checkbox next to the user’s name.
At the top of the page, select “Make user a reporter” from the dropdown menu.
Click the “Go” button.
You may also make a user a reporter from the user edit page:
From the groups manager, click the name of the user you wish to edit.
Check the checkbox labeled “This user is a news reporter”.
Click “Save this user”.
About news reporters
Flagging a user as a news reporter affects the functionality of the news module when assigned to them. It is designed to give an institution the ability to assign a certain pool of users the ability to generate content while leaving the publishing process to a different set of unrestricted users.
Groups with news reporter users will gain two additional news statuses: “To Reporters” and “From Reporters”.
News reporters can only add/edit/delete stories with these statuses, thereby restricting them from publishing control.
News reporters may assign an item “From Reporters” to flag it for review by other members of the group, who may wish to bring it live.
Non-news reporters who wish to assign a story to news reporters can likewise assign it the “To Reporters” status.
Setting the default news contact information for a group
If a particular news item sets its own contact info, that will be displayed to users browsing the story on your site. If no contact info is set on the news edit screen, the default news contact info will be obtained from the group settings, if any.
To manage users and groups you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Click the name of the group you wish to change the default news contact information for.
On the group edit page, enter your news contact information in the box labeled “News Contact Information”.
Click the “Save Group” button.
Managing Events
Adding/editing an event
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
If you are adding an event, click “Add a New Event”, otherwise find the event you wish to edit (from either month or list view) and click it.
Whether adding or editing a event:
Fill out the form with the relevant information for your event.
- Enter the event title.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Select the start and end times, where applicable. If this is an all-day event, check the box labeled “All Day”. If this event should repeat on a schedule, select the schedule from the dropdown labeled “Repeat this event”.
- Enter the event location.
- Enter a brief summary describing the event. This will also appear in the meta description tag when viewing an event’s details.
- If the event should contain a full description text, enter it in the text field labeled “Full description”. If your event should link to an external event resource, click “link to another page” and then enter the event url and source (for example: Event Calendar). External urls will be validated upon save.
- If this event requires registration, check the box labeled “Allow site visitors to register for this event”. For more information on event registration, please see “Registering for an event”.
- If you wish to allow public comments on this event, click the checkbox labeled “Allow users to post comments”. When comments are posted, users are asked to identify themselves. Only logged-in LiveWhale users can see this identification, and can hide comments containing questionable content. Once comments are posted, you can manage them from the events editor for this event.
- If you wish to suggest this content to other groups, select those groups under the section called “Suggest this item to the following groups”. For more information about sharing, see “Sharing your content with other groups”.
- Tag the event with any relevant tags. Tags help sort and classify events so that they can be directed to the proper location on your web site. You can click in the field labeled “Tags” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- Scroll back up and find the status menu at the top righthand corner of the screen. Choose the status for this event. “Live” will publish the event immediately. “Hidden” will hide it from the web site until you are ready to publish it.
- If you are editing an existing event, you will also see a “Delete” link next to the status, allowing you to delete this event. (See “Deleting an event” for more information.)
- If you are editing an existing event, you will also see a “Restore from earlier version” link above the status menu. Clicking this will allow you to select an earlier revision of the event, by date, and restore the content from that revision. (See “Restoring an earlier revision of an event”) for more information.
- Under the section labeled “Images” you may attach images to this event. Images are taken from your group’s image library. To choose an existing image from your image library, click “Select from your image library”. If you want to upload a new image to attach to this event, click “Add images from your computer”. Newly uploaded images will be added to the image library and attached to this event. Alternatively, you may attach an existing gallery to this event by clicking “Use an existing gallery”. (See “Attaching an image to an event” for more information.)
- Under the section labeled “Related content”, use the search box provided to attach any relevant related content to this event. What kinds of content can be added depends on what modules are installed on your system and what kinds of content are available.
When done, click the “Save this event” button.
Note that when editing repeating events, you will have the option to save changes to the entire series of events, change this and all following events in the series, or change only this event.
Managing events
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
There are two views from which events can be managed; the month view and the list view.
Month View
The month view displays events in your group in a familiar grid display.
From this display, you can navigate month to month by clicking the previous and next month titles beside the calendar.
To view events in list view for any date, click the numeric date for the desired day.
Events can be clicked to proceed to the edit screen.
List View
From left to right, each event displays:
- A checkbox allowing you to select multiple events and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, add star, remove star, share, unshare, set status, and add tag. Check the checkbox next to the events you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- A star. Click on the star to flag the event as important. These items can optionally be highlighted on your web page, or you may choose to only display starred events with your widget.
- The status menu. If you wish to change the status of events, select the appropriate status here. “Live” will publish the event immediately, “Hidden” will hide the item from your web site until you are ready to publish it.
- The event title. Click the title to edit the event.
- If the event is tagged, a list of these tags will appear beside it. Clicking a tag will tell the events manager to only show events with that tag.
- Beneath the event is its date.
- Use the preview link to preview this item as it will appear on the public web site.
When certain elements are modified (such as event status), a message saying “Your changes to this page have not been saved” will be displayed. Click the “Save These Changes” button to save the changes you have made.
If an event is a link to an external page, it will display a small link icon before the title. If the link appears to be broken, the link will display broken and highlighted in red.
If the event repeats, it will display a small repeating event icon before the title.
To add a new event, click the “Add a New Event” link.
A “Show by date” dropdown menu is available to display events occurring at different times (next 30 days, last 30 days, etc.)
A “Show by tag” dropdown menu is also available to display events tagged with the selected item.
The events manager is divided into sections, accessible by the links beneath the tab bar: Month View, List View, Registrations, and Import From Feed.
For information on managing events, please see “Managing events”.
For information on event registrations, please see “Managing event registrations”.
For information on importing events from a feed, please see “Import events from a feed”.
Managing event registrations
When events are flagged as allowing registrations (see “Registering for events”), these registrations will be collected and become manageable in LiveWhale.
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
Click the “Registrations” link beneath the tab bar.
The manage event registrations screen has a “Show” dropdown menu that will allow you to find events occurring at specific times (next 30 days, last 30 days, etc.)
Once you find the event you are looking for, its title, date, and number of registrants will be displayed.
Click the title of the event to view the list of registrants.
The registrant list will display the total number of people expected to attend, as well as the total number of registrants marked as having attended the event.
Each registrant is listed with their name, status, e-mail, phone, and any comments they might have added when signing up.
To edit any of these attributes, click the name of the registrant, make the necessary modifications, and click the “Save this registrant” button.
Registrants’ status can be changed using the checkbox next to their name. Check the box next to the registrants you wish to perform a bulk action on. Using the “With checked items…” menu the following actions can be applied: Cancel Registration, Re-confirm Registration (if previously canceled), Delete Registration, Mark as ATTENDED, and Mark as DID NOT ATTEND.
Printable lists of registrants are available by clicking the “Printable List of Registrants” link at the bottom of the page.
The events manager is divided into sections, accessible by the links beneath the tab bar: Month View, List View, Registrations, and Import From Feed.
For information on managing events, please see “Managing events”.
For information on event registrations, please see “Managing event registrations”.
For information on importing events from a feed, please see “Import events from a feed”.
Attaching an image to an event
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
From either the month view or list view (accessible with the links beneath the tab bar), find the event you wish to edit and click it.
Under the section labeled “Images” you may attach images to this event. Images are taken from your group’s image library.
To choose an existing image from your image library, click “Select from your image library”. This will open an interface allowing you to search for and select images to attach to this event. Enter your search terms in the text field labeled “Find images by keyword” and the resulting images will display. You may restrict results by date using the dropdown menu.
Images shared from other groups will be labeled with a globe icon. If you want to filter out images shared from other groups, uncheck the box labeled “Include shared images”.
Select or deselect images by clicking on them in this list. Selected images will appear in the box on the right side where you may enter an optional caption. When done, click “Done making changes”.
If you want to upload a new image to attach to this event, click “Add images from your computer”. Select the images you wish to upload. When they have finished uploading, you will have the opportunity to enter a title and keywords for each image. When done, click “Add images to library”. Newly uploaded images will be added to the image library and attached to this event.
If you want to attach an existing gallery to this event, click “Use an existing gallery”. Enter your search terms in the text field labeled “Find galleries by keyword” and the resulting galleries will display. Click on the gallery you wish to use and select “Select this gallery”.
Note: Once an image has been attached, you can customize the thumbnail that will be used by this event. To do so, navigate to the image that you wish to create the thumbnail from, then click the “Use this image for this event’s thumbnail” button. Select the portion of the image you want to generate the thumbnail from and click “Use This Thumbnail”.
Importing events from a feed
Events imported from an RSS or iCAL feed are copied into your group and behave like any other events in the system.
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
Click the “Import From Feed” link beneath the tab bar.
To list events in a feed, enter the feed url in the text field labeled “Enter a feed url” and click the “Go” button.
If feeds have been recently entered, they will appear in a box labeled “Recent Feeds” which can be clicked on for a shortcut to list events from that feed.
If a valid feed is entered, the feed’s contents will be listed with their linked title, date, and summary.
Check off the events you wish to import. Select “Copy as link” from the “With checked items…” dropdown menu and then click the “Go” button. The events you selected will be imported. Use the “select all” link to select all items in the list.
The events manager is divided into sections, accessible by the links beneath the tab bar: Month View, List View, Registrations, and Import From Feed.
For information on managing events, please see “Managing events”.
For information on event registrations, please see “Managing event registrations”.
For information on importing events from a feed, please see “Import events from a feed”.
Deleting an event
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
Find the event (or events) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the event edit screen:
From the events manager, find the event you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Displaying an events calendar
Your public web site may contain as many events calendars as you like. Just like templates for news, galleries, etc., the calendar can be set up once and linked to from anywhere on the site.
White Whale may already have set up some calendar pages for you. To create new ones, you may copy and modify the default calendar template at /livewhale/default/calendar.php.
The “events_calendar” widget in your calendar template controls which events are displayed.
The events calendar widget utilizes the same args as the events widget. For more information on available parameters, please see “Using the events widget”.
Registering for an event
Individual events can be flagged as allowing registration. When this is done, users viewing the event details on your web site will be presented with an event registration form. The form allows them to enter their first and last name, e-mail address, phone number, number of people attending, and any additional comments they may have.
Registrations are collected and become manageable within LiveWhale. For information on how to manage event registrations, please see “Managing event registrations”.
To flag an event as having registrations, click the “Events” tab from the LiveWhale interface. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
From either the month view or list view, click the title of the event you wish to add registrations to.
From the event edit screen, scroll to the section labeled “Registration” and check the box labeled “Allow site visitors to register for this event”.
If you wish the registration to automatically close after a specific number of attendees have registered, enter the number in the field provided.
If you wish to specify additional requests to users registering for the event, use the text field provided to do so. At the time of registration, users will be given a text field with which to respond to those requests.
Click “Save this event”.
Restoring an earlier revision of an event
From the LiveWhale interface, click the “Events” tab. (If the Events tab does not appear, the administrator has not assigned the events module to you.)
Find the event you wish to edit and click it.
Find and click the link labeled “Restore from earlier version” above the status menu near the upper righthand corner of your screen.
Choose the revision you wish to restore by selecting its date and time from the dropdown menu labeled “Choose a revision…” then click the “Load revision” button.
The content from the chosen revision will be loaded into the fields on this page.
You now have a chance to make any modifications necessary.
When done, click the “Save this event” button to save your changes.
Managing Images
Adding/editing an image
From the LiveWhale interface, click the “Images” link at the upper righthand corner of the screen.
If you are adding an image, click “Add a New Image”, otherwise find the image you wish to edit and click its title.
Whether adding or editing a image:
Fill out the form with the relevant information for your image.
- Enter the title of the image.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Choose any relevant keywords for this image, so that it can be found in searches. Keywords should be separated by either commas or spaces.
- Choose a default caption for your image if there is one.
- Enter a photo credit if applicable.
- Tag the image with any relevant tags. Tags help sort and classify images so that they can be directed to the proper location on your web site. You can click in the field labeled “Tags” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- If you are editing an existing image, you will also see a “Delete” link near the upper righthand corner of the screen, allowing you to delete this image. (See “Deleting an image” for more information.)
- If you are editing an existing image, you will also see a “View full image” link beneath the delete link, allowing you to preview the full-sized image.
- Enter a date for the image. If you enter a date in the future, the image will not appear on the public web site until the date is reached.
- If adding a new image, under the section labeled “Upload a new image”, choose a file to upload. If you are editing an existing download, this section is labeled “Replace with file”, and choosing a file here can be used to replace the existing image with a new version.
When done, click the “Save this image” button.
Note: If an image is uploaded without a title, caption, or credit and any of that information is found encoded within the image’s IPTC metadata, the metadata field values will be used automatically.
Also, if an image contains EXIF orientation metadata (such as an image taken in portrait mode), LiveWhale will automatically rotate the image to the correct orientation upon upload.
Managing images
From the LiveWhale interface, click the “Images” link in the upper righthand corner of the screen.
The manage images screen will list all images in your group.
From left to right, each image displays:
- A checkbox allowing you to select multiple images and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, share, unshare, add to existing gallery, create gallery, and add tag. When choosing “add to existing gallery”, you will first need to select a gallery if any are available. To create a new gallery from the checked images, choose “create gallery”. Check the checkbox next to the images you with to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- Title of the image. Click the title to edit the image.
- A thumbnail preview of the image. Clicking the thumbnail will display a larger preview.
- If the image possesses keywords, a list of these keywords will appear beneath it. Clicking a keyword will tell the images manager to search for images using that keyword.
If an image is shared, a small shared image icon will appear in front of its title.
To add a new image, click the “Add a New Image” link. To add multiple images at once, click “Bulk Add Images”.
If you wish to search for images by keyword, a search box is provided across from the “With checked items…” dropdown menu.
Deleting an image
From the LiveWhale interface, click the “Images” link in the upper righthand corner of the screen.
Find the image (or images) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the image edit screen:
From the images manager, find the image you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Managing Blurbs
Adding/editing a blurb
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
The manage blurbs screen will list all blurb types in your group, along with the total number of blurbs you have of that type. If you do not yet have a blurb type, you must first add one.
Click a blurb type to view a list of blurbs.
If you are adding a blurb, click “Add a new blurb”, otherwise find the blurb you wish to edit and click it.
Whether adding or editing a blurb:
Fill out the form with the relevant information for your blurb.
- Enter the title of the blurb. This is used to identify the blurb in your blurbs list.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Enter the main body text of the blurb.
- If you wish to suggest this content to other groups, select those groups under the section called “Suggest this item to the following groups”. For more information about sharing, see “Sharing your content with other groups”.
- Tag the blurb with any relevant tags. Tags help sort and classify blurbs so that they can be directed to the proper location on your web site. You can click in the field labeled “Tags” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- Scroll back up and find the status menu at the top righthand corner of the screen. Choose the status for this blurb. “Live” will publish the blurb immediately. “Hidden” will hide it from the web site until you are ready to publish it. “Scheduled for…” will allow you to select a “go-live” date and time when the blurb should go live and publish itself.
- Beneath the status menu is a second dropdown menu allowing you to flag the blurb as archived or give it an expiration date. If the blurb is not archived, select “not archived”. If it should be placed in the archive, select “archived”. If you wish to specify an expiration date after which the blurb will be archived automatically, select “set to expire on…” and choose an expiration date and time.
- If you are editing an existing blurb, you will also see a “Delete” link next to the status, allowing you to delete this blurb. (See “Deleting a blurb” for more information.)
- If you are editing an existing blurb, you will also see a “Restore from earlier version” link above the status menu. Clicking this will allow you to select an earlier revision of the blurb, by date, and restore the content from that revision. (See “Restoring an earlier revision of a blurb”) for more information.
- Under the section labeled “Blurb date”, enter the date of this blurb.
- Under the section labeled “Related content”, use the search box provided to attach any relevant related content to this blurb. What kinds of content can be added depends on what modules are installed on your system and what kinds of content are available.
When done, click the “Save this blurb” button.
Managing archived blurbs
Archived blurbs are blurbs that are no longer current and should only be accessible through a past blurbs archive on your web site.
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
The manage blurbs screen will list all blurb types in your group, along with the total number of blurbs you have of that type.
Click a blurb type to view a list of blurbs.
Click the “Archive” link beneath the tab bar.
The manage archived blurbs screen will list all archived blurbs of the current type in your group. It contains many of the same management features as the manage blurbs page. Please see “Managing blurbs” for reference to these features.
The blurbs manager is divided into three sections, accessible by the links beneath the tab bar: Blurbs, Archive, and Categories.
For information on managing blurbs, please see “Managing blurbs”.
For information on the blurbs archive, please see “Managing archived blurbs”.
For information on blurb categories, please see “Adding a blurb category”.
Managing blurbs
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
The manage blurbs screen will list all blurb types in your group, along with the total number of blurbs you have of that type.
Click a blurb type to view a list of blurbs.
From left to right, each blurb displays:
- A checkbox allowing you to select multiple blurbs and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, remove balloons, move to archive, add star, remove star, share, unshare, set status, and add tag. Check the checkbox next to the blurbs you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- A star. Click on the star to flag the blurb as important. These items can optionally be highlighted on your web page, or you may choose to only display starred blurbs with your widget.
- The status menu. If you wish to change the status of blurbs, select the appropriate status here. “Live” will publish the item immediately, “Hidden” will hide the item from your web site until you are ready to publish it.
- The blurb’s title. Click the blurb title to edit the blurb.
- If the blurb is tagged, a list of these tags will appear beside it. Clicking a tag will tell the blurbs manager to only show blurbs with that tag.
- Beneath the blurb is a summary of its contents along with its date.
- Use the preview link to preview this item as it will appear on the public web site.
- To the right of the blurb is the balloons feature, which will allow you to rank your blurbs according to their importance. The more balloons, the higher the blurb appears in blurb lists on your web site. Click the gray balloon to add more, and click on the red balloons to drop them back down in the list. When an item reaches the maximum ten balloons, it will become a gold balloon.
When certain elements are modified (such as blurb status), a message saying “Your changes to this page have not been saved” will be displayed. Click the “Save These Changes” button to save the changes you have made.
To add a new blurb, click the “Add a New Blurb” link.
Beside “Manage Blurbs” a dropdown menu is available to display blurbs in the selected type.
A “Show by tag” dropdown menu is available to display blurbs of the current type that are tagged with the selected item.
The blurbs manager is divided into three sections, accessible by the links beneath the tab bar: Blurbs, Archive, and Categories.
For information on managing blurbs, please see “Managing blurbs”.
For information on the blurbs archive, please see “Managing archived blurbs”.
For information on blurb categories, please see “Adding a blurb category”.
Adding a blurb type
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
From the manage blurb types screen, click “Add a new blurb type”. In the text field that appears, enter the name of your new type.
When done, click the “Save type” button.
For information on how to delete a blurb type, please see “Deleting a blurb type”.
Deleting a blurb type
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
From the manage blurb types screen, find the type (or types) you wish to delete in the list and check the box next to it.
Click the “Delete” button. A blurb type will only be deleted if there are no remaining blurbs of that type.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
Deleting a blurb
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
The manage blurbs screen will list all blurb types in your group, along with the total number of blurbs you have of that type.
Click a blurb type to view a list of blurbs.
Find the blurb (or blurbs) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the blurb edit screen:
From the blurbs manager, find the blurb you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Restoring an earlier revision of a blurb
From the LiveWhale interface, click the “Blurbs” tab. (If the Blurbs tab does not appear, the administrator has not assigned the blurbs module to you.)
The manage blurbs screen will list all blurb types in your group, along with the total number of blurbs you have of that type.
Click a blurb type to view a list of blurbs.
Find the blurb you wish to edit and click it.
Find and click the link labeled “Restore from earlier version” above the status menu near the upper righthand corner of your screen.
Choose the revision you wish to restore by selecting its date and time from the dropdown menu labeled “Choose a revision…” then click the “Load revision” button.
The content from the chosen revision will be loaded into the fields on this page.
You now have a chance to make any modifications necessary.
When done, click the “Save this blurb” button to save your changes.
Managing Files
Adding/editing a file
From the LiveWhale interface, click the “Files” link.
If you are adding a file, click “Add a New File”, otherwise find the file you wish to edit and click it. (If you wish to add multiple files at once, click “Bulk Add Files”, however this may require that you go back and edit the newly added files once they’ve been created.)
Whether adding or editing a file:
Fill out the form with the relevant information for your file.
- Enter the title of the file.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Enter a brief summary describing the file.
- Tag the file with any relevant tags. Tags help sort and classify files so that they can be directed to the proper location on your web site. You can click in the field labeled “Tags” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- Scroll back up and find the status menu at the top righthand corner of the screen. Choose the status for this file. “Live” will publish the file immediately. “Hidden” will hide it from the web site until you are ready to publish it.
- If you are editing an existing file, you will also see a “Delete” link next to the status, allowing you to delete this file. (See “Deleting a file” for more information.)
- If you are editing an existing file, you will also see a “Direct link to this file” link beneath the status, allowing you to link directly to this file.
- Under the section labeled “File”, choose a file to upload. If you are editing an existing file, choosing a file here can be used to replace the existing file with a new version.
When done, click the “Save this file” button.
Managing files
From the LiveWhale interface, click the “Files” link.
The manage files screen will list all files in your group.
From left to right, each file displays:
- A checkbox allowing you to select multiple files and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, add star, remove star, share, unshare, set status, and add tag. Check the checkbox next to the files you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- A star. Click on the star to flag the file as important. These items can optionally be highlighted on your web page, or you may choose to only display starred files with your widget.
- The status menu. If you wish to change the status of files, select the appropriate status here. “Live” will publish the item immediately, “Hidden” will hide the item from your web site until you are ready to publish it.
- Title of the file. Click the title to edit the file.
- If the file is tagged, a list of these tags will appear beside it. Clicking a tag will tell the files manager to only show files with that tag.
- Beneath the file is its type. Clicking a file type will tell the files manager to only show files with that type.
- Beneath the file type is the permalink url (direct link) to the file.
To add a new file, click the “Add a New File” link. To add multiple files at once, click “Bulk Add Files”.
A “Show by tag” dropdown menu is also available to display files tagged with the selected item.
A “Show by type” dropdown menu is also available to display files of the selected type.
Deleting a file
From the LiveWhale interface, click the “Files” link.
Find the file (or files) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the file edit screen:
From the files manager, find the file you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Managing Galleries
Adding/editing a gallery
From the LiveWhale interface, click the “Galleries” tab. (If the Galleries tab does not appear, the administrator has not assigned the galleries module to you.)
If you are adding a gallery, click “Add a New Gallery”, otherwise find the gallery you wish to edit and click it.
Whether adding or editing a gallery:
Fill out the form with the relevant information for your gallery.
- Enter a title for the gallery.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Enter a description of the gallery. This will also appear in the meta description tag when viewing a gallery’s details.
- If you are editing a gallery, any existing images will be listed in the section labeled “Edit Images”. Here you can change image captions, remove images, or reorder them by dragging an image by the crosshairs icon.
- If you wish to suggest this gallery to other groups, select those groups under the section called “Suggest this item to the following groups”. For more information about sharing, see “Sharing your content with other groups”.
- Tag the gallery with any relevant tags. Tags help sort and classify galleries so that they can be directed to the proper location on your web site. You can click in the field labeled “Tags” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- If you wish to allow public comments on this gallery, click the checkbox labeled “Allow users to post comments”. When comments are posted, users are asked to identify themselves. Only logged-in LiveWhale users can see this identification, and can hide comments containing questionable content. Once comments are posted, you can manage them from the gallery editor for this gallery.
- Scroll back up and find the status menu at the top righthand corner of the screen. Choose the status for this gallery. “Live” will publish the gallery immediately. “Hidden” will hide it from the web site until you are ready to publish it.
- If you are editing an existing gallery, you will also see a “Delete” link next to the status, allowing you to delete this gallery. (See “Deleting a gallery” for more information.)
- You may attach images to this gallery. Images are taken from your group’s image library. To choose an existing image from your image library, click on each of the images you wish to add. If you want to upload a new image to attach to this gallery, click “Add images from your computer”. Newly uploaded images will be added to the image library and attached to this gallery. (See “Attaching an image to a gallery” for more information.)
When done, click the “Save this gallery” button.
Managing galleries
From the LiveWhale interface, click the “Galleries” tab. (If the Galleries tab does not appear, the administrator has not assigned the galleries module to you.)
The manage galleries screen will list all galleries in your group.
From left to right, each gallery displays:
- A checkbox allowing you to select multiple galleries and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, remove balloons, add star, remove star, share, unshare, set status, and add tag. Check the checkbox next to the galleries you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- A star. Click on the star to flag the gallery as important. These items can optionally be highlighted on your web page, or you may choose to only display starred galleries with your widget.
- The status menu. If you wish to change the status of galleries, select the appropriate status here. “Live” will publish the item immediately, “Hidden” will hide the item from your web site until you are ready to publish it.
- The gallery title and id. Click the title to edit the gallery.
- If the gallery is tagged, a list of these tags will appear beside the title. Clicking a tag will tell the galleries manager to only show galleries with that tag.
- Beneath the title is the number of images included in the gallery.
- Use the preview link to preview this item as it will appear on the public web site.
- To the right of the gallery is the balloons feature, which will allow you to rank your galleries according to their importance. The more balloons, the higher the gallery appears in gallery lists on your web site. Click the gray balloon to add more, and click on the red balloons to drop them back down in the list. When an item reaches the maximum ten balloons, it will become a gold balloon.
When certain elements are modified (such as a gallery status), a message saying “Your changes to this page have not been saved” will be displayed. Click the “Save These Changes” button to save the changes you have made.
To add a new gallery, click the “Add a New Gallery” link.
A “Show by tag” dropdown menu is also available to display galleries tagged with the selected item.
Deleting a gallery
From the LiveWhale interface, click the “Galleries” tab. (If the Galleries tab does not appear, the administrator has not assigned the galleries module to you.)
Find the gallery (or galleries) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the gallery edit screen:
From the galleries manager, find the gallery you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Attaching an image to a gallery
From the LiveWhale interface, click the “Galleries” tab. (If the Galleries tab does not appear, the administrator has not assigned the galleries module to you.)
Find the gallery you wish to edit and click it.
Under the section labeled “Images” you may attach images to this gallery. Images are taken from your group’s image library.
To choose an existing image from your image library, click “Select from your image library”. This will open an interface allowing you to search for and select images to attach to this gallery. Enter your search terms in the text field labeled “Find images by keyword” and the resulting images will display. You may restrict results by date using the dropdown menu.
Images shared from other groups will be labeled with a globe icon. If you want to filter out images shared from other groups, uncheck the box labeled “Include shared images”.
Select or deselect images by clicking on them in this list. Selected images will appear in the box on the left side where you may enter an optional caption or reorder the images in the gallery.
If you want to upload a new image to attach to this gallery, click “Add new images from your computer”. Select the images you wish to upload. When they have finished uploading, you will have the opportunity to enter a title and keywords for each image. When done, click “Add images to library”. Newly uploaded images will be added to the image library and attached to this gallery.
Managing Tags
Adding/editing a tag
From the LiveWhale interface, click the “Tags” link at the top righthand corner of the screen.
Click “Add a New Tag”. In the text field that appears, enter the name of your new tag. Tags may contain alphanumeric characters, and a handful of punctuation, including smart quotes.
When done, click the “Save tag” button.
Managing tags
From the LiveWhale interface, click the “Tags” link at the upper right hand corner of the screen.
The manage tags screen will list all tags in your group.
From left to right, each tag displays:
- A checkbox allowing you to select multiple tags and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, add star, remove star, and merge tags. Check the checkbox next to the tags you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- A star. Click on the star to flag the tag as important. These tags can optionally be highlighted on your web page, or you may choose to only display starred tags when using your tags widget.
- The tag title. Click the title to edit it.
- If any data in your group has this tag, a summary of these items will appear beside the title. Clicking a data type will jump you to the appropriate manager to view those items.
When certain elements are modified (such as stars), a message saying “Your changes to this page have not been saved” will be displayed. Click the “Save These Changes” button to save the changes you have made.
To add a new tag, click the “Add a New Tag” link.
Deleting a tag
From the LiveWhale interface, click the “Tags” link at the top righthand corner of the screen.
Find the tag (or tags) you wish to delete in the list and check the box next to it.
Click the “Delete” button.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
Managing Forms
Adding/editing a form
From the LiveWhale interface, click the “Forms” tab. (If the Forms tab does not appear, the administrator has not assigned the forms module to you.)
If you are adding a form, click “Add a New Form”, otherwise find the form you wish to edit and click it.
Whether adding or editing a form:
Fill out the form with the relevant information for your form.
- Enter the title of the form.
- If this content is especially important and you wish to flag it as such on your web site, click the star in the section labeled “Star content” in order to highlight it. By default this content will be shareable. If you wish to make it non-shareable, click the globe labeled “Share content” to un-highlight it.
- Enter a brief introductory text, perhaps containing instructions to the user about what the form is and how to fill it out.
- Enter a thank you text, visible to the user upon submitting the form.
- Under the section labeled “Form action”, choose a destination for the data submitted by users. You have the option of storing it in the database, e-mailing it, or both. If you choose to have it e-mailed, you will be presented with an additional field for e-mail address(es), which can be comma-separated.
- Under the section labeled “Form elements”, you may construct the form by adding as many form elements as you like. To add a new element, click “Add another element”. To reorder elements, drag an element by the crosshairs icon to a new position in the list. For each element, you will be able to set the element’s label, type, whether or not it is required, instructional/help text, and a list of possible options if appropriate for the element type.
- If you wish to restrict submissions to a particular range of dates, enter those dates in the section labeled “Only accept submissions on dates”.
- If this form should be secured using SSL (HTTPS), check the box labeled “This is a secure form”. This only needs to be used if sensitive data is being transmitted to the server by visitors to the site. Your server must have a valid site certificate in order to use this feature.
- Tag the form with any relevant tags. Tags help sort and classify forms so that they can be directed to the proper location on your web site. You can click in the field labeled “Tags” and type a keyword; tags will be suggested to you. If you are unsure what tags are available in your group, click “Show all tags” to display them all and select the relevant ones.
- Scroll back up and find the status menu at the top righthand corner of the screen. Choose the status for this form. “Live” will publish the form immediately. “Hidden” will hide it from the web site until you are ready to publish it.
- If you are editing an existing form, you will also see a “Delete” link next to the status, allowing you to delete this form. (See “Deleting a form” for more information.)
When done, click the “Save this form” button.
Managing forms
From the LiveWhale interface, click the “Forms” tab. (If the Forms tab does not appear, the administrator has not assigned the forms module to you.)
The manage forms screen will list all forms in your group.
From left to right, each form displays:
- A checkbox allowing you to select multiple forms and perform bulk actions from the “With checked items…” dropdown menu. Available actions include: delete, remove tags, share, unshare, set status, duplicate, and add tag. The “duplicate” option is unique to forms, and allows you to make a copy of a form within your group, if you need to create a new form using an existing one as a starting point. Check the checkbox next to the forms you wish to apply an action to, then select the desired action from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- The status menu. If you wish to change the status of forms, select the appropriate status here. “Live” will publish the item immediately, “Hidden” will hide the item from your web site until you are ready to publish it.
- Title of the form. Click the title to edit the form.
- If the form is tagged, a list of these tags will appear beside it. Clicking a tag will tell the forms manager to only show forms with that tag.
- Beneath the form title, a link to view submissions may appear along with the number of submissions received. Please see “Viewing and exporting form submissions” for more information.
- Beneath the form and submissions link is a link called “Get Widget Code” which will reveal the code required to embed this form in a web page.
To add a new form, click the “Add a New Form” link.
A “Show by tag” dropdown menu is also available to display forms tagged with the selected item.
Deleting a form
From the LiveWhale interface, click the “Forms” tab. (If the Forms tab does not appear, the administrator has not assigned the forms module to you.)
Find the form (or forms) you wish to delete in the list and check the box next to it.
Choose “Delete” from the dropdown menu, and click “Go”.
Note: The selected item(s) will be removed from the system. This action cannot be undone!
You may also delete the item from the form edit screen:
From the forms manager, find the form you wish to delete and click it.
Click the “Delete” link on the right side of the screen. You will be prompted to confirm this action.
Viewing and exporting form submissions
From the LiveWhale interface, click the “Forms” tab. (If the Forms tab does not appear, the administrator has not assigned the forms module to you.)
The manage forms screen will list all forms in your group.
Find the form you wish to view submissions for. If submissions have been made, a link to view submissions will appear beneath the form title. Click the link to view form submissions.
Submissions for the form will be listed by submission date, along with the other fields included in the form.
A checkbox is provided allowing you to select multiple form submissions and perform bulk actions from the “With checked items…” dropdown menu. To delete any submissions, check the checkbox next to the submissions you wish to delete, then select “Delete” from this menu and click the “Go” button. Use the “select all” link if you wish to select all items in the list.
To view a printable list of submissions, click “View printable”.
If you wish to export the submissions to a CSV file, click “Export CSV”. Submissions exported to CSV will automatically include the submission date as the first field in the CSV output.
Sharing Content
Finding shared content
Most content can be shared between groups. For example, if the biology group creates a news story about an award won by one of their professors, a communications group might copy the story and customize it for a press release.
Content can be suggested to you by other groups (see “Sharing content with other groups”) but you may also wish to actively seek out content that you may be interested in.
If you are looking for a specific type of content, click the tab for that content type. A “Find” link will appear as a submenu beneath the tab (for example, “Find News”).
If you are searching for any type of content matching some search terms, simply use the search box available to you at the top righthand corner of the screen. (This will search your own content initially.)
Items available for sharing will appear in the list, if any were found. You can modify the search using the search options to the right:
- Use the text field to change any search terms you may have used.
- Under the section labeled “Show”, choose whether you want to search your own content, content shared by others, and/or starred content only.
- Use the “Content types” section to select the types of content you are looking for.
When you have finished modifying your search, click “Update results”.
Once you have found content that may interest you, clicking it either takes you to the editor for that item (if you own it) or to a preview of the content if it is owned by another group.
Find the content you wish to copy and check the checkbox next to their titles.
Click “Link to checked items” if you wish to make copies of the content that link to the original (owned by another group) or click “make your own copy” if you wish to copy the content in its entirety and have full control over future revisions to it.
The items you chose will be copied to your own library, as hidden. Any related content associated with the item will still be linked to your copy, even if you do not own it.
Sharing your content with other groups
Users from other groups are able to see your current, live content in their Find interface if it is shared. From that screen they are able to search across all the content in the system and copy or link to content produced by other groups.
All content is shared by default. To toggle something between shared or not shared, edit the item and look for a link that says “Share content to allow borrowing and reuse by other content managers”. Click the globe icon to toggle the sharing state. A highlighted globe means the item will be shared, and a dimmed globe means it is not shared. Click save to save your changes.
If you have produced content you think will be of interest to another group, you may optionally suggest the content to those groups, rather than wait for them to find it themselves. This will prompt users in the other group regarding your suggestion, and give them the opportunity to accept or reject the content without having to go looking for it.
To suggest content to another group, first edit the item you wish to suggest.
On the edit screen, scroll to the bottom of the page and find the section labeled “Suggest this item to the following group(s)”. Specify the group or groups you wish to suggest the story to. (If someone in your group has already suggested the content to a particular group, that group can not be selected.)
When done, click the save button. The content will be saved and the groups you selected will receive a suggestion notice. If someone accepts or declines a suggested item, another notice will be sent to users in the same group, so that they are aware action has already been taken.
Using Widgets
About widgets
LiveWhale users can produce various kinds of dynamic content, including news, events, galleries, and other types of content. This content is typically stored in a database and shared among users in the same group, who prepare them for display on the public web site.
Widgets are the means by which these items are published on the public web site. Specifically, they are objects that can be inserted into a web page which tell the page which news stories, events, etc. to display there. (For those that are technically savvy, widgets are in fact small bits of XML.)
Each widget is composed of a simple set of rules that determine what to show. For example, “show all news items tagged with ‘Academics’”, or “show all PDF files”, or even “show recently added items to these 3 RSS feeds”.
Using a widget is as simple as placing it in a region of your page while editing it. Also, if you provide your widget with a header, visitors to your web page will automatically be able to subscribe to the widgets on your page so they can keep track of any updates via RSS.
You can easily create widgets using the widget editor. You don’t have to know how to write a widget, nor do you have to remember the different possible options each widget has. A simple to use interface will help you through the process of creating a widget, and optionally giving it a name so you can re-use it easily another time you need it.
For specific information about how to create different types of widgets, see “Managing widgets”.
Managing widgets
From the LiveWhale interface, click the “Widgets” link at the top righthand corner of the screen.
The manage widgets screen will list all widgets in your group, as well as ones globally shared with all groups.
From left to right, each widget displays:
- A checkbox allowing you to select multiple widgets and perform bulk actions from the “With checked items…” dropdown menu. Check the checkbox next to the widgets you wish to delete, then select “Delete” from this menu and click the “Go” button. Use the “select all” link to select all items in the list.
- The widget type.
- The title of the widget. Click the title to edit the widget.
- Use the preview link to preview this item as it will appear on the public web site.
- Beneath the title is a link to view get the widget code. This code can be copy and pasted into your web page, a news story, etc. via the HTML source button in the WYSIWYG toolbar.
A “Show types” dropdown menu is also available to only display widgets of a specific type.
To add a new widget, click the “Add a new widget” link.
For specific information about how to create different types of widgets, select any one of the follow articles about widget creation:
- Using the news widget
- Using the events widget
- Using the blurbs widget
- Using the galleries widget
- Using the files widget
- Using the feeds widget
- Using the Twitter widget
- Using the images widget
- Using the image widget
- Using the forms widget
- Using the file widget
- Using the tags widget
Using a LiveWhale widget inside a web page, news story, etc.
LiveWhale widgets can be embedded inside any web page or any content type field that supports HTML. You may either embed a widget that’s already saved, using a WYSIWYG button, or you may manually enter widget syntax.
Using a saved widget carries the additional benefit of being able to edit that saved widget at a future date, and having your change take effect on all instances of the widget automatically.
To embed a saved widget, click in the WYSIWYG field where you’d like the widget to display, then click the widget button in the WYSIWYG toolbar (a gear icon). You may search your widget library using the search field provided, and limit results by widget type. Choose a widget by clicking on it, and then click “Insert this widget”.
To instead enter widget syntax manually, simply use the “Edit HTML Source” button on the WYSIWYG toolbar for that field, and paste or type the widget code where desired.
Controlling which group’s data a widget displays
Many LiveWhale widgets display group-owned data (such as news items). If you wish to display items from only your group, it is done with a group argument: <arg id=”group”>My Group</arg>.
This is desired in most cases, but there may be times when you wish this not to be the case, and functionality is provided in LiveWhale to help control which groups’ data will be included in your widget.
If you wish to display data from a different group, change the name of your group in the group argument to the name of the group you wish to access data for.
If you wish to display data from all groups, delete the group argument. No group argument means all groups’ data will be included in your widget.
If you wish to display data from selected groups, add an additional group argument for each group that you wish to include:
<arg id=”group”>My Group</arg>
<arg id=”group”>Another Group</arg> (etc.)
If you wish to display data for all groups except selected groups, delete the group argument (in order to search all groups) but add any number of “exclude_group” arguments, identifying the groups you wish to exclude from the widget results: <arg id=”exclude_group”>Excluded Group</arg>
Setting up templates for widgets
There are a few ways to configure a template to be used for widgets that have a details view (such as news, events, galleries, forms, and tags).
1) In most cases, a default template for your group should be used.
To manage users and groups you must be an administrator.
From the LiveWhale interface, click the “Groups” link at the top righthand corner of the screen.
Click the name of the group you wish to change the default template for.
On the group edit page, enter the url (labeled “News Url”, “Events Url”, etc.) to the template that should be the default for this group. For example: /academics/news.php
2) If your widget should use a custom template for that widget only, you may specify the url using the “item_url” arg. For example: <arg id=”item_url”>/academics/news.php</arg>
3) If neither of these options are used, the template url will be obtained from the global CMS setting. Administrators can configure the system-wide LiveWhale defaults by editing the /livewhale/client/public.config.php file. Typically this will have been done once when LiveWhale is first configured.
Using the Twitter widget
For a general overview of widgets and what they do, please read “About widgets”.
The Twitter widget allows you to embed a Twitter stream in your web page. You can show tweets by specifying a Twitter username, a mentioned username (@username), or a search phrase, which may represent a hashtag (#livewhale).
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Twitter” from the dropdown menu labeled “Select a widget”.
All possible arguments for the Twitter widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the Twitter widget:
- Header. Enter a header that should display above the Twitter stream.
- Max. Enter the maximum number of feed items to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Username. Specify a username to pull tweets from. Multiple usernames can be specified, separated by a comma.
- Mention. Specify a username for which mentions (@username) are pulled. Multiple usernames can be specified, separated by a comma.
- Search. Specify a search phrase to return tweet results. If searching for a hashtag, specify the hash sign: #livewhale.
- Minutes. By default feeds will be cached for 60 minutes. To change this duration, enter the number of minutes to cache for here.
- Since. By default the widget will only display items within the last 3 months. To change this range, enter the time frame in the format “-# month”. For example: “-3 month”.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
Note: The Twitter server enforces an IP-based quota on requests for tweets. LiveWhale honors this quota and, should it be reached, your web page will continue to safely display the most recent cached copy of its results until the quota period resets.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the forms widget
For a general overview of widgets and what they do, please read “About widgets”.
The forms widget is used to list forms on your web site. Clicking one will take you to a page to fill out the form.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Forms” from the dropdown menu labeled “Select a widget”.
All possible arguments for the forms widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the forms widget:
- Header. Enter a header that should display above the forms list.
- Max. Enter the maximum number of forms to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Group: By default, forms from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get forms for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Tag. Enter any number of tags (one at a time) that forms should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that forms should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only forms tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find forms tagged with any of the tags entered, choose “any”.
- Search. If you wish to display forms according to search terms, enter them here.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the file widget
For a general overview of widgets and what they do, please read “About widgets”.
The file widget provides a basic way to import content from an external file (located on the same host). This is useful if the data is externally managed outside of LiveWhale, or if security mechanisms prevent the injection of content which is otherwise desirable.
In respect to the latter, certain HTML tags (like <iframe> or <script>) are not allowed in WYSIWYG editable fields because they may pose potential security risks. In these cases, content can be securely placed on the server via external means, and then imported using the file widget, adopting the assumption that this manually stored local content is safe.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “File” from the dropdown menu labeled “Select a widget”.
The file widget uses a single required argument, “path”. Enter the web-root relative path to the external file you wish to import content from. If multiple comma-separated paths are supplied, the widget will continually choose a random path from the list supplied.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
Note: If the file widget does not locate the resource specified via direct file system access, it will make a second attempt through the web server over HTTP in case the request can be handled virtually (for example, via mod_rewrite).
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the image widget
For a general overview of widgets and what they do, please read “About widgets”.
The image widget can be used to display a single image or rotating image from your LiveWhale image library. Displaying an image in this manner provides certain flexibility; you can configure the height, width, crop, and crop source region of the original image. (Derivative images are always cached by LiveWhale and do not need to be generated each time.)
Note: Unless you are creating a rotating image, the recommended method of displaying one or more images on your page is to use the images widget.
Additionally, if multiple image sources are supplied, one image will load at a time, cycling through the set with each page load.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Image” from the dropdown menu labeled “Select a widget”.
All possible arguments for the image widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the image widget:
- ID(s). Enter the ID (or IDs) of each image that should be displayed. In other words, you may choose to display a single image or multiple selected images. If you do not know the IDs of the images you wish to use, simply click on them in the image manager and the ID will display in the address bar of your browser.
- Group: By default, images from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get images for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Max. Enter the maximum number of images to display.
- Width. Enter the desired width of the image as it should display on your page. (Entering only one of the width/height dimensions will scale the other dimension however necessary to maintain the default image ratio.)
- Height. Enter the desired height of the image as it should display on your page.
- Keyword(s). If you do not wish to identify images by ID and would rather use all images matching a specific keyword or keywords, enter the keywords here.
- Tag. Enter any number of tags (one at a time) that images should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that images should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only images tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find images tagged with any of the tags entered, choose “any”.
- Crop. Set to “true” if the image should be cropped to the supplied width/height, otherwise leave it set to “false” and the image will be scaled.
- Src region. If you wish to isolate a single region of the master image to display, set this to the desired coordinates in the format: x,y,x2,y2.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the tags widget
For a general overview of widgets and what they do, please read “About widgets”.
The tags widget allows you to create a tag cloud on your web site. Each tag is linked to a page that displays data (news stories, events, etc.) in the system that are tagged with that item.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Tags” from the dropdown menu labeled “Select a widget”.
All possible arguments for the tags widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the tags widget:
- Header. Enter a header that should display above the tag cloud.
- Group: By default, tags from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get tags for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Min size/Max size. By default, tags within a cloud display at a size relative to how many items they are associated with. These two arguments allow you to select the minimum and maximum size the tags should be displayed at (in “em” units). Setting both to 1 will effectively disable this feature. In most cases, the defaults (0.9, 1.2) will be appropriate and these can be left blank.
- Min items. If you wish to only match tags that are associated with a certain number of items, set that number here. The default of 1 means that any and all tags associated with data will be displayed.
- Type. If you wish to restrict tags to only those associated with data of certain type(s), select those types here. By default, all types of data are considered.
- Only starred. By default, all tags are displayed. If you wish to instead show only starred tags, choose “yes”.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Item url. If you wish to override the default tags template with a custom one, specify the path (relative to the web root) to that template.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the news widget
For a general overview of widgets and what they do, please read “About widgets”.
The news widget is used to list news stories on your web site. Clicking these items will send you to their full details.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “News” from the dropdown menu labeled “Select a widget”.
All possible arguments for the news widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the news widget:
- Header. Enter a header that should display above the news story list.
- Max. Enter the maximum number of news stories to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Group: By default, stories from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get stories for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Tag. Enter any number of tags (one at a time) that news stories should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that news stories should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only news stories tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find stories tagged with any of the tags entered, choose “any”.
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Only starred. By default, all stories are displayed. If you wish to instead show only starred stories, choose “yes”.
- Search. If you wish to display news stories according to search terms, enter them here.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Start date. If you wish to find news on or after a certain date, enter it here.
- End date. If you wish to find news on or before a certain date, enter it here.
- Show archived. If you wish to display archived stories instead of current ones, set this to true.
- Thumb width. If you wish to use a different thumbnail size for news results, specify the width dimension (in pixels) here. If you’ve specified a height and wish for the width to automatically resize, enter “auto”.
- Thumb height. If you wish to use a different thumbnail size for news results, specify the height dimension (in pixels) here. If you’ve specified a width and wish for the height to automatically resize, enter “auto”.
- Thumb crop. If you wish for the thumbnail to crop, choose “true”.
- Date format. If displaying the date of a blurb, the default is month followed by day. If you wish to change that format, specify it using this arg (HTML is allowed). Use “%” to denote the PHP date modifiers. For example: “%l the %j%S” for “April the 19th”.
- Item url. If you do not wish to use the default news template for your group or web site, enter a web-root relative url to the custom template you wish to use.
- Show RSS link. If you wish to display a link to an RSS feed containing news stories according to this widget’s parameters, after the list of stories, set this to true.
- Related to. This argument should only be used if configuring a news widget on a news template. If you wish to display news stories that are related to the currently request news story, set this to true.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the blurbs widget
For a general overview of widgets and what they do, please read “About widgets”.
The blurbs widget is used to list blurbs on your web site.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Blurbs” from the dropdown menu labeled “Select a widget”.
All possible arguments for the blurbs widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the blurbs widget:
- Header. Enter a header that should display above the blurbs list.
- Max. Enter the maximum number of blurbs to display.
- Type. Select the type of blurbs to find blurbs. This field is required.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Group: By default, blurbs from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get blurbs for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Tag. Enter any number of tags (one at a time) that blurbs should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that blurbs should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only blurbs tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find blurbs tagged with any of the tags entered, choose “any”.
- Start date. If you wish to find blurbs on or after a certain date, enter it here.
- End date. If you wish to find blurbs on or before a certain date, enter it here.
- Show archived. If you wish to display archived blurbs instead of current ones, set this to true.
- Only starred. By default, all blurbs are displayed. If you wish to instead show only starred blurbs, choose “yes”.
- Search. If you wish to display blurbs according to search terms, enter them here.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Date format. If displaying the date of an event, the default is month followed by day. If you wish to change that format, specify it using this arg (HTML is allowed). Use “%” to denote the PHP date modifiers. For example: “%l the %j%S” for “April the 19th”.
- Show RSS link. If you wish to display a link to an RSS feed containing blurbs according to this widget’s parameters, after the list of blurbs, set this to true.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the events widget
For a general overview of widgets and what they do, please read “About widgets”.
The events widget is used to list events on your web site. Clicking these items will send you to their full details.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Events” from the dropdown menu labeled “Select a widget”.
All possible arguments for the events widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the events widget:
- Header. Enter a header that should display above the events list.
- Max. Enter the maximum number of events to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Group: By default, events from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get events for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Start date. If you wish to find events on or after a certain date, enter it here.
- End date. If you wish to find events on or before a certain date, enter it here.
- Max days. If you wish to scan for events only within the next X days, specify that number here.
- Tag. Enter any number of tags (one at a time) that events should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that events should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only events tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find events tagged with any of the tags entered, choose “any”.
- Only today. If you wish to display events for today’s date only, set this to true.
- Only starred. By default, all events are displayed. If you wish to instead show only starred events, choose “yes”.
- Search. If you wish to display events according to search terms, enter them here.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Thumb width. If you wish to use a different thumbnail size for event results, specify the width dimension (in pixels) here. If you’ve specified a height and wish for the width to automatically resize, enter “auto”.
- Thumb height. If you wish to use a different thumbnail size for event results, specify the height dimension (in pixels) here. If you’ve specified a width and wish for the height to automatically resize, enter “auto”.
- Thumb crop. If you wish for the thumbnail to crop, choose “true”.
- Date format. If displaying the date of an event, the default is month followed by day. If you wish to change that format, specify it using this arg (HTML is allowed). Use “%” to denote the PHP date modifiers. For example: “%l the %j%S” for “April the 19th”.
- Item url. If you do not wish to use the default events template for your group or web site, enter a web-root relative url to the custom template you wish to use.
- Show RSS link. If you wish to display a link to an RSS feed containing events according to this widget’s parameters, after the list of events, set this to true.
- Show iCal link. If you wish to display a link to an iCal feed containing events according to this widget’s parameters, after the list of events, set this to true.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Show public. By default, the widget will not display items submitted from the public. To force display of these items, change this to true.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the files widget
For a general overview of widgets and what they do, please read “About widgets”.
The files widget is used to list files on your web site. Clicking these items will tell the browser to download them.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Files” from the dropdown menu labeled “Select a widget”.
All possible arguments for the files widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the files widget:
- Header. Enter a header that should display above the files list.
- Max. Enter the maximum number of files to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Group: By default, files from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get files for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Tag. Enter any number of tags (one at a time) that files should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that files should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only files tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find files tagged with any of the tags entered, choose “any”.
- Only starred. By default, all files are displayed. If you wish to instead show only starred files, choose “yes”.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Show RSS link. If you wish to display a link to an RSS feed containing files according to this widget’s parameters, after the list of files, set this to true.
- Filetype. If you wish to only display files of a certain type, select the type here. (Only currently used types are shown.)
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
Note: Files that are marked as “hidden”, and thus will not show up in a widget, may nevertheless be bookmarked or have their urls e-mailed. These “permalinks” to the file will not serve the file while it is flagged as “hidden” in order to respect the item’s status.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the galleries widget
For a general overview of widgets and what they do, please read “About widgets”.
The galleries widget is used to list galleries on your web site. Clicking these items will send you to their full details.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Galleries” from the dropdown menu labeled “Select a widget”.
All possible arguments for the galleries widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the galleries widget:
- Max. Enter the maximum number of galleries to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Header. Enter a header that should display above the galleries list.
- Group: By default, galleries from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get galleries for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Tag. Enter any number of tags (one at a time) that galleries should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that galleries should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only galleries tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find galleries tagged with any of the tags entered, choose “any”.
- Randomize. If you wish to display galleries in a randomized order, choose “yes”.
- Only starred. By default, all galleries are displayed. If you wish to instead show only starred galleries, choose “yes”.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Search. If you wish to display galleries according to search terms, enter them here.
- Thumb width. If you wish to use a different thumbnail size for gallery results, specify the width dimension (in pixels) here. If you’ve specified a height and wish for the width to automatically resize, enter “auto”.
- Thumb height. If you wish to use a different thumbnail size for gallery results, specify the height dimension (in pixels) here. If you’ve specified a width and wish for the height to automatically resize, enter “auto”.
- Thumb crop. If you wish for the thumbnail to crop, choose “true”.
- Item url. If you do not wish to use the default galleries template for your group or web site, enter a web-root relative url to the custom template you wish to use.
- Show RSS link. If you wish to display a link to an RSS feed containing galleries according to this widget’s parameters, after the list of galleries, set this to true.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the feeds widget
For a general overview of widgets and what they do, please read “About widgets”.
The feeds widget is designed to pull items from a live RSS or iCal feed and display them as a list on your web page. Each item will link to the item’s url, the same way each does in the original feed.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Feeds” from the dropdown menu labeled “Select a widget”.
All possible arguments for the feed widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the feeds widget:
- Url. Enter the url to the feed you wish to pull items from. If you wish to merge multiple feeds, enter them here in a comma-separated list. This argument is required.
- Max. Enter the maximum number of items to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Header. Enter the title to display before the feed list.
- Excerpt length. Enter the number of words to limit each item’s description to. This is only applicable if description is being displayed in widget results.
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Show source link. Set to “true” if a link to the original feed’s site should display beneath the feed list.
- Show RSS link. Set to “true” if a link to the original RSS feed should display beneath the feed list. (If multiple urls have been given, the resulting RSS feed will be a locally hosted aggregated feed of all supplied urls.)
- Show iCal link. Set to “true” if a link to the original iCal feed should display beneath the feed list.
- Since. By default the widget will only display items within the last 3 months. To change this range, enter the time frame in the format “-# month”. For example: “-3 month”.
- Until. By default the widget will only display items up to 1 week in the future. To change this range, enter the time frame in the format “+# week”. For example: “+3 week”.
- Minutes. Enter the number of minutes this feed should cache for, before being recached from its source. If left blank, the default is 60 minutes.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
Note: Users who are setting the display format for the feeds widget can access custom RSS fields using display variables that match the name of the custom RSS field.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the pages widget
For a general overview of widgets and what they do, please read “About widgets”.
The pages widget is used to list pages on your web site.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Pages” from the dropdown menu labeled “Select a widget”.
All possible arguments for the pages widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the pages widget:
- Header. Enter a header that should display above the pages list.
- Max. Enter the maximum number of pages to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Tag. Enter any number of tags (one at a time) that pages should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that pages should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only pages tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find pages tagged with any of the tags entered, choose “any”.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Sort order. The default sort order of widget results is chosen for you. If you wish to use a different sort order, select it from the dropdown menu.
- Search. If you wish to display pages according to search terms, enter them here.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Embedding an inline form in a web page
The forms widget normally displays a list of forms, each linking to the form itself. It is sometimes desirable to embed a single form directly in your web page. In such cases, you can use the special inline form widget.
An inline form widget should be given an id for the form that you wish to use. If you do not know the id of the form, click on it in the forms manager and click “Get Widget Code” to view the inline form widget, referenced by id.
For example, if you wanted to show the form with id 1, the inline form widget would look like this:
<widget type=”forms_inline”><arg id=”id”>1</arg></widget>
The familiar “header” arg is also available for inline form widgets.
Using the save-and-share widget
For a general overview of widgets and what they do, please read “About widgets”.
The save-and-share widget is used to display social networking share links on a page. These links are automatically displayed when viewing the details of a news story, etc., if the template includes the save-and-share component. However, you may wish to display these links on any web page.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Save and Share” from the dropdown menu labeled “Select a widget”.
All possible arguments for the save-and-share widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the forms widget:
- Header. Enter a header that should display above the share links.
- Shorten Urls. By default, LiveWhale will use a built-in url shortener for simplified url formats. You can disable this by choosing “false”.
- Suffixes: Some social networking services allow you to append a suffix to the share url for adjusting link title, etc. You may add those in these fields.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the navigation widget
For a general overview of widgets and what they do, please read “About widgets”.
The navigation widget allows you to display a navigation menu on your web site. Menu items are expandable and automatically highlight throughout the process of navigation. (This widget is typically paired with the breadcrumb widget.)
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Navigation” from the dropdown menu labeled “Select a widget”.
All possible arguments for the navigation widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the tags widget:
- ID. Enter the ID of the navigation you wish to display. You may obtain this from the navigation editor address bar.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
Note that if you add a permalink to a file as a navigation menu item, the menu item will be assigned a class denoting the referenced file type.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the breadcrumb widget
For a general overview of widgets and what they do, please read “About widgets”.
The breadcrumb widget allows you to display a breadcrumb line on your web site, according to an existing navigation menu. (This widget is typically paired with the navigation widget.)
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Breadcrumb” from the dropdown menu labeled “Select a widget”.
All possible arguments for the navigation widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the tags widget:
- ID. Enter the ID of the navigation you wish to create a breadcrumb line from. You may obtain this from the navigation editor address bar.
- Separator. Each crumb in the breadcrumb line is separated by a right-pointing double angle quotation mark (»). If you wish to use a different character as a separator, specify it here.
- Levels. By default, the breadcrumb line will show the entire route through the navigation menu to the current page. If you wish to limit the number of steps back from the current page that the breadcrumb line produces, set that number here.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Using the images widget
For a general overview of widgets and what they do, please read “About widgets”.
The images widget can be used to display one or more images from your LiveWhale image library. Displaying images in this manner provides certain flexibility; you can configure the height, width, crop, and crop source region of the original images. (Derivative images are always cached by LiveWhale and do not need to be generated each time.)
Note: The images widget will display images in the traditional list format. They can be clicked for a larger preview. If you wish to display a rotating image, you should use the image widget.
From the LiveWhale interface, click the “Widgets” link and then click “Add a new widget”.
Select “Images” from the dropdown menu labeled “Select a widget”.
All possible arguments for the images widget will display. Required arguments have a red asterisk, all others are optional.
These are the arguments for the image widget:
- ID(s). Enter the ID (or IDs) of each image that should be displayed. In other words, you may choose to display a single image or multiple selected images. If you do not know the IDs of the images you wish to use, simply click on them in the image manager and the ID will display in the address bar of your browser.
- Path. Enter the web-root relative path to images that should be used which are not in the image library.
- Header. Enter a header that should display above the image list.
- Max. Enter the maximum number of images to display.
- Paginate. By default, widget results paginate after the first 30 items and display a “show more” link. To use a different number instead of 30, enter it here. To disable pagination completely, enter “false”.
- Group: By default, images from all groups will be listed. If you wish to control which groups are considered, enter the group(s) you wish to get images for. If you are unsure which groups are available, click “Show all groups”.
- Exclude group. To exclude specific groups from the list, enter the group(s) you wish to exclude.
- Width. Enter the desired width of the images as they should display on your page. (Entering only one of the width/height dimensions will scale the other dimension however necessary to maintain the default image ratio.)
- Height. Enter the desired height of the images as they should display on your page.
- Keyword(s). If you do not wish to identify images by ID and would rather use all images matching a specific keyword or keywords, enter the keywords here.
- Tag. Enter any number of tags (one at a time) that images should be tagged with.
- Exclude tag. Enter any number of tags (one at a time) that images should not be tagged with.
- Tag mode. By default, if multiple tags are entered, only images tagged with all of these tags will be found. This is done by selecting “all”. Alternatively, if you wish to find images tagged with any of the tags entered, choose “any”.
- Crop. Set to “true” if the image should be cropped to the supplied width/height, otherwise leave it set to “false” and the image will be scaled.
- Src region. If you wish to isolate a single region of the master image to display, set this to the desired coordinates in the format: x,y,x2,y2.
- Search. Enter search keywords to match images with.
- Filter. If you wish to filter results using custom rules, enter them here. (For more information on filters, please read “Using the filter arg in widgets”.)
- Start date. Enter the start date of a date search range.
- End date. Enter the end date of a date search range.
- Show RSS link. If you wish to display a link to an RSS feed containing images according to this widget’s parameters, after the list of images, set this to true.
- Columns. By default the widget will display results in a single column format. To display results across multiple columns, specify the number here.
- Slideshow/slideshow interval. To automatically show one result at a time, fading between each on an interval, set slideshow to true. The default interval (in milliseconds) is 5000 (5 seconds). You may adjust this by setting a different slideshow_interval value.
To preview the results this widget would produce, click “Widget preview”.
The widget syntax will display in a box labeled “Widget syntax”. If you do not wish to save this widget for later use, the syntax can be copied and pasted into your page. If you wish to save this widget with a name, enter the name at the top of the page, select whether to make this widget available to all LiveWhale users or only members of your group, and click the “Save this widget” button. (See “Adding a widget to a web page” for more information.)
When done, you may insert the widget into your page and, once saved, your widget will begin displaying results.
For information about formatting widgets in a custom way, please see “Using the format arg in widgets”.
Displaying widgets results with pagination
By default widgets list their results in a paginated format. After the first 30 results, a “show more” link will display, allowing the user to click to reveal the next 30 results. The per-page number of results (30) can be changed, and pagination can also be disabled for a widget. This is done with the “paginate” arg.
Suppose you are displaying all news stories tagged with “Architecture”:
<widget type=”news”>
<arg id=”tag”>Architecture</arg>
</widget>
By default, this will show the first 30 news stories, followed by a link to show more. In order to display this same widget with just 5 news stories before the show more link appears, you would do the following:
<widget type=”news”>
<arg id=”tag”>Architecture</arg>
<arg id=”paginate”>5</arg>
</widget>
If you want to disable pagination completely for this widget, you would set “paginate” to false:
<widget type=”news”>
<arg id=”tag”>Architecture</arg>
<arg id=”paginate”>false</arg>
</widget>
Displaying widget results in multiple columns
By default widgets list their results in a single list. For most widgets it is possible to instruct LiveWhale to divide results across any number of columns. This is done with the “columns” arg.
Suppose you are displaying all news stories tagged with “Architecture”:
<widget type=”news”>
<arg id=”tag”>Architecture</arg>
</widget>
In order to display this same widget in 2 columns, you would simply add the “columns” arg this way:
<widget type=”news”>
<arg id=”tag”>Architecture</arg>
<arg id=”columns”>2</arg>
</widget>
This will display the same news stories tagged with “Architecture”, but do so in a two-column format. Displaying results across multiple columns does not affect any other args, including pagination.
Embedding an inline gallery in a web page
The galleries widget normally displays a list of galleries with links to view a slideshow of their images. It is sometimes desirable to embed a gallery slideshow directly in your web page. In such cases, you can use the special inline gallery widget.
Typically an inline gallery widget will be given an id for the gallery that you wish to use. If you do not know the id of the gallery, click on it in the galleries manager and the id will display in your browser’s address bar while on the gallery editor page.
Along with an id, you must supply either an image width or image height (or both) specifying the gallery’s image sizes when embedded in your web page.
For example, if you wanted to show the gallery with id 1 using a width of 300 pixels, the inline gallery widget would look like this:
<widget type=”galleries_inline”>
<arg id=”id”>1</arg>
<arg id=”image_width”>300</arg>
</widget>If you do not wish to specify a particular gallery to use, and would rather select one via tag, etc., you may use one of the args from the galleries widget.
Advanced LiveWhale users may wish to change the format of the embedded gallery output. This can be done the following way:
The default template for an embedded gallery is located at /livewhale/core/modules/galleries/templates/public.galleries_inline_mini.html.
Create a galleries dir in /livewhale/client/modules. Copy this template to that directory.
Change the name of the new template, replacing the word “mini” with the name of your new style. For example, if you called it “feature”, the new template would live at: /livewhale/client/modules/galleries/templates/public.galleries_inline_feature.html.
In your inline gallery widget, use the “type” argument to tell LiveWhale to use the new custom template: <arg id=”type”>feature</arg>
Inline galleries will also offer a link to the full gallery. If you wish to use a custom template for this link, use the “item_url” arg to specify the location of the template.
If you wish to randomize the order of the photos in the inline gallery, set “randomize_photos” to “true” using the arg: <arg id=”randomize_photos”>true</arg>