Ingeniux Content Management System v4.0
User’s Guide for the Author Client
User’s Guide to the Author Client
User’s Guide for the Author Client
Contents
PREFACE ........................................................................................ 4
How to Use this Documentation ...................................................... 4
About Ingeniux Documentation ....................................................... 4
Getting Help ............................................................................. 5
Conventions .............................................................................. 5
Organization of Documentation ...................................................... 6
The Demo Site ........................................................................... 6
INTRODUCTION TO INGENIUX CMS ............................................................... 7
Overview of Ingeniux CMS ............................................................. 7
Client/Server Architecture......................................................... 7
End-User Clients ..................................................................... 7
Ingeniux CMS Concepts................................................................. 7
Separation of Content from Presentation ....................................... 7
Schemas and Stylesheets ........................................................... 8
The Content Repository and Site Map ............................................ 8
Components and Pages ............................................................. 8
Users and Groups .................................................................... 9
Assignments and Workflow......................................................... 9
Other CMS Terms and Concepts ................................................. 10
GETTING STARTED WITH THE AUTHOR CLIENT .................................................. 10
Who Should Read this Guide ........................................................ 10
System Requirements ................................................................ 10
Starting the Author Client .......................................................... 11
Overview of User Interface.......................................................... 11
Information Pane (Left Column) ................................................ 12
Toolbar .............................................................................. 13
Main Work Space................................................................... 14
WORKING WITH CONTENT ..................................................................... 15
Use-Case Scenarios.................................................................... 15
Pages in Workflow ................................................................. 15
Pages Not in Workflow............................................................ 16
Finding Existing Content.......................................................... 16
Creating a New Page ................................................................. 16
Adding Content: the Edit Form ..................................................... 18
Data Types.......................................................................... 19
Access Levels....................................................................... 19
Required Fields .................................................................... 19
Finishing Your Work .................................................................. 20
Check Spelling ..................................................................... 20
Preview ............................................................................. 20
Assign or Advance ................................................................. 20
Next Steps .......................................................................... 21
AUTHOR CLIENT IN DETAIL .................................................................... 22
Edit Form............................................................................... 22
Data Types.......................................................................... 22
Read-Only and Hidden Fields .................................................... 23
Required Fields .................................................................... 23
Status Bar ........................................................................... 23
Preview Pane .......................................................................... 24
In-Context Editing ................................................................. 24
Folder/Child Pages View............................................................. 24
22
User’s Guide to the Author Client
WYSIWYG Control .....................................................................
Formatting Toolbar................................................................
Editing Source of WYSIWYG Control ............................................
Dragging and Dropping from other Applications ..............................
Using CSS to Control Formatting ................................................
Working with Images and other Assets ............................................
Uploading the Image ..............................................................
Inserting Images Components onto Pages .....................................
Inserting Images into the WYSIWYG control...................................
Assignment List........................................................................
Site Map ................................................................................
Overview ............................................................................
Appearance of the Site Map .....................................................
Moving and Copying Pages in the Tree .........................................
The Context Menu .................................................................
Search...................................................................................
Constructing a Query .............................................................
Using the Search Results .........................................................
Advanced Search Concepts.......................................................
Spelling Checker ......................................................................
Check Spelling Dialog .............................................................
Options Dialog......................................................................
Dictionaries Dialog ................................................................
NEXT STEPS ...................................................................................
25
25
32
32
33
34
34
36
36
38
38
38
39
39
41
45
45
46
47
49
49
50
52
54
33
User’s Guide to the Author Client
Preface
Welcome to Ingeniux Content Management System v4.0. In this collection of
guides, you will find general information about Ingeniux CMS, installation and
upgrade instructions, user’s guides for the Windows and OSX clients, and
guides for site administrators and developers.
How to Use this Documentation
If you are new to Ingeniux CMS, you should begin by reading the following
sections first:
Preface
Introduction to Ingeniux CMS
If you are a current user of the software, read
What’s New in Version 4.0
In addition, there are three User’s Guides. Depending on which client you will
be using for the majority of you work, you should read one the following:
User’s Guide to the Windows Author Client
User’s Guide to the Windows Admin Client
User’s Guide to the OSX Macintosh Client
These guides should also be read by administrators and support and training
personnel who will be dealing with end-user questions.
For instructions on installation and configuration, refer to
Administrator’s Guide.
For site development guidelines and advanced topics, refer to
Developer’s Guide
About Ingeniux Documentation
Documentation for this product exists in several forms. Compiled Help files
are installed when you install CMS, and these can be accessed when using any
of the clients. These Help files can also be downloaded from Ingeniux at:
http://docs.ingeniux.com
44
User’s Guide to the Author Client
Updates to this documentation can be found at:
http://docs.ingeniux.com/revisions
This should be checked frequently for new information about the product.
Getting Help
Direct all support questions to
[email protected]
Customers can track support issues on the Web with our online issue tracking
system. Contact Ingeniux support for details.
Conventions
There are often several ways to accomplish the same task in Ingeniux CMS.
For example, the Check In/Check Out function can be accessed from the
main Menu under File, from the Toolbar icon, or from the context menu in
the Site Map. Often, only the Menu method will be described.
The following typographic conventions will be used in this guide.
Convention
Meaning
Bold
In procedures, indicates the text you type or the name
of a screen object (such as a menu or button).
Menu 1 | Menu 2
Cascading menu items are listed sequentially
separated by a vertical line.
Italic
Indicates a glossary term
Key 1+Key 2+Click
Indicates that two or more key strokes and possibly a
mouse click are to executed simultaneously (e.g.,
ctrl+click)
Double-click
Refers to quickly clicking the mouse button twice.
Single-click
Refers to clicking the mouse button once.
Selecting content
Refers to holding the mouse button down while moving
the mouse over a section of content, then releasing
the button
Drag and drop
Refers to clicking on a block of selected content with
the mouse button, and moving it to a new location
55
User’s Guide to the Author Client
while holding the button down, then releasing the
mouse button to drop the content in a new location
Note:
Identifies an important note
Tip:
Identifies a tip
On the Windows clients, the term mouse button is assumed to mean the
primary mouse button, usually on the left. Right clicking refers to clicking the
secondary button, usually on the right. On the OSX client, there is only one
mouse button, with ctrl+click being used instead of right clicking on the
Windows side.
Organization of Documentation
The CMS end-user clients are highly configurable, and the way the user
interfaces appear and behave depends considerably on the configuration of
the site being worked with. The setup of group permissions, workflow, page
creation rules, and content security will determine what menu items, content
nodes, and dialogs different users will see. Not every permutation of these
factors can be covered in the documentation, but typical use-case scenarios
will be presented that cover a broad range of possibilities.
This guide is organized so that the usage patterns associated with the most
restrictive level of permissions are covered first, followed by cases associated
with more expansive permissions. You should study the scenarios that most
closely correspond to your usage patterns as determined by site configuration
and your job responsibilities.
It is assumed for the purposes of this guide that a) Ingeniux CMS has already
be properly installed and configured on the server; b) a site has been set up
on the server; c) the user has access to the server; d) users, groups,
workflows, and page creation rules have been properly set up and configured,
and e) the user has been assigned to the appropriated group or groups. These
topics are covered in the Administrator’s Guide.
The Demo Site
In this documentation, we will be using screen shots from a sample site for a
fictional institution called Faber College. You will find this among the sample
sites that ship with the product.
66
User’s Guide to the Author Client
Introduction to Ingeniux CMS
Overview of Ingeniux CMS
Client/Server Architecture
The Ingeniux CMS software and all content that comprises the Web site reside
on a centralized server--the content never resides on the user’s computer.
The server-based content is accessed via the Internet with a browser-based
client, which means that users can access and manipulate content from any
computer and from any location that has access to the Internet (assuming
your administrator has configured the server to allow outside access). This
makes your company’s data very secure, since access can be controlled
centrally, and problems with any individual users’ computers (e.g., a hard
drive crash) can have no affect on the central data repository.
Ingeniux CMS has two primary components: the design-time production
server and the run-time deployment server. These are usually physically
separate computers because of their significantly different roles and the
requirements. The production server is the computer that all content workers
interact with, and usually exists on the customers LAN. Typically, the
published content of a site is transferred to the deployment server, which is
often hosted in the customer’s Internet data center, or Web farm. The
software on the deployment server is basically a subset of software on the
production server.
End-User Clients
Content workers interact with the server-based content via client
applications on the users’ computers. On the Windows side, these are
Internet Explorer-based clients that use ActiveX controls and communicate
with the Ingeniux server via http. On the Apple side, this is a native OSX
application that also communicates with the server via http.
Ingeniux CMS Concepts
There are a few general concepts that all users of Ingeniux CMS, regardless of
their technical knowledge or permissions level, or which client they use, will
find it helpful to be familiar with. These are discussed below.
Separation of Content from Presentation
Unlike traditional methods of Web authoring using HTML, Ingeniux CMS
separates all actual content (words, data, media, and other assets) from the
manner in which it is displayed (fonts, colors, layout, etc.). In Ingeniux CMS,
content workers only have to worry about the content itself, and not the way
it is displayed. The look and feel of the pages you create is determined
almost entirely by layout specifications that have been created by the site
designers. Creating a page in Ingeniux CMS is very similar to filling out a
simple Web form: You only have to worry about filling in the blanks, and the
system does the rest.
77
User’s Guide to the Author Client
This has many benefits besides making the authoring and editing of content
extremely simple. It also makes the site design very flexible: an entire site of
thousands of pages could be redesigned merely by changing a handful of
layouts. It also makes content very “portable”: since pages contain only data
and no presentation information or branding, it is easy to share content with
other department or organizations who may wish to present the information
with a different look and feel.
Schemas and Stylesheets
In Ingeniux CMS, small XML files called schemas determine the number of
distinct page types (e.g., news release, policy article, etc.). Schemas specify
what fields appear on the Edit form (headline, abstract, body copy, etc.).
Based on the information filled in on the Edit form, an XML file is produced
when the page is saved that contains all of the data associated with that
item. These files have names of the form x[PageID].xml; for example,
x123.xml.
Stylesheets are XSL (Extended Stylesheet Language) files that determine the
layout, or look and feel, of a site. When a page is requested by a user with a
browser or some other device, the Ingeniux server binds the requested XML
file with the associated XSL file, and delivers the fully constituted page to
the browser or device.
The Content Repository and Site Map
Content in Ingeniux CMS resides on a central server in the Content
Repository, and is arranged in a hierarchical fashion in a manner very similar
to what you see when browsing the file structure on a hard drive. This
hierarchical structure is expressed in the Site Map. The terminology to
describe the relationship between items in the site map is familiar: Any
particular item in the content repository is known as a node. Items that are
one level above other node in the hierarchy are said to exhibit a parent-child
relationship; with the superior node called the parent node and the
subordinate node called the child. Nodes at the same level are said to exhibit
a sibling relationship. Any nodes hierarchically above a given node are known
as ancestors; and any nodes below are referred to as descendents.
The structure of the content in the site map is usually strongly reflected in
the structure and navigation of the Web site. For example, in the Site Map, a
parent page may have ten child pages; and on the Web site, that parent page
might be a section table-of-contents page that lists the ten articles that
appear in that section.
Components and Pages
Content in Ingeniux CMS is composed of components. Components allow for
the reuse of data that is used repeatedly in a site. For example, every page
on a given Web site might have the same footer. Rather than include this
footer information in the data for each and every page, it can be made into a
component that can be included, or linked to, on every page, without
88
User’s Guide to the Author Client
embedding the data itself on each page. If information in the footer changes,
only the footer needs to be updated, and these changes are then immediately
reflected everywhere on the site. Components make it much easier to
organize and maintain information in large sites.
Other common data that exists as components include navigation
information, images or other media, and links. Any item that appears in the
Content Repository is a component; indeed, a whole page may itself be a
component that is included on other pages. Generally speaking, the term
page is reserved for the base pages in a site; i.e., the pages that an end user
would typically navigate to in a browser. The term component is reserved for
items that are included on base pages, which do typically not have
stylesheets associated with them because they are not typically navigated to
by end users and so do not need layouts.
Users and Groups
All users are assigned to one or more groups. Groups have associated with
them certain permissions that determine what they are allowed to do within
CMS. These permissions include, for example, the ability to create new
pages, the ability to assign pages from one user to another, the ability to
check pages in and out, or the ability to see the Site Map in the Author and
OSX Clients.
Assignments and Workflow
In Ingeniux CMS, the concept of an assignment is central. You can only work
on pages that are assigned to you, which prevents multiple users from
working on the same content at the same time. All pages assigned to you
appear in your assignment list, giving you a view into your workload at a
glance.
Pages can be reassigned to other users within a group at will. When a page is
assigned from one user to another, the page itself does not move from one
user’s machine to the other—the assignment is merely a “pointer” to the
server-based content, and it is only this pointer that changes. When a page is
assigned from one user to another, it disappears from the assigner’s
assignment list and appears in the assignee’s list.
Workflows determine the path that any particular piece of content takes
though an organization from the time it is created to the time it is published.
A workflow comprises the workstates (e.g., authoring, editing, approval,
publishing, etc.) that describe the steps a particular type of content has to go
through during its lifecycle, and the allowed transitions between these
workstates (e.g., send for approval, send back to author, etc.).
The difference between and assignment and a transition is that an
assignment does not transition the page to another workstate—it merely
reassigns the page to another user in the same group. It is often used for
simple peer review before sending the page to the next state.
99
User’s Guide to the Author Client
When a page is in workflow, a content worker has only one decision to make
when their work is complete: They simply choose from among the available
transitions, which will a) put the page in another workstate; b) assign it to
someone else; and (optionally) c) perform certain actions on the page
automatically (e.g., check in, mark for publish, and publish). Most low-level
users thus never have to be worry about these functions, since they are
performed automatically, and thus do not have to even have to be granted
the permissions to perform these functions, which allows system
administrators to exert better control over the organization’s vital content.
Other CMS Terms and Concepts
There are a few other terms and concepts that will be helpful to understand
when using CMS.
Checked In/Out: When a page is checked in, it is protected from editing. The
fields on the Edit Form appear grayed out. When a page is checked out, it is
available for editing.
Rollback: Rollback undoes all changes made on a page back to the last
checked in version.
Mark for Publish: Before a page can be published, it must be marked for
publish. When a
Publish: The publish operation assembles the various components of a page
and creates the file that will actually be reference by the browser or other
device.
Page Creation Rules: Page creation rules determine where a page is created
in the site, what workflow it will be attached to, and what groups are
allowed to create pages based on this rule.
Users will have varying levels of access to these functions depending on their
group permissions.
Getting Started with the Author Client
Who Should Read this Guide
This Users Guide should be read by all content workers who will be using the
Ingeniux CMS Author client for any or all of their work, and by administrators
and support personnel who will be dealing with end-user questions.
System Requirements
To use the Author client, you must have:
10
10
User’s Guide to the Author Client
•
Microsoft Internet Explorer v6.0
•
Windows 98, Windows 2000, or Windows XP
•
A connection to the Internet
Starting the Author Client
To start the Author Client, simply type the URL for the site you wish to work
with in the address bar of IE. This is usually of the form
//[ServerName]/[SiteName] or
http://[DomainName]/[SiteName]
You will then be asked to log in. Use the same credentials as for your network
login. If the login dialog box has three blanks in it asking for your user name,
password, and domain, provide this information as specified by your
administrator. If you see a login dialog with two only two boxes for user name
and password, provide your user name in the form
[DomainName]\[UserName].
If you are accessing an Ingeniux site for the first time from your computer,
you will be prompted to download two signed controls. Click Yes to accept
both of these. You will not be asked to download these next time you log in
from that computer.
[SCREENSHOT]
Overview of User Interface
The Author Client UI consists of three main elements: The left-hand
information pane, the right-hand Edit/Preview area, and the toolbar. These
will be discussed below.
11
11
User’s Guide to the Author Client
Information Pane (Left Column)
This area of the screen will contain a list of pages and other content items
that are currently assigned to you when the Assignments tab is clicked; or a
search pane if the Search tab is clicked; or a tree view if the Site Map tab is
clicked.
Assignment List
The Assignment pane shows a list of all pages assigned to you. When you
create a new page of any type, that page will show up in your Assignments
list until you either assign the page to someone else (Send To) or transition
the page to the next workstate. Other workers may assign pages to you that
they have created, or someone else in your group may send you a page using
the Send To feature. These pages will also show up in your Assignments tab.
Search
Clicking this tab will bring up the Search feature, which is used for finding
stories, images and other items in the design-time Content Repository. To
access the Search tab, simply click your left mouse button on the tab labeled
“Search”. More information can be found in the Search chapter of this
document. Search results will also be shown in this pane.
Site Map
Clicking the Site Map tab gives the users a hierarchical view of how content is
structured in the Content Repository. It also provides a way to change the
order of items on the site, via dragging and dropping. Not all users will have
access to the Tree tab, and those that do will have varying degrees of access
to various pieces of content (no access, read only, or full access) depending
12
12
User’s Guide to the Author Client
on what groups they are in and how node-by-node security has been
configured for those groups. For example, there may be areas of the Site map
that are not visible to users of a particular group. Right-clicking on a page in
the Site Map brings up a context menu that has the allowed commands for
that group.
Toolbar
This area of the screen contains the command buttons that users will use in
the process of creating pages and publishing them to the web. These are
described below.
Hide/Show Info Pane
This button will hide the left column and give you more space for editing your
content. Once you click the Hide Info Pane button to hide the left column,
clicking the button again will return the left column to view.
Refresh
Under normal conditions, your Assignments list will refresh with each action
you take, thereby showing you any new items that have been added to your
Assignments list since the last operation. You may click the Refresh button to
force a Refresh at any time.
Rename
You may rename any item that is in your Assignments list (or in the Tree View
if you have the appropriate permissions set). Simply left-click the item to be
renamed, and then click the Rename button.
Upload
The upload button allows you to import images and other media into the
Content Repository, which you can later use as components in your pages or
add directly to the WYSIWYG control.
New
The New button allows you to create a new page, image component, or any
other content type as allowed by your user permissions.
Save
This causes your work to be saved to the server. The Author client can be set
to save work automatically at a predetermined interval; however, it is a good
idea to click Save whenever you have completed a substantial portion of work
that you don’t want to lose.
13
13
User’s Guide to the Author Client
Spelling
Click this button to run the Spelling Checker on your current page. This will
be discussed in more detail later.
Send To
This button allows you to assign the current item (i.e., the item currently
active in the Edit form) to any other person who belongs to the current
group.
Workflow Advance
This button will transition the page to the next workstate. The caption of this
button is taken from name of the next allowed transition (e.g., “Send for
Approval”), and will thus depend on the workflow that is attached to the
page and what the current workstate is. If more than one transition is
available from the current workstate, the button will be a combo drop-down
button with all available transitions listed in the dropdown
Help
Launches the Help file for additional information and assistance. The location
of the help file is configurable, so Help can either point to the standard
product documentation or to a custom tailored help site written specifically
for the customer’s site. Some customers actually maintain their site-specific
help files in their site’s Content Repository, and publish this help site to the
location that invoked by the Help button. That way, editorial workers always
have the most current instructions for working with their site’s content.
Main Work Space
Edit Tab (Edit Form)
This area of the screen, called the Edit Form, provides the main editing area
for creating new pages, or reviewing or editing existing pages. The Status Bar
across the top of the Edit Form also gives information about the page, such as
page name, page ID, who it is assigned to, and, if the page is in workflow,
what workstate the page is in, and any comments from the person assigning
the page.
Clicking an item in the Search results pane also opens the item in the lower
half of the Edit form, provides a place to view the contents of an item
returned by Search.
Preview Tab
Clicking the Preview tab will provide a very high-fidelity rendering of the
current page as it will look when published. This preview is completely
functional, with all navigation, links, etc., working as they will on the
published pages. This provides a useful alternative to the Assignment list,
Search, and the Site Map as a means of finding content.
14
14
User’s Guide to the Author Client
Child Pages Tab
When the current page in the Edit form has child pages beneath it in the
content hierarchy, a tab will appear that allows you to see all of these child
nodes. This is especially useful if the user doesn’t have access to the tree
view.
Working with Content
The exact manner in which you interact with content in Ingeniux CMS
depends on many factors that are specific to the implementation of your site,
such as group permissions and roles, content security settings, and the like.
Not every permutation of these factors can be covered in the documentation.
There are, however, two distinct strategies for working with content,
depending on whether the pages you are working on are bound to workflows
or not.
Use-Case Scenarios
Pages in Workflow
When pages are bound to workflow, the primary approach to interacting with
content consists of choosing items from your assignment list, adding or
editing content, then advancing them through workflow to other users.
Workflow generally implies that different users will be responsible for the
page at various points in its lifecycle (e.g., authoring, editing, approval), and
that this “trajectory” through the organization must be enforced.
Depending on how workflow has been configured, the workflow transitions
may perform many of the actions that the user normally would have to do
manually (e.g., check in, mark for publish, publish). Because these actions
are being performed automatically in workflow, the permissions for these
functions may be revoked at the group level. In general, when workflow is
heavily employed on a site, group permissions are much more restrictive than
otherwise. This gives site administrators the ability to “lock down” content
very tightly if desired, making it difficult or impossible for users to
inadvertently compromise the content of the site.
So, when pages are in workflow, users do one of the following:
•
Create a new page, add content, and advance it in workflow or assign it
to another member of your group. Page creation rules (if used) will
automatically ensure that the page is created in the correct section of the
site, attached to the correct workflow, and assigned to the correct user.
•
Choose an existing item, modify it as required, and advance it in
workflow to the next workstate or assign it to another member of your
group.
15
15
User’s Guide to the Author Client
Pages Not in Workflow
When pages are not in workflow, interacting with content is typically less
structured, with no enforced trajectory through the organization and no
enforced division of labor between different users. When workflow is not
used extensively, permissions are typically more expansive, and users have
more freedom as to what they can do with content, but also have more
responsibility perform the correct actions on a page to ensure it is in the
proper state. Such actions as check in/check out, mark for publish, and
publish now have to handled manually.
Finding Existing Content
Whether pages are in workflow or not, if you wish to modifying an existing
item in the Author Client, there are several ways to locate the item you wish
to edit:
•
Assignment list: From your Assignment list, click on the desired item and
edit it in the Edit Form. Your assignment list in most cases gives you the
most exhaustive list of what you should be working on.
•
Site Map: Browse for the item in the Site Map (assuming your group has
permission to see it), click on it, and edit. Note that you will not be able
to edit the item if it is not assigned to you, however.
•
Search: Search for an item using the Search feature. You can then click
on an item in the search results to open it for editing (again assuming it is
assigned to you).
•
In-Context Editing: Browse for a page you wish to edit in the Preview
mode. Then click on the Edit tab to edit it. Again note that will not be
able to edit the item if it is not assigned to you.
If you are looking for existing information or components that you wish to use
on the current page in the Edit Form, either browse for the item in the Site
Map and then drag it to the appropriate field on the Edit Form, or use the
Search feature to locate the item that you wish to include on the current
page, and then drag the item from the search results pane onto the
appropriate field in the Edit Form. This is the most typical way to find, for
example, an image component if the user does not have permission to access
the Site Map.
We will next discuss the case in which a user creates a new page in more
detail.
Creating a New Page
Creating new pages is a simple task. To create a new page, locate the “New”
command button on the Toolbar, and click it with your left mouse button.
You will see a dialog like the following:
16
16
User’s Guide to the Author Client
Note: The dialog you see may differ depending on your group permissions. If
you have the permission to create pages from page types as well as from
rules, you will see a different dialog.
Type in a Name for your page. The name is only used to identify the page in
your Assignment list and the Site Map. In this example, we have called the
page “Visiting the Campus.”
Choose a page Rule. These Rules are the names of the Page Creation Rules
(PCRs) that have been configured for the group(s) you are a member of. PCRs
determine what page types your group is allowed to create, under what node
of the Site Map they will be created, and what workflow the page will be
bound to. In this example, we have chosen Admissions Page from among
three choices.
Click OK. You will now see a screen like the following, showing an empty Edit
Form awaiting content. Note that the new page was created automatically
under the Admissions section, which is where the Page Creation Rule
specified that it should go.
17
17
User’s Guide to the Author Client
There is some helpful information in the Status Bar at the top of the edit
form that the following information appears from left to right:
Page Name: Name of the page; in this case, Visiting the Campus.
Page ID: This is the ID automatically assigned by the system, and is
sometimes helpful for identifying pages. The ID is x469 in this case.
Assigned To: When a page is created, it is assigned to the person who
created it. The user who created the page was logged in under the user name
“User1: Author”.
Workstate: The workflow attached to this page specified that the initial
workstate is the Authoring state.
Comment: When a page is assigned, the assigner has an opportunity to add a
comment, which is displayed here. The comment “Existing page added to
workflow” is a system-generated comment.
Adding Content: the Edit Form
You are now ready to begin adding content. All you have to do is fill out the
relevant fields in the Edit Form. The items appear in the Edit Form depend on
what page type is being created, and on what types of information have been
included by the site designers for that type of page.
18
18
User’s Guide to the Author Client
For example, the first field on the new page created above is a simple text
box for the article title. To fill this out, simply type the desired title and
move to the next field. Note that this field says “Required” above it. This
means that the page cannot be published until a value is filled in.
Data Types
There are a number of different data types that may be found on the Edit
Form. How you enter a value depends on the data type. The most commonly
encountered data types for most content authors are plain text, formatted
text, and image or media components.
Plain text: Text that accepts no formatting. Text is usually entered by typing
directly into the field, or by dragging and dropping or cutting and pasting text
from another document or Web page. Text boxes will expand to
accommodate the length of the entry.
Formatted text (WYSIWYG): Text entered into the WYSIWYG control accepts
formatting (colors, fonts, backgrounds, bold, italic, underline, etc.), as well
as hyperlinks, images, tables, etc. Text can be typed directly in this control
or dragged and dropped from another source. The WYSIWYG control will be
described in detail later.
Components: Components are items in the content repository that
themselves are used on other pages, such as an image component, a link, or a
navigation component. They are typically entered by dragging and dropping
the desired item directly from the Site Map or Search Results page directly
into the data field.
Components will have an icon next to them that can be clicked in order to
edit the attributes of the component.
Access Levels
Fields on the Edit form may be designated as read-only on the schema,
meaning that they cannot be edited. They will show up as grayed out on the
Edit Form. Note also that the field entitled Main Navigation is grayed out,
which means it is read-only. Fields may also be designated as hidden, in
which case they will not show up at all.
Required Fields
Items on the Edit form may be marked Required, which means the page
cannot be published until a value is entered. Note that the Title and Abstract
field are designated as required in the above example. This is set by the site
administrator.
19
19
User’s Guide to the Author Client
Finishing Your Work
Check Spelling
Once you are satisfied with the content of your page, you may wish to check
spelling to make sure there are no obvious errors. Click the Spelling icon on
the main toolbar. If there are any misspellings, you will see a dialog like the
following:
The word highlighted in the Not in Dictionary field is the word not
recognized in the main dictionary. The highlighted word in the Suggestions
box is what the spelling checker suggests as a replacement. Most common
actions are Ignore (let the spelling stand) or Change (replace the word with
the highlighted word under Suggestions). For more information, see the
section on the Spelling Checker.
Preview
Now that you have checked your work, you will want to see how your page
will look on the web site. Toward the lower left corner of the Main Content
Area, locate and click the “Preview” tab. Your page will now appear in the
Main Content Area as it will appear on your web site. This is a very highfidelity preview—not only is the content rendered as it will be on the site,
but all navigation is completely functional as well.
Assign or Advance
The last step in the process is to assign the page to another user or to
advance it in workflow. Assigning the page to another user leaves the page in
its current workstate, but assigns it to another user in your group. Think of it
as an informal peer review—it gives you an opportunity to get input on your
work from a peer without advancing the page to, say, your supervisor.
Advancing the page sends it to the next workstate and to a member of the
group associated with that workstate.
Assign
To assign a page, click the Send To icon on the main toolbar. You will get a
dialog box like the one below:
20
20
User’s Guide to the Author Client
The top window will show all other users in your group. Users currently
logged into the system will be shown in blue. Highlight a name and type a
comment in the Comments field if desired. This comment will appear on the
right side of the status bar on the Edit form, and in the Notes field on the
Assignment list.
Note: If the page in question is not in workflow, the users in the Select User
dialog will be all users in the system. Users typically will not be using the
Author client, however, if pages are not in workflow.
Advance
To advance the page in workflow, click the workflow advance button on the
Main toolbar. The advance button will carry the caption(s) associated with
the allowed transitions from that point, such as Send for Approval or Send
Back to Author. If there is more than one transition available from any given
state, the button will appear as a dropdown combo button, with the other
choices available under the down arrow:
When you choose a transition from the dropdown, you will be prompted to
choose a particular user from the group associated with the workstate the
page is being transitioned to. The dialog box is identical to the dialog for
Send To shown above.
Next Steps
You are now done with this page. Notice that this page has now disappeared
from your assignment list. Next step: click on another item in your
21
21
User’s Guide to the Author Client
assignment list, use the Search function or In-Context Editing to find a page
you wish to edit, or create another new page. As you can see, working with
content in Ingeniux CMS is simple and fast.
We will explore the functionality of CMS Author in more detail in the next
section.
Author Client in Detail
Edit Form
The Edit Form is the workhorse of the CMS Author client. It is where nearly all
page-level data and metadata is entered. The key to understanding the Edit
Form is knowing what kind of data can be entered there.
Data Types
There are a number of different data types that may be found on the Edit
Form. How you enter a value depends on the data type. The allowed data
types are described below.
Plain text
Text that accepts no formatting. Text is usually entered by typing directly
into the field, or by dragging and dropping or cutting and pasting text from
another document or Web page. Text boxes will expand to accommodate the
length of the entry.
Formatted text (WYSIWYG)
Text entered into the WYSIWYG control accepts formatting (colors, fonts,
backgrounds, bold, italic, underline, etc.), as well as hyperlinks, images,
tables, etc. Text can be typed directly in this control or dragged and dropped
from another source. The WYSIWYG control will be described in detail below.
Dates
Dates can be filled in on the Edit Form by selecting a date from the date
picker control.
Enumerated lists
Displays as a dropdown list; user picks from the list.
Boolean values
Display as a checkbox; user checks/unchecks box.
Components
Components are items in the content repository that themselves are used on
other pages, such as an image component, a link, or a navigation component.
22
22
User’s Guide to the Author Client
They are typically entered by dragging and dropping the desired item directly
from the Site Map or Search Results page directly into the data field.
Components will typically have an icon next to them that can be clicked in
order to edit the attributes of the component.
Images and Media
When an image or media data type is encountered on the Edit Form, it
displays as a blank text box with a button beside it that opens the Image
Browser. The user picks an image from the Image Browser, which then
populates the field with the name of the image and displays it on the edit
form.
Read-Only and Hidden Fields
Fields on the Edit form may be read-only, meaning that they cannot be
edited. They will show up as grayed out on the Edit Form. Hidden fields will
not show up at all. These attributes are set at the schema level by the site
administrators and site designers.
Required Fields
Items on the Edit form may be marked Required, which means the page
cannot be published until a value is entered. This attribute is set at the
schema level by the site administrators and site designers.
Status Bar
Across the top of the Edit Form is a status bar that contains valuable
information about the state of the page.
Dragable Icon: This icon can be dragged to any allowable location in the tree
(e.g., the Recycle Bin). This prevents the user from having to endure long
scrolling operations if the Site Map is very large.
Page Name: Name of the page as it appears in the Site Map
Page ID: This is the ID automatically assigned by the system, and is
sometimes helpful for identifying pages. It is auto-incremented by the
system, so each successive page is a higher number. Numbers are not used
again even if a page is deleted
Assigned To: The login name of the person to whom the page is currently
assigned. Workstate: The current workstate of the active page.
Comment: When a page is assigned, the assigner has an opportunity to add a
comment, which is displayed here. The comment “Existing page added to
workflow” is a system-generated comment.
23
23
User’s Guide to the Author Client
Preview Pane
The Preview function in Ingeniux CMS is extremely high fidelity, since it uses
the same functionality as the CMS run-time server to render the page.
Navigation is completely functional, as are all links to internal and external
pages.
In-Context Editing
This highly functional Preview is what enables the In-Context Editing feature
of Ingeniux CMS. When you are clicking around in the navigation of the
Preview pane, note that whatever page you navigate to is also the page
highlighted in the Site Map, which means the page you navigate to is now the
active page in the Edit Form. So, to edit a page you navigate to, you need
only click on the Edit tab at the bottom of the work area.
Note, however, that you will generally not be able to edit a page you
navigate to unless it is assigned to you. If it is not, you may assign it to
yourself, assuming you have sufficient permissions to do so.
Folder/Child Pages View
If the active node (i.e., the selected node) in the Site Map has child nodes,
the Child Pages tab will be visible. Clicking on this tab will list the child
nodes in the main work area, including page ID, schema type, check in/out
status, marked for publish status, and who it is currently assigned to.
24
24
User’s Guide to the Author Client
If the number of items in the list exceeds the maximum number configured
by the site administrator, the More button will be active. If you wish to see
all of the results, click the All button.
If you wish to save this list, click the Save List button. This will invoke the
save dialog, which will allow you to save this list to your local machine as a
comma delimited file.
WYSIWYG Control
The WYSIWYG control allows you to produce formatted text that is saved as
HTML markup that can be read by browsers. Because the WYSIWYG control
does the work of translating your formatting into HTML behind the scenes,
you do not have to know HTML to use this tool. You simply choose the fonts,
sizes, colors, styles, etc., from the toolbar, and the WYSIWYG control handles
the rest.
You can type text into the WYSIWYG control, or drag and drop (or cut and
paste) information from other documents or Web pages. Once the text is in
the control, you can begin formatting.
Formatting Toolbar
When a page is in an editable state, the Formatting toolbar will appear across
the top of the WYSIWYG control. From left to right across the top of the
toolbar, you will find the following controls.
25
25
User’s Guide to the Author Client
Font
Clicking on the Font icon will invoke the Font dialog, as shown.
You can choose from available fonts, styles and sizes that are installed on
your computer. Keep in mind, however, that what end users will see is
determined by the fonts installed on their computers.
Preformatted Styles
There are over a dozen preformatted HTML styles that can be applied to text
in the WYSIWYG control. These styles can be found in the dropdown box on
the left side of the formatting toolbar. Text that is typed into the control is
assigned the Normal style by default, meaning that each paragraph is
wrapped in <P> tags, the HTML tag for a paragraph.
The style of a paragraph can be changed by placing the cursor anywhere in
the paragraph and then choosing a style from the dropdown list. For example,
choosing Heading 1 will wrap the paragraph in <H1> tags. When a browser
renders this paragraph, it will be assigned the browser's default style for a
top-level heading. Choosing Heading 2 will wrap the paragraph in <H2> tags,
and so on.
Other commonly used items from the dropdown are Bulleted List and
Numbered List. Applying these styles produces output like the following:
•
Item 1
•
Item 2
1.
Item 1
2.
Item 2
These list styles have the behavior that hitting the Enter key automatically
creates another list item. Hitting Enter twice takes you back to the Normal
26
26
User’s Guide to the Author Client
paragraph style. With the other predefined styles hitting the Enter key once
immediately creates a paragraph with the Normal style.
Bold, Italic, Underline
The next three items, Bold, Italic, and Underline, are familiar from any word
processing application. Simply highlight the text that you wish to style, and
click the appropriate icon.
Undo, Redo
Undo and Redo are also very familiar from other applications. The WYSIWYG
control allows unlimited levels of undo and redo on a page, tracking all
changes until the user navigates away from the page or checks the page in.
Undo and Redo act on each discreet operation, where each stretch of
unbroken typing is considered one contiguous operation. For example, if you
type 10 words and then bold one of the words and then type 10 more words,
clicking Undo will delete that last 10 words typed; the second click will undo
the bold.
Alignment
The next three icons affect the alignment of paragraphs, and act at the
paragraph level. The choices are Justify Left, Center, and Justify Right,
Justify To use, place the cursor in a paragraph, and click on the appropriate
icon.
Bulleted Lists, Numbered LIsts
The next two icons allow you to create bulleted and numbered lists. Place
the cursor in the desired paragraph and click the icon. This does exactly the
same thing as choosing Bulleted List and Numbered List from the dropdown
box of preformatted styles.
Outdent and Indent
The next two icons allow you to change the alignment of text, and act at the
paragraph level. The first outdents the current paragraph to the left; the
second indents the current paragraph to the right.
The use of outdent and indent in conjunction with bulleted and numbered
lists can produce interesting results, automatically changing the bullet style.
In the following bulleted list, the second item was indented once, and the
third twice.
•
Item 1
o
Item 2
Item 3
27
27
User’s Guide to the Author Client
Text Color and Background
The next two items on the formatting tool bar are Text Color and Background
color. These items act on selections. Select a section of text with the cursor
then make a color choice by clicking the Text Color icon. You will see a dialog
box like the one below. Choose a color from the palate and click OK.
To change the color of the font background, click the Background Color icon.
The dialog box is the same as above.
Inserting Hyperlinks
Hyperlinks can be inserted quickly and easily into the WYSIWYG control with
a few clicks of the mouse. Unlike Xpower Link components, however,
hyperlinks in the WYSIWYG field are not automatically updated if the asset
the hyperlink refers to is deleted, moved, or renamed, so they should be used
with caution.
To insert a hyperlink, first select a section of text. This is the text that will
be “hot.” Next, click on the Hyperlink icon on the Formatting toolbar, or
right-click and choose Hyperlink frm the context menu. You will see a dialog
like the following:
28
28
User’s Guide to the Author Client
Type: Choose the type of link protocol you want this hyperlink to use.
Usually, this will be http, and if nothing is explicitly chosen, http will be
assumed. Other choices are file, ftp, gopher, https, mailto, news, telnet, and
wais.
URL: This is the location of the page or other asset to be linked to. If the
page being linked to is another page in the current site, you may simply drag
and drop the page from the Site Map or Search Results, or type the XID of the
page as shown above.
If you are linking to an external page, click the button with three dots to the
right of the URL field. This will invoke a browser that will allow you to
navigate to any page on the Internet. When you have found the page you wish
to link to, click Save Address
Target: This determines the type of window that will be opened when the
user clicks on the hyperlink. For example, sometimes you may want the page
to open up in the same window as the parent page; other times you may want
a new browser to open so you can easily navigate between the two pages.
Here are the available choices:
_Blank: Opens URL in new browser instance.
_Top: Opens URL in top-most frame of current browser instance if frames
are used. If frames are not used, opens URL in same browser instance.
_Parent: Opens URL in the parent frame if frames are used. If frames are
not used, opens URL in same browser instance.
_Self: Opens URL in same frame as the hyperlink. If frames are not used,
opens URL in same browser instance.
29
29
User’s Guide to the Author Client
_Search: Opens URL in search window.
If no target is specified is in this field, the link is opened in the same browser
instance if no frames are used, or in the same frame if frames are used.
Bookmark: If a bookmark has been defined on the page you are linking to,
you can enter it here. The hyperlink will then take you directly to that
section of the document.
Unlinking. To unlink a hyperlink, right click on the text of the hyperlink and
choose Unlink.
Find
Clicking the binocular-shaped icon will invoke the Find dialog. Type the text
you wish to search for next to Find what and click Find Next. Check Match
whole word only if you want the match to be exact (e.g., if you want
“house” to match “house” but not “houses”. Check Match case if you only
want to find matches based on the exact capitalization of your search term.
Direction determines whether the search proceeds from the current location
of the cursor to the top of the document (Up) or to the end of the document
(Down).
Tables
To insert a table, click on the table icon on the far right of the toolbar. You
will see a dialog like the following:
30
30
User’s Guide to the Author Client
Rows and Columns: Specify the number of rows and columns the table will be
created with. You will be able to change this later.
Caption: Type a caption if desired. This will appear above the table.
Cell Attributes: You can enter any attribute that is relevant at the cell level,
such as ALIGN (LEFT, CENTER, RIGHT), VALIGN (TOP, MIDDLE, BOTTOM),
COLSPAN=n, ROWSPAN=n, NOWRAP.
Table Attributes: Enter any attributes that you wish to have act at the table
level here. Examples are Border, cellPadding, cellSpacing, and width. By
default, these four attributes are set to 1, 1, 1, and 75% respectively.
To edit an existing table, put the cursor in one of the cell and hit the down
arrow next to the table icon. You will see the following menu:
Insert Table: This inserts another table at the location of the cursor.
Insert Row: Inserts a row above the cursor
Delete Rows: Deletes row that the cursor is currently in.
Insert Column: Inserts column to left of cursor location.
Delete Columns: Deletes column that cursor is currently in.
Insert Cell: Inserts a cell in the current row to the left of the cursor.
Delete Cells: Deletes the current cell.
Merge Cells: Currently inoperative.
31
31
User’s Guide to the Author Client
Editing Source of WYSIWYG Control
On the context menu of the WYSIWYG Control there is a menu pick for editing
the HTML code that the WYSIWYG control produces. Click Edit Source… from
the menu will bring up an edit form like the following:
You can enter any valid HTML code in the HTML source window, and changes
made will immediately be reflected in the WYSIWYG control when saved. The
commands across the top are, from left to right: Save, Cut, Copy, Paste,
Delete, Undo/Redo, Find, Find and Replace.
Dragging and Dropping from other Applications
You can drag and drop (or copy and paste) data from all Microsoft Office
applications and many other applications as well. Native formatting is
preserved extremely well in most cases. The degree to which formatting is
preserved is dependent on how well the source application’s formatting is
preserved on the Windows clipboard, since the clipboard is the intermediary
between the source application and the Ingeniux WYSIWYG control.
For example, to copy an Excel spreadsheet into the WYSIWYG control, select
the cells that you want to copy, copy to the clipboard, and then paste into
the desired location in the WYSIWYG control. In the example below, the
selected cells are in blue:
32
32
User’s Guide to the Author Client
The data is then pasted into the control. Note that all formatting has been
preserved. This is because the HTML formatting instructions for each cell lie
nested within the formatting for the entire WYSIWYG control, and thus
override the top-level formatting instructions:
Often times it is desirable not to have formatting preserved in drag-and-drop
operations, so that the styles defined in the XSLT and Cascading Stylesheets
can be applied to enforce consistency of presentation. In such cases, it is
recommended that you first paste the data in a text-only editor such as
Notepad. This will strip all formatting from the copied information.
Using CSS to Control Formatting
It is highly recommended that you use Cascading Stylesheets (CSS) to
maintain a consistent design on all your pages. This is especially useful when
33
33
User’s Guide to the Author Client
you work with content in the WYSIWYG control, which allows you to make
arbitrary formatting and style choices.
You can use CSS to key off of the predefined styles on the Formatting toolbar
dropdown to help maintain consistency of style. For example, assume the
following entry exists in your CSS styles file:
FONT.H1
{
COLOR: #333333;
FONT: 11px/16px Verdana, Arial
}
Then anytime you want some text in your WYSIWYG control to have that
style, just highlight it, then click on the drop-down list, and select Heading 1.
This has the effect of wrapping that paragraph in <H1></H1> tags, which are
recognized by the CSS file.
You can reference styles that are not contained in the dropdown list as well.
Let's say you have the following CSS code in your XSL stylesheet:
<STYLE>
FONT.yourstyle
{
COLOR: #333333;
FONT: 11px/16px Verdana, Arial
}
</STYLE>
If you want the copy in the WYSIWYG control to have this style, you'll have to
edit the source and place a <font class="yourstyle"> tag in the beginning.
Working with Images and other Assets
Adding an image or other asset to a page is a two-part process: First, the
asset must be uploaded from the user’s local machine to the server that runs
Ingeniux CMS. Once it is there, it can be used repeatedly on other pages.
Uploading the Image
To add an image from your hard disk or other network location, click the
Upload icon from the main Toolbar. You will be prompted with a File dialog
where you can choose the image(s) you wish to import.
34
34
User’s Guide to the Author Client
Choose the type files to browse for in the Files of type dropdown. In this
example, we have chosen Image files.
Select the image(s) and be sure the image name(s) appears in the File name
box.
Choose the location on the server to upload the image to in the Upload to
dropdown. You will be able to choose from Images, Documents, Prebuilt,
Stylesheets, and Schemas, and any subdirectories of these. For organizational
purposes, subdirectories of these folders can be created by your system
administrator.
To create a component out of the uploaded image, check the Create
component checkbox. It is highly recommended that you create components
out of the assets you upload, for several reasons. If the asset is made into a
component, you will have the opportunity to add metadata that describes the
image (description, keywords, etc.). This will enable you to search on images
using the search function. It also means that the image will appear in the
content tree, as an item that can be dragged and dropped onto the edit form
or otherwise reused.
It is important to note that there must be a valid page creation rule in order
to create a component. These rules will need to be configured by the system
administrator.
Next, click Import. If the Create component box was checked, you will see a
dialog the following. This will give you an opportunity to add metadata about
the image that will help you later when searching for and organizing this
information.
Under Additional description, you may type a text description of the image.
This is the text that will appear as the alternate text during a mouseover of
the image. Under Keywords, you may enter multiple keywords, separated by
35
35
User’s Guide to the Author Client
comma. These keywords will be stored in the metadata of the component.
Under New image name, you may change the name of the image being
uploaded. By default, the name of the component will be the same as the
name of the image. Click OK to upload the image and create the component.
You will now be able to find this component in the Site Map (though you may
need to refresh the map first by clicking the Refresh icon). It will also appear
as assigned to you in your Assignment list, and, after the few moments it
takes to index the component, you will be able to find the image by searching
on any of the metadata associated with the component.
Inserting Images Components onto Pages
Now that your image component is created, you can access it in several ways
to use it on a page: via the Site Map, the Assignment list, or the Search
window (finding via the search function will be described in more detail
below). Once an image component has been located by any of these means,
it may be dragged and dropped into an image component field (if one exists)
on the Edit Form. Simply select it in the left column, and drag it into your
page. Dragging is accomplished by clicking and holding down the left mouse
button on the Image and dragging it to the Image field of the page. Once your
cursor is within the Image field, release the left mouse button.
You can also edit the attributes associated with this component. Clicking on
the component will open it in the edit form, where you will be allowed to
edit the metadata associated with the image.
Inserting Images into the WYSIWYG control
Images may also be inserted directly into the WYSIWYG control, whether or
not they exist as components. Simply place the cursor in the WYSIWYG
control where you want the image to appear. From the right click context
menu, choose Picture… You will see a dialog like the following (This is the
same dialog you will see under the properties button (…) next to the image
name if you view the component on the Edit form.):
36
36
User’s Guide to the Author Client
Browse for an image file on the server and highlight the image in the file list.
Make sure the name of the file appears under File name.
If you wish to reference an external image somewhere on the Internet, click
the URL radio button and enter the complete URL to the image. Click
Preview to see the image in the blue preview area.
In Alternate text, type a description of the image to be used as alternate
text. This is the same information as entered under Description when the
component was first created.
Layout: Under Layout, choose from the Alignment dropdown to specify how
the image will be aligned on the page and how text will wrap around the
image. For example, choosing Right will right align the image in the user’s
browser. Border sets the pixel width of the border around the image, if any.
This is set to 0 (none) by default.
Spacing: Horizontal and Vertical spacing sets the buffer, in pixels, around the
image. This determines how close the text that wraps around the image will
come to the image itself.
Size: By default, this is set to the native Height and Width of the image, in
pixels. This can be changed by editing the numbers, but it should be noted
that the proportions are not automatically kept. So, for example, if you wish
to shrink each dimension of the image by 20%, you need to multiply height
and width by .80 and enter the new values. You can also change the size of
the image by dragging the image boundary directly in the WYSIWYG control.
37
37
User’s Guide to the Author Client
Assignment List
The most usual way to work with content using the Author client is through
the Assignment list. The assignment list shows every item that has been
assigned to you by anyone else, along with any items you created yourself.
Pages are listed in chronological order, with the most recently assigned at
the top of the list. Any comments entered by the user who assigned the page
to you are in the second column of the Assignment list.
To work with an item in the list, simply click on the title of the page in the
list and it will populate the edit form, ready to edit. When you assign the
page to someone else, or advance it to another state, the item will disappear
from your list (unless, of course, you advanced it to a group you are a
member of and assigned it to yourself).
Site Map
Overview
Content in Ingeniux CMS resides on a central server in the Content Repository
(or Content Store), primarily in a single director. Though the content resides
in a single directory, logical hierarchical relationships between items in the
repository can be established via the Site Map (also referred to as the
Content Tree), in a manner very similar to what you see when browsing the
file structure on a hard drive.
The terminology to describe the relationship between items in the site map is
familiar: Any particular item in the content repository is known as a node.
Items that are one level above other node in the hierarchy are said to exhibit
a parent-child relationship; with the superior node called the parent node
and the subordinate node called the child. Nodes at the same level are said
to exhibit a sibling relationship. Any nodes hierarchically above a given node
are known as ancestors; and any nodes below are referred to as descendents.
38
38
User’s Guide to the Author Client
The structure of the content in the site map is usually strongly reflected in
the structure and navigation of the Web site. For example, in the Site Map
below, the page named Admissions has six child pages; and on the Web site,
that page has six links listing the articles that appear in that section. This is
called Child Navigation, and is one of the standard navigational types in
Ingeniux CMS.
Appearance of the Site Map
You can tell a great deal about the state
of various content items just by looking
at the Site Map.
Bold: Items in Bold are marked for
publish (i.e., approved for publish). In
the example above, the page Visiting the
Campus is not marked for publish, while
Financial Aid is.
Icons: If an icon is grayed out, like the
About Faber icon, it is checked in. If it is
in color, live the Research icon, it is
checked out. Icons also tell you
something about the type of item it is.
The Events icon is a folder, telling you
that Events is not a page, but merely a folder that contains other pages. If
the folder icon depicts and open folder, like the node Faber Public Site, that
merely means that node of the tree has been expanded.
Moving and Copying Pages in the Tree
It is easy to move or copy pages within the tree. To move a page, simply
hold your left mouse button over the page that you want and drag it to the
place where you want it. To copy the page, hold down the control key while
you drag the page.
There are two different modes for dragging a page in the tree: insert mode
and child mode. Insert mode places the page between two others; child
mode makes the page a child of the page it is dropped on.
The shape of the cursor tell you which mode you are in. If the cursor is a line,
the page will be inserted exactly at the location of the line. In the figure
below, if the cursor looks like the thin blue line, the page being dragged, in
this case Visiting the Campus, will be inserted after Directions to Campus,
still a child of Admissions.
39
39
User’s Guide to the Author Client
If the page being moved had been dragged a little further, the left end of the
cursor would outdent a bit more, showing that the page would be moved to
the location after Directions to Campus and before About Faber, but would
now be a peer of Admissions.
If the insertion mark highlights a page, the dropped page will be a child of
the page that it was dropped on. In the figure above, if the cursor looks like
the blue background behind the page Directions to Campus, the moved page
will be created as a child of that page.
Tip: Right clicking on a page and dragging it to a new location will open a
menu that will ask you whether you want to copy the page to the current
location or move the page to the current location.
40
40
User’s Guide to the Author Client
Whenever you attempt to move a page to a new location, you will see the
following dialog:
Choose Yes to continue the move operation, No to cancel. It is strongly
recommended that you do not turn this dialog off by checking the Don’t show
this to me again option.
The Context Menu
Right-clicking on an item in the tree will open the context menu. The context
menu in the Author client is identical to the context menu in the Admin
client, and will be discussed there in more detail.
The items that will appear in the menu depend on your
group permissions; for instance, if you don’t have the
permission to create a new page, the New menu item
will not appear.
Which menu items are active depends on the state of
the page. For example, if a page is Marked for Publish,
Unmark for Publish will be available and Mark for
Publish will be grayed out.
The context menu shown displays all available
functions. The functionality of the context menu in the
Author client is identical to the functionality of the
context menu in the Admin client, which is in some
cases slightly different than the equivalent functionality
provided by the toolbar in the Author client. The
various functions—and any differences between the two
clients--are described below.
New
Invokes the New dialog box, allowing the user to create new pages,
components, or folders. The example below shows a context menu for a user
that has no permissions except for the ability to create or edit a page.
41
41
User’s Guide to the Author Client
If the user has the right to create pages from page types as well as page
creation rules, the Create New Page dialog will look like the following:
If the user chooses the Use Page Creation Rules radio button, the dialog
behaves as described in the section on Working with Content. If the user
chooses the Use Page Type button, the Page Types section of the dialog
becomes active. A list of all available schema types appears in the Type
dropdown, and all stylesheets appear in the Layout dropdown. The default
layout is suggested automatically; this normally should not be changed.
Rename
Invokes the Rename dialog. A page can also be renamed by simply leftclicking on the page that already has focus in the Site Map.
42
42
User’s Guide to the Author Client
Refresh
Refreshes the Site Map and the Edit Form. This has the same function as the
Refresh button.
Cut
Cuts the current selection from the tree and puts it on the clipboard. The
icon of the page will change indicating that it is now cut from the Site Map,
but it will not disappear until the page is pasted to a new location or the tree
refreshed.
Copy
Copies the currently selected page to the clipboard.
Paste
Pastes the contents of the clipboard and creates a child page of the currently
selected page.
Delete
Deletes the currently selected page and sends it to the Recycle Bin.
Assign To…
Invokes the Assign To dialog. Identical to Toolbar command.
Advance…
Invokes the Advance Page in Workflow dialog. This combines the functions of
selecting a transition and selecting a user into one dialog.
43
43
User’s Guide to the Author Client
Under Allowed Transitions, choose a transition from the dropdown. Then
pick a user from the Users dropdown. Enter any Comments if desired, then
click Advance.
Show History
Invokes workflow history dialog.
Send Mail
Invokes Send Mail Dialog
Check In/Out
Checks the current page in if it is checked out; checks the current page out if
it is checked in. If the current page has children, you will be given the option
to check in/out the current page, or the current page and its children.
Undo Checkout
Reverses the checkout operation.
Rollback
Rolls back changes to the previously checked in version of the page.
Mark/Unmark for Publish
Marks the current page for publish if it is currently unmarked; unmarks it if it
is currently marked. If the current page has children, you will be given the
option to mark/unmark the current page, or current the page and its
children.
44
44
User’s Guide to the Author Client
Preview
Invokes the Admin client preview pane. See Admin Client documentation for
more details.
Publish
Invokes the Admin client publish dialog. See Admin Client documentation for
more details.
Properties
Invokes the Admin client Page Properties dialog. See Admin Client
documentation for more details.
Search
Ingeniux CMS boast robust full-text searching ability based on Microsoft Index
Server technology. Searches are fast and accurate.
Constructing a Query
To use search, click on the Search tab. You will see a dialog like the
following at the top of the Search page. Fill out the following fields as
described below.
Containing Text: Enter the term(s) you wish to search for. A logical OR is
assumed between multiple terms; thus, the search term environmental
research would return all articles that contain the word environmental and
all articles that contain the term research. You can use quotation marks to
specify an exact match; for example, “environmental research” will return
articles that specifically mention environmental research, but will not return
pages that merely contain the term research.
The scope of the search includes the entire xml file; that is, all data entered
by the user, all captions on the edit form, all xml tags, etc.
45
45
User’s Guide to the Author Client
Sort by: This determines the sort order of the results. The choices are Date
(newest item first), Date (oldest item first), Rank (most relevant first), and
Rank (least relevant first).
Search for: Determines the type of files to search. The choices are All,
Authors, Images, Media (audio and video files) and External Video. (Note:
Authors and External Video need special configuration by the site
administrator to be functional).
Where: Choose which site to search, or All, from the dropdown. The site
administrator will determine which sites are included in the search function.
Now click Search. You see your results set in the lower half of the search
pane. In the upper left of the Search pane, you will see the total number of
results for the search. The results are presented 25 at a time; to see the next
25, click Next >>; to see the previous 25, click << Previous.
To start a new search, click New…
Using the Search Results
The results of a search are used in two general ways: 1) To copy content from
a page that is returned by search, or to drag and drop a component returned
by search onto the Edit Form. These are described below.
Copying Content from Search
If you wish to copy content from a page returned by search to the current
page in the Edit Form, simply click on the desired item in the Search results.
That page will then open in the lower half of the main work area in the right
pane. In the example below, we have clicked on Admissions.
46
46
User’s Guide to the Author Client
With you mouse, highlight any text you wish to copy from any field in the
lower portion of the right pane. Drag it to the desired location on the Edit
Form of the active page in the upper half of the right pane, and drop it by
releasing the mouse button. The text will be copied to the active page.
Clicking Open on the status bar of the page in the lower pane will cause it to
become the active page in the Edit Form. If it is assigned to you and checked
out, you will be able to edit it.
Clicking the X icon on the right side of the status bar closes the window.
Adding Images Using Search
To add an image component or any other component to a page from the
Search window, perform a search that will return the desired items. In the
case below, “Images: was chosen from the Search For dropdown, so the
results are all images components.
Once you have located your image, you can either click the thumbnail to
preview to see a preview of it. If you click the image name, the component
will appear in the lower pane of the Edit Form. You may then open the
component for editing, or simply click and drag the component from the
search pane into an Image field of your page on the Edit Form.
Advanced Search Concepts
You can search for any word or phrase in the Content Store by typing the
word or phrase into the query form and clicking the button to execute the
47
47
User’s Guide to the Author Client
query. Searches produce a list of files that contain the word or phrase no
matter where they appear in the text. This list gives the rules for formulating
queries:
• Consecutive words are treated as a phrase; they must appear in the same
order within a matching document.
• Queries are case-insensitive, so you can type your query in UPPERCASE or
lowercase.
• You can search for any word except for those in the exception list (for
English, this includes a, an, and, as, and other common words), which are
ignored during a search.
• Words in the exception list are treated as placeholders in phrase and
proximity queries. For example, if you searched for “Permit for Vehicle”, the
results could give you “Permit for Vehicle” and “Permit and Vehicle”,
because for is a noise word and appears in the exception list.
• Punctuation marks such as the period (.), colon (:), semicolon (;), and
comma (,) are ignored during a search.
• To find all the forms of a compound word, use the hyphenated form of the
compound in your search. A common example is the word database, which is
a compound of data and base. Often, people are inconsistent in how they
create the compound, so forms such as data base and data-base will appear
in text. If you query for data-base, all instances of data-base, data base, and
database will be returned.
• You can insert Boolean operators (AND, OR, and NOT) and the proximity
operator (NEAR) to specify additional search information.
The search strings passed to Index Server follow standard Boolean logic.
Parentheses can be used to group search terms. Here is a sample query,
where all letters stand words:
(A OR B OR C) AND (X OR Y)
This query will return all items that contain either A, B, or C, and which also
contain either X or Y.
Logical ANDs take precedence over logical ORs, so without parentheses the
query would be processed like this:
A OR B OR (C AND X) OR Y
The pipe character can be used in place of Ors, so the query above could be
written:
(A | B | C) AND (X | Y)
48
48
User’s Guide to the Author Client
Spelling Checker
CMS Author comes with a spelling checker. Once you have finished adding
content to your page, you can click the Spelling icon on the toolbar to spellcheck your content.
Check Spelling Dialog
If the spelling checker finds words it does not recognize, you will see a dialog
box like the following:
You can use the dialog to specify whether the word should be ignored or
replaced. An explanation of the functions of this dialog follows.
Not in dictionary, Consider changing, or Capitalization box: Contains the
misspelled word. The label of this box changes with the type of problem
detected. Not in dictionary indicates that a misspelled word was detected;
the word is considered misspelled because it could not be located in any open
dictionaries. Consider changing indicates a word was encountered which was
marked with a conditional-change action in a user dictionary. Capitalization
indicates the word is spelled correctly but needs to be capitalized.
Suggestions list: Contains a list of suggested replacements for the word
reported as misspelled. Subsequent presses of the Suggest button may yield
more suggestions. The word selected in the Suggestions list will be used as
the replacement when the Change or Change All buttons are pressed, unless
the word in the problem box was edited.
Change button: Causes this occurrence of the reported word to be replaced.
If the problem word was edited, the edited word is used as the replacement.
Otherwise, the selected suggestion is used as the replacement. If the
reported word is one you frequently misspell, you might consider adding it to
a user dictionary via the User Dictionaries Dialog. You can display the User
Dictionaries dialog by selecting the Dictionaries button.
Change All button: Causes this and all following occurrences of the reported
word to be replaced with the word in the Change To box. If you want only
this occurrence of the word to be replaced, use the Change button. If the
reported word is one you frequently misspell, you might consider adding the
49
49
User’s Guide to the Author Client
misspelling and the correction to a user dictionary via the User Dictionaries
Dialog.
Ignore button: Causes this occurrence of a misspelled word to be skipped. If
the same misspelled word appears later, it will be reported.
Ignore All button: Causes this and all further occurrences of a misspelled
word to be skipped. You might use this button if the word reported as a
misspelling is actually spelled correctly. If the word is one you use
frequently, you may wish to ignore it permanently by selecting the Add
button.
Add button: Causes the reported word to be added to the dictionary selected
in the Add Words To list. Use the Add button if a correctly spelled word you
use often is reported as a misspelling (e.g., your family name). If the word is
not used frequently, you may want to select the Ignore or Ignore All buttons
instead.
Add Words To list: Indicates which user dictionary words will be added to
when you select the Add button. The Add Words To list shows all user
dictionaries currently open. You can also add words to user dictionaries via
the User Dictionaries Dialog, which is accessible by selecting the Dictionaries
button.
Suggest button: Search more thoroughly for suggested replacements for the
current misspelled word. Each time you press the Suggest button, a "deeper"
search is made. The Suggest button is disabled once all possible suggestions
have been located.
Undo button: Removes the last change made. The Undo button can be
pressed several times to remove the last several changes.
Undo Edit button: Remove any changes made to the text in the problem box.
This button appears only if the text in the problem box has been changed.
Cancel button: Stops the current spell-checking operation.
Dictionaries button: Causes the User Dictionaries Dialog to be displayed. You
can use the User Dictionaries dialog to edit the contents of user dictionaries.
Options button: Causes the Options dialog to be displayed. You can use the
Options dialog to set spelling-checker options.
Options Dialog
Clicking the Options… button causes the Options dialog to be displayed. You
can use the Options Dialog to specify various spelling-checker options. These
options affect the way the spelling checker operates.
50
50
User’s Guide to the Author Client
Ignore Capitalized Words: When enabled, any words beginning with a capital
letter are ignored (i.e., are skipped over without being checked). You might
enable this option if the text being checked contains many proper names.
Ignore All-Caps Words: When enabled, any words containing all capital
letters are ignored (i.e., are skipped without being checked). You might
enable this option if the text being checked contains many acronyms.
Ignore Words with Numbers: When enabled, any words containing embedded
digits are ignored (i.e., are skipped without being checked). Examples of such
words include "Win95" and "Q4." You might enable this option if the text being
checked contains many code-words or other symbols containing digits.
Ignore Words with Mixed Case: When enabled, any words containing an
unusual mixture of upper- and lower-case letters are ignored (i.e., are
skipped without being checked). Examples of such words include "MicroHouse"
and "CapsLock." You might enable this option if the text being checked
contains many variable names or other symbols which use case changes to
distinguish words.
Ignore Domain Names: When enabled, any words that appear to be Internet
domain names (such as wintertree-software.com) are ignored (i.e., are
skipped without being checked).
Catch Doubled Words: When enabled, any word appearing twice in a row is
reported via the Check-Spelling Dialog.
Case Sensitive: When enabled, a distinction is made between capitalized and
non-capitalized words. For example, "canada" is considered different from
"Canada", so "canada" would be reported as a misspelling. When the option is
disabled, "canada" and "Canada" are considered identical. Note that the
performance of the spelling checker will be reduced if this option is disabled.
51
51
User’s Guide to the Author Client
Auto Correct: When enabled, words marked with "Auto Change" actions will
automatically be changed to their specified replacements. When disabled,
you will be prompted before the words are changed.
Phonetic Suggestions: When enabled, suggestions are made on the basis of
phonetic (sounds-like) similarity to the misspelled word. This option tends to
improve suggestions for badly misspelled words. Enabling this option will
increase the time required to locate suggestions. Note that either this option
or the Typographical Suggestions option must be enabled or no suggestions
will be offered.
Typographical Suggestions: When enabled, suggestions are made on the
basis of typographical (looks-like) similarity to the misspelled word. This
option is appropriate for people who are generally good spellers. Note that
either this option or the Phonetic Suggestions option must be enabled or no
suggestions will be offered.
Suggest Split Words: When enabled, two separate words will be suggested as
a replacement for a misspelling containing two joined words. For example, "is
the" would be suggested as a replacement for "isthe".
OK button: Closes the Options Dialog, and saves any changes made to the
option settings.
Cancel button: Closes the Options Dialog, and discards any changes made to
the option settings.
Dictionaries Dialog
Clicking the Dictionaries… button invokes the User Dictionaries Dialog. This
dialog allows you to edit the contents of a custom user dictionary. The
contents of user dictionaries are saved in disk files on the local user’s
machine, in the Windows\System32 directory. This means that different users
can have different custom dictionaries.
52
52
User’s Guide to the Author Client
Action list: Used to select an action which is associated with words in the
dictionary. The action tells the spelling checker what to do when it finds a
word in the dictionary. The following actions can be selected:
•
Auto change (use case of checked word): This action allows you to
automatically replace one word with another. For example, if you often
type "recieve" instead of "receive", you might enter the word "recieve"
with "receive" as the other word and "Auto change (use case of checked
word)" as the action. The spelling checker will automatically correct
"recieve" wherever it appears. If "recieve" was capitalized ("Recieve") the
spelling checker would automatically replace it with "Receive". Note that
the replacement is made automatically only if the "Auto Change" option is
enabled (see the Options Dialog for information on the Auto Change
option).
•
Auto change (use case of other word): This action allows you to
automatically replace one word with another, always with the same case
pattern as the other word. This action is useful for automatically
expanding abbreviations. For example, you could enter the word "TBD"
with "to be determined" as the other word and "Auto change (use case of
other word)" as the action. The spelling checker will automatically
replace "TBD" with "to be determined" wherever it appears. Note that the
replacement is made automatically only if the "Auto Change" option is
enabled (see the Options dialog for information on the Auto Change
option).
•
Conditionally change (use case of checked word): This action allows you
to optionally replace one word with another. For example, if you often
type "recieve" instead of "receive", you might enter the word "recieve"
with "receive" as the other word and "Conditionally change (use case of
checked word)" as the action. The spelling checker will ask if you want to
replace "recieve" with "receive". If "recieve" was capitalized ("Recieve")
the spelling checker would ask if you wanted to replace it with "Receive".
•
Conditionally change (use case of other word): This action allows you to
optionally replace one word with another, always with the same case
pattern as the other word. This action is useful for optionally expanding
abbreviations. For example, you could enter the word "TBD" with "to be
determined" as the other word and "Conditionally change (use case of
other word)" as the action. The spelling checker will ask if you want to
replace "TBD" with "to be determined".
•
Exclude (treat as misspelled): This action tells the spelling checker that
the word is misspelled, even if it is listed in another dictionary. Words
marked with this action will never be offered as suggestions for
53
53
User’s Guide to the Author Client
misspelled words, and they will be reported as misspellings when they are
encountered by the spelling checker.
•
Ignore (skip): This action tells the spelling checker that the word is
spelled correctly, and so can be skipped over. This is the most common
action.
Add Word button: Causes the word entered in the edit area of the Words list
to be added to the currently selected dictionary. The currently selected
action and other word are associated with the word. You can use the Add
Word button to change the action or other word associated with a word. Note
that the Add Word button is enabled only when a new word is typed in the
edit area of the Words list. The words you add may contain virtually any
character, but only words which contain embedded periods should have
trailing periods (e.g., U.S.A. is OK, but USA. is not). Also, don't enter
possessive word forms (e.g., enter Mary, not Mary's).
Close button: Closes the Dictionaries dialog.
Delete Word button: Causes the word appearing in the edit area of the
Words list to be removed from the currently selected dictionary. The
associated action and other word are also removed.
User Dictionaries list: Contains the list of open dictionary files. When you
select a file from the list, its contents are displayed in the Words list.
Other Word box: Contains an alternate word associated with the currently
selected word. The other word is used in the "Auto change" and "Conditionally
change" actions to supply a replacement word. You can enter more than one
word in the Other Word box, but the total length should be limited to 63
characters.
Words list: Contains the list of words in the currently selected user
dictionary.
Next Steps
If you are using the Author Client in a capacity that requires you to manually
perform checkin/checkout, mark for publish, publish, or other high-level
operations that can only be found on the context menu, please refer the
User’s Guide to the Admin Client.
54
54