Skip to content

Commit

Permalink
Update of contextual help documentation. Ticket #108. [#108 state:res…
Browse files Browse the repository at this point in the history
…olved]
  • Loading branch information
phillipadsmith committed Nov 4, 2009
1 parent 8845ff9 commit f1765b2
Show file tree
Hide file tree
Showing 47 changed files with 210 additions and 1,086 deletions.
2 changes: 1 addition & 1 deletion comp/help/en_us/about.html
Expand Up @@ -41,7 +41,7 @@
% $m->comp(".t_bottom");

% $m->comp(".t_top", caption => "License");
<p>Copyright (c) 2001-2002. About.com. Changes Copyright (c) 2001-2006
<p>Copyright (c) 2001-2002. About.com. Changes Copyright (c) 2001-2009
Kineticode, Inc. and others.</p>

<p>Redistribution and use in source and binary forms, with or without
Expand Down
14 changes: 10 additions & 4 deletions comp/help/en_us/admin/events/dhandler
@@ -1,7 +1,13 @@
<help page="Events Log">

<p>The &#8216;Log&#8217; for a Bricolage object shows a history of events
associated with it, such as when it was created, saved, or deleted.</p>
<p>The <em>Trail/Log</em> (also known as <q>Story Events</q>)
for a Bricolage object shows a history of events
associated with it. By default the story's events are filtered by
<em>Story Moved to Desk</em>, which shows the story's trail through
a workflow. The <em>Show all</em> link switches the view to show the
story's complete log of events, such as when it was created, saved,
or deleted. The <em>Customize</em> link can be used to limit the log
to show only certain types of events.</p>

<p>The table of events has the following columns:</p>

Expand All @@ -21,8 +27,8 @@
column will give the name of the desk it was moved to.</dd>
</dl>

<p>By default the events are shown in date order, starting with the oldest
events. Click on the title for one of the columns in the table to change
<p>By default the events are shown in date order, starting with the most recent
events. Click on the title for one of the columns in the table to change
the ordering.</p>

</help>
9 changes: 5 additions & 4 deletions comp/help/en_us/admin/manager/category.html
Expand Up @@ -5,10 +5,11 @@
create and edit new Categories in this area. Publishing content items in
multiple Categories can help to organize your site's components.</p>

<p><dl>
<dl>
<dt>Search</dt>
<dd>Searches Categories by name. Do a blank search to list all Categories or
click a letter for an alphabetical list.</dd>
<dd>Searches Categories by name. Do a blank search to list all Categories
<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
</dd>

<dt>Add a New Category</dt>
<dd>Click this link to create a new Category. It brings you to the Category
Expand All @@ -18,6 +19,6 @@
<dd>Click <em>Edit</em> to modify a Category's profile. Click <em>Log</em> to view
its event history. To delete a Category, check the Delete box, scroll
to the bottom of the page and click the <em>Delete Checked</em> button.</dd>
</dl></p>
</dl>

</help>
3 changes: 2 additions & 1 deletion comp/help/en_us/admin/manager/contrib.html
Expand Up @@ -8,7 +8,8 @@

<p><dl>
<dt>Search</dt>
<dd>Searches Contributors by name. Do a blank search to list all Contributors.
<dd>Searches Contributors by name. Do a blank search to list all Contributors
<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
You can also call up a list by letter or by Type.</dd>

<dt>Add a New Contributor</dt>
Expand Down
13 changes: 7 additions & 6 deletions comp/help/en_us/admin/manager/contrib_type.html
@@ -1,13 +1,14 @@
<help page="Contributor Type Manager">

<p>Contributor Types are used to classify Contributors by role, such as
&quot;Writer&quot; and &quot;Photographer.&quot; Once a Contributor Type has
<q>Writer</q>; and <q>Photographer.</q> Once a Contributor Type has
been created, a user can select it in the Contributor Profile page.</p>

<p><dl>
<dl>
<dt>Search</dt>
<dd>Searches Contributor Types by name. Do a blank search to list all
Contributor Types or click a letter for an alphabetical list.</dd>
Contributor Types<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
</dd>

<dt>Add a New Contributor Type</dt>
<dd>Click this link to create a new Contributor Type. It brings you to the
Expand All @@ -16,10 +17,10 @@

<dt>Existing Contributor Type</dt>

<dd>Click <i>Edit</i> to modify a Contributor
Type's profile. Click <i>Log</i> to view its event history. To delete a
<dd>Click <em>Edit</em> to modify a Contributor
Type's profile. Click <em>Log</em> to view its event history. To delete a
Contributor Type, check the Delete box, scroll to the bottom of the page and
click the <i>Delete Checked</i> button.</dd>
</dl></p>
</dl>

</help>
8 changes: 3 additions & 5 deletions comp/help/en_us/admin/manager/dest.html
Expand Up @@ -5,18 +5,17 @@
distributed to when it is published or previewed. Note that publishing
and moving (or in general, Actions) are done in separate phases.
Publishing runs the content of elements through
templates (this is called &quot;burning&quot;), storing the resulting
templates (this is called <q>burning</q>), storing the resulting
files (usually HTML) to a local staging directory.
Then later the &quot;distribution monitor&quot;, <code>bric_dist_mon</code>,
Then later the <q>distribution monitor,</q> <code>bric_dist_mon</code>,
causes the burned files to be moved from the staging
directory to destination servers.</p>

<p>
<dl>

<dt>Search</dt>
<dd>Searches active destinations by name. Do a blank search to list all
destinations.</dd>
destinations<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.</dd>

<dt>Add a New Destination</dt>
<dd>Click this link to create a new destination. It brings you to the
Expand All @@ -30,6 +29,5 @@
click the Delete Checked button.</dd>

</dl>
</p>

</help>
5 changes: 2 additions & 3 deletions comp/help/en_us/admin/manager/element_type.html
@@ -1,9 +1,8 @@
<help page="Element Type Manager">

<p>This is the Element Type Manager, where you create and edit Element Types.
Element Types are instances of Element Type Sets, and are the building blocks of
story and media documents. You should first read
<a href="http://bricolage.cc/docs/current/api/Bric::ElementAdmin" onclick="var newWin = window.open(this.href); newWin.focus(true); return false;">Bric::ElementAdmin</a>
Element Types are the building blocks of story and media documents.
You should first read <a href="http://bricolagecms.org/docs/current/api/Bric::ElementAdmin" onclick="var newWin = window.open(this.href); newWin.focus(true); return false;">Bric::ElementAdmin</a>
in order to understand how to plan your element hierarchy.</p>

<dl>
Expand Down
8 changes: 4 additions & 4 deletions comp/help/en_us/admin/manager/keyword.html
Expand Up @@ -2,7 +2,7 @@

<p>This is where you add, edit, or delete Keywords.</p>

<p><dl>
<dl>
<dt>Search</dt>
<dd>Searches active keywords by Keyword Name. You can also click one of
the letters or 'All'.</dd>
Expand All @@ -13,10 +13,10 @@
bottom of the page.</dd>

<dt>Existing Keywords</dt>
<dd>Click Edit to modify a keyword. Click Log to view the
<dd>Click Edit to modify a keyword. Click <em>Log</em> to view the
keyword's event history. To delete a keyword, check the Delete
box, then scroll to the bottom of the page and click the Delete Checked
box, then scroll to the bottom of the page and click the <em>Delete Checked</em>
button.</dd>
</dl></p>
</dl>

</help>
5 changes: 3 additions & 2 deletions comp/help/en_us/admin/manager/media_type.html
Expand Up @@ -6,8 +6,9 @@
<dl>

<dt>Search</dt>
<dd>Searches Media Types by name. Do a blank search to list all Media Types or
click a letter for an alphabetical list.</dd>
<dd>Searches Media Types by name. Do a blank search to list all Media Types
<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
</dd>

<dt>Add a New Media Type</dt>
<dd>Click this link to create a new Media Type. It brings you to the Media Type
Expand Down
16 changes: 10 additions & 6 deletions comp/help/en_us/admin/manager/output_channel.html
@@ -1,22 +1,26 @@
<help page="Output Channels Manager">

<p>Output Channels dictate the file extension and URI convention for your files. When you create templates, they will be associated with an output channel. Output channels in turn are associated with destinations for your files to be published to.</p>
<p>Output Channels dictate the file extension and URI convention for your files.
When you create templates, they will be associated with an output channel.
Output channels in turn are associated with destinations for your files to be
published to.</p>

<p><dl>
<dl>
<dt>Search</dt>
<dd>Searches Output Channels by name. Do a blank search to list all Output
Channels or click a letter for an alphabetical list.</dd>
Channels<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
</dd>

<dt>Add a New Output Channel</dt>
<dd>Click this link to create a new Output Channel. It brings you to the Output
Channel Profile page, where you will enter the channel's name and
description.</dd>

<dt>Existing Output Channels</dt>
<dd>Click <i>Edit</i> to modify an Output Channel's profile. Click <i>Log</i> to
<dd>Click <em>Edit</em> to modify an Output Channel's profile. Click <em>Log</em> to
view its event history. To delete a channel, check the Delete box,
scroll to the bottom of the page and click the <i>Delete Checked</i>
scroll to the bottom of the page and click the <em>Delete Checked</em>
button.</dd>
</dl></p>
</dl>

</help>
8 changes: 5 additions & 3 deletions comp/help/en_us/admin/manager/pref.html
Expand Up @@ -18,7 +18,8 @@
<dd>How the date and time are displayed.</dd>

<dt>Default Asset Sort</dt>
<dd>The default asset (story, media, and template) field to use for sorting on desks and in the various views of assets, such as <q>Find Stories.</q></dd>
<dd>The default asset (story, media, and template) field to use for sorting on
desks and in the various views of assets, such as <q>Find Stories.</q></dd>

<dt>Default Search</dt>
<dd>The default search, <q>Simple</q> or <q>Advanced,</q> to use in <q>Find Media,</q>
Expand All @@ -42,8 +43,9 @@
<dd>How people's names are displayed outside of lists.</dd>

<dt>Permissions Widget</dt>
<dd>The style of widget used in administering group permissions, either <q>Radio</q> or
<q>Select.</q></dd>
<dd>The style of widget used in administering group permissions, either
<q>Radio</q> or <q>Select.</q>
</dd>

<dt>Search Results / Page</dt>
<dd>The number of rows displayed per page in searches and on desks.</dd>
Expand Down
14 changes: 8 additions & 6 deletions comp/help/en_us/admin/manager/source.html
Expand Up @@ -9,19 +9,21 @@
content. Once you have created a Source, you can give it credit by selecting it
from a content item's Profile page.</p>

<p><dl>
<dl>
<dt>Search</dt>
<dd>Searches Sources by name. Do a blank search to list all Sources or click a
letter for an alphabetical list.</dd>
<dd>Searches Sources by name. Do a blank search to list all Sources
<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
</dd>

<dt>Add a New Source</dt>
<dd>Click this link to create a new Source. It brings you to the Source Profile
page.</dd>

<dt>Existing Sources</dt>
<dd>Click <i>Edit</i> to modify a Source's profile. Click <i>Log</i> to view its
<dd>Click <em>Edit</em> to modify a Source's profile. Click <em>Log</em> to view its
event history. To delete a Source, check the Delete box, scroll to the
bottom of the page and click the <i>Delete Checked</i> button.</dd>
</dl></p>
bottom of the page and click the <em>Delete Checked</em> button.
</dd>
</dl>

</help>
13 changes: 8 additions & 5 deletions comp/help/en_us/admin/manager/user.html
Expand Up @@ -5,25 +5,28 @@
example, if you want user Mary Jones to be allowed to edit stories, you'll go
to her user profile and enter her into a user group that has story editing
permissions.
Study <a href="http://bricolage.cc/docs/current/api/Bric::Security" onclick="var newWin = window.open(this.href); newWin.focus(true); return false;">Bric::Security</a> for details on permissions management.</p>
Study <a href="http://bricolagecms.org/docs/current/api/Bric::Security" onclick="var newWin = window.open(this.href); newWin.focus(true); return false;">Bric::Security</a> for details on permissions management.</p>

<dl>
<dt>Search</dt>
<dd>Searches active users by last name. Do a blank search to list all active
users.</dd>
users.
</dd>

<dt>Add a New User</dt>
<dd>Click this link to create a new user account. It brings you to the <q>User
Profile</q. page. Enter the requested information and then
click <em>Save</em> at the bottom of the page.</dd>
Profile</q>. page. Enter the requested information and then
click <em>Save</em> at the bottom of the page.
</dd>

<dt>Existing Users</dt>
<dd>Click <em>Edit</em> to modify an existing user. Click <em>Log</em> to view
the account's event history and <em>Log In</em> (if present) to masquerade
as another user (for example, to check in stories they left on their
workspace). To delete a user account, select the <q>Delete</q> checkbox,
scroll to the bottom of the page and click the <em>Delete Checked</em>
button.</dd>
button.
</dd>
</dl>

</help>
32 changes: 21 additions & 11 deletions comp/help/en_us/admin/manager/workflow.html
@@ -1,24 +1,34 @@
<help page="Workflow Manager">

<p>Here is where you create and edit Workflows, the management areas for content items. You can add new Workflows or change the existing ones to fit your site's needs.
<p>Here is where you create and edit Workflows, the management areas for content
items. You can add new Workflows or change the existing ones to fit your
site's needs.
</p>
<p>
Workflows organize the Content creation and editing process among a series of Desks. Every Workflow has one start Desk where all Content enters the Workflow. A Workflow also has one or more Publish Desks, from where Content can be sent to the Web Server. Content can be moved back and forth between Desks, the Shelf, and the Web Server. Workflows have two sections – Actions and Desks. Workflows are the drop down boxes on the left side of the screen.
<p>Workflows organize the Content creation and editing process among a series of
Desks. Every Workflow has one start Desk where all Content enters the Workflow.
A Workflow also has one or more Publish Desks, from where Content can be sent to
the Web Server. Content can be moved back and forth between Desks, the Shelf,
and the Web Server. Workflows have two sections &ndash; Actions and Desks.
Workflows are the drop down boxes on the left side of the screen.
</p>
<p><dl>

<dl>
<dt>Search</dt>
<dd>Searches Workflows by name. Do a blank search to list all Workflows or click
a letter for an alphabetical list.</dd>
<dd>Searches Workflows by name. Do a blank search to list all Workflows
<% get_pref('Show Alpha Search') ? ' or click a letter for an alphabetical list' : '' %>.
</dd>

<dt>Add a New Workflow</dt>
<dd>Click this link to create a new Workflow. It brings you to the Workflow
Profile page.</dd>
Profile page.
</dd>

<dt>Existing Workflows</dt>
<dd>Click <i>Edit</i> to modify a Workflow's profile. Click <i>Log</i> to view
<dd>Click <em>Edit</em> to modify a Workflow's profile. Click <em>Log</em> to view
its event history. To delete a Workflow, check the Delete box, scroll
to the bottom of the page and click the <i>Delete Checked</i>
button.</dd>
</dl></p>
to the bottom of the page and click the <em>Delete Checked</em>
button.
</dd>
</dl>

</help>
2 changes: 1 addition & 1 deletion comp/help/en_us/admin/profile/action.html
Expand Up @@ -10,7 +10,7 @@ <h3>Properties</h3>
<dl>
<dt>Type</dt>
<dd>The type of action which will be applied. The most commonly used
is &#8216;Move&#8217;, which does the actual copying or uploading to
is <em>Move</em>, which does the actual copying or uploading to
send output to a server.</dd>

<dt>Order</dt>
Expand Down
9 changes: 3 additions & 6 deletions comp/help/en_us/admin/profile/alert_type.html
Expand Up @@ -5,7 +5,6 @@

<p>When creating a new Alert Type:</p>

<p>
<dl>

<dt>Select an Object</dt>
Expand All @@ -24,14 +23,12 @@
button when you are ready to go on.</dd>

</dl>
</p>

<p>The last screen you encounter when creating a new Alert Type
is also the screen you use to edit existing Alert Types.
Here you can set rules, edit the alert contents, and designate
the alert recipients.</p>

<p>
<dl>

<dt>Properties</dt>
Expand Down Expand Up @@ -132,13 +129,13 @@
be sent alerts to each of those addresses.</dd>

</dl>
</p>


<p>When you are done, click the Save button at the bottom, or Cancel
to discard your changes. To delete the Alert Type, check the
&quot;Delete this Profile&quot; button and click Save.</p>
<em>Delete this Profile</em> button and click Save.</p>

<p>For more information on Alerts,
see <a href="http://bricolage.cc/docs/current/api/Bric::Alert" onclick="var newWin = window.open(this.href); newWin.focus(true); return false;">Bric::Alert</a>.</p>
see <a href="http://bricolagecms.org/docs/current/api/Bric::Alert" onclick="var newWin = window.open(this.href); newWin.focus(true); return false;">Bric::Alert</a>.</p>

</help>

0 comments on commit f1765b2

Please sign in to comment.