Skip to content

Commit

Permalink
Update desk, workspace, and asset help.
Browse files Browse the repository at this point in the history 
Went to update the context-sensitive help to reflect yesterday's addition of the "and Revert" option in the "Check In" select lists, and found it pretty wanting. So I fixed it up for desks, My Workspace, and the main page for editing stories, media, and templates.

While I was at it, I changed the "Trail/Log" label on desk items to simply "Log".
  • Loading branch information
@theory
theory committed Jan 20, 2010
1 parent 8642f09 commit 8d5cd51
Show file tree
Hide file tree
Showing 6 changed files with 226 additions and 67 deletions.
61 changes: 40 additions & 21 deletions comp/help/en_us/workflow/profile/desk.html
View file
Expand Up @@ -40,36 +40,55 @@ <h3>Asset Properties (on Desks)</h3>

<dt>Check In</dt>
<dd>If you see this option, it means that you have checked the asset out from
this Desk to your Workspace. To let another user access and edit the asset,
you'll need to click this link to check the asset back in to the Desk.</dd>

<dt>Move to</dt>
<dd>This select menu moves the asset to another Desk. Select the desired Desk,
scroll to the bottom of the page and click <i>Move Assets.</i> You can move
more than one asset at a time. This select menu is not available if the
asset is checked out to another user.</dd>
this Desk to your Workspace. To let another user access and edit the
asset, you'll need to click this link to check the asset back in to the
Desk. Double-click to check in thes asset. Or click once to check in the
asset and then do something else with it, such as move it to another desk,
publish it (if you have permision), shelve it (to completely remove it
from workflow), or revert it (to revert all changes made since you checked
it out).</dd>

<dt>Move</dt>
<dd>This select menu moves the asset to another Desk. This select menu is not
available if the asset is checked out to another user.</dd>

<dt>Notes</dt>
<dd>View any editorial notes users have attached to the asset.</dd>

<dt>Trail/Log</dt>
<dd>Lists what Desks the asset has been checked in to or displays the asset's
event history</dd>

<dt>Edit</dt>
<dd>This option will only appear to you if the asset is checked out to your
Workspace.</dd>
<dd>If you see this link, you currently have the asset checked out. Click to
edit it.</dd>

<dt>View</dt>
<dd>Click to view the contents of an asset.</dd>

<dt>Notes</dt>
<dd>View any editorial notes have attached to the asset.</dd>

<dt>Clone</dt>
<dd>Create a duplicate of the story. Applies only to stories</dd>

<dt>Log</dt>
<dd>Lists what Desks the asset has been checked in to and displays the
asset's event history.</dd>

<dt>Delete</dt>
<dd>Deletes the asset. Note: deleting an asset does not expire (remove) the
asset from any of the destinations that it has been published to.
Deleted assets can be reactivated by using the <q>Include deleted</q>
option in the advanced search to find the asset, checking the
<q>Reactivate</q> checkbox beside the asset, and selecting <q>Checkout</q>
at the bottom of the search screen.</dd>

<dt>Publish</dt>
<dd>This checkbox is present only on Desks designated as Publish Desks. To
publish an asset, select this checkbox and click <i>Publish Checked</i> at
the bottom of the page. Multiple assets can be published at once.
<dd>This link is present only on Desks designated as Publish Desks. To
publish an asset, click this icon and select "Now" to immediate publish the document,
or "Later" to schedule publication for a later time.</dd>

<dt>Deploy</dt>
<dd>This checkbox is present only on Desks designated as Deploy Desks in
Template workflows. To deploy an asset, select this checkbox and click
<i>Deploy Checked</i> at the bottom of the page. Multiple templates can be
deployed at once.
<dd>This link is present only on Desks designated as Deploy Desks in Template
workflows. To deploy an asset, click this icon.</dd>

</dl></p>

</help>
88 changes: 64 additions & 24 deletions comp/help/en_us/workflow/profile/media.html
View file
Expand Up @@ -77,7 +77,7 @@ <h3>1) Information</h3>
<dd>The date and time the media document will be taken offline.</dd>
</dl>

<h3>2) Upload a File</h3>
<h3>2) The File</h3>
<dl>
<dt>File Path</dt>
<dd>Upload a media file. Click <em>Browse,</em> find the file on your computer
Expand Down Expand Up @@ -110,30 +110,70 @@ <h3>4) Output Channels</h3>
more output channels by selecting them from the select list, if there is
one.</p>

<h3>5) Associations</h3>
<dl>
<dt>Keywords</dt>
<dd>Enter any words or phrases relating to the media document's subject(s)
that will help tie it to other documents and also allow it to be found by
archive searches. Click <em>Edit</em> to get to the <q>Edit Keywords</q>
page, then type the keywords into the blank fields. You do not need to
fill in all of the keyword fields, but you can include as many additional
fields as you want by clicking <em>Add More.</em> When done,
click <em>Save.</em></dd>

<dt>Contributors</dt>
<dd>Manage the media document's producers, including any photographer or
illustrator who was involved in the creation of the Media.
Click <em>Edit</em> to get to the <q>Contributor Association</q> page.
Under <q>Choose Contributors,</q> find the person's name and
click <em>Associate.</em> On the next page, select his or her role and
click <em>Next.</em> When done, click <em>Save.</em></dd>
</dl>
<h3>5) Contributors</h3>
<p>Manage the media document's producers, including any photographer or
illustrator who was involved in the creation of the Media.
Click <em>Edit</em> to get to the <q>Contributor Association</q> page.
Under <q>Choose Contributors,</q> find the person's name and
click <em>Associate.</em> On the next page, select his or her role and
click <em>Next.</em> When done, click <em>Save.</em></p>

<p>Back on the Media Profile page, save the Media document to your Workspace
by clicking <em>Save.</em> Click <em>Save and Stay</em> to save the media document
and continue editing it. Select a previous version and click <em>View</em> to
see the previous version, or <em>Diff</em> to see a comparison of the previous
version to the current version.</p>
by clicking <em>Save.</em> Click <em>Save and Stay</em> to save the media
document and continue editing it. Select a previous version and
click <em>View</em> to see the previous version, or <em>Diff</em> to see a
comparison of the previous version to the current version.</p>

<h3>6) Keywords</h3>
<p>Enter any words or phrases relating to the media document's subject(s) that
will help tie it to other documents and also allow it to be found by
archive searches. Click <em>Edit</em> to get to the <q>Edit Keywords</q>
page, then type the keywords into the blank fields. You do not need to fill
in all of the keyword fields, but you can include as many additional fields
as you want by clicking <em>Add More.</em> When done,
click <em>Save.</em></p>

</dl>


<h3>Button Bar</h3>
<p>The button bar at the bottom of the media profile provides a number of
tools to assist with the editing of your document.</p>

<dl>
<dt>Delete this Media</dt>
<dd>Click this checkbox and then click "Save" to delete the media. Note:
deleting a media does not expire (remove) the media from any of the
destinations to which it has been published. Deleted stories can be
reactivated by using the <q>Include deleted</q> option in the advanced
search interface.</dd>

<dt>Check In</dt>
<dd>Select an option from the menu and check in the media. The menu options
include desks into which to check the media, as well as options to publish
the media (if you have permission), shelve it (to completely remove it
from workflow), or revert it (to revert all changes made since you checked
it out).</dd>

<dt>Revert</dt>
<dd>Select an earlier version of the media from the menu and click this button
to revert to that version. All changes made since that version were
created will be removed. If you'd like to see what earlier versions looked
like without reverting, select a version from the menu and click "View" to
see the contents of the earlier version, or click "Diff" to see a
change-tracking-style view of what has changed since the earlier
version.</dd>

<dt>Cancel</dt>
<dd>Cancel any changes made since the last time the media was saved and return
to My Workspace or to the desk from which the media was checked out.</dd>

<dt>Save and Stay</dt>
<dd>Save any changes but stay on the current screen in order to keep editing the media.</dd>

<dt>Save</dt>
<dd>Save any changes to the media and return to My Workspace or to the desk
from which the media was checked out.</dd>

</dl>
</help>
58 changes: 50 additions & 8 deletions comp/help/en_us/workflow/profile/story.html
View file
Expand Up @@ -128,19 +128,61 @@ <h3><% $i++ %>) Output Channels</h3>
<dd>Search for the categories you wish to include, they should appear as you
type. Click the <em>Add Category</em> button to add the selected category.</dd>
% }
<dt>Keywords</dt>
<dd>Enter any words or phrases relating to the story's subject(s) that will
help tie it to other documents and also allow it to be found by archive
searches. Enter the keyword you would like to associate with the story
and press the <em>Add</em> button.</dd>

<dt>Contributors</dt>
<dd>Manage the story's contributors, including any writer or editor who was
</dl>

<h3><% $i++ %>) Contributors</h3>
<p>Manage the story's contributors, including any writer or editor who was
involved in the creation of the story. Click the <em>Add</em> button to get
to the <q>Contributor Association</q> page. Under <q>Choose Contributors,</q>
find the person's name and click <em>Associate.</em> On the next page,
select his or her role and click <em>Next.</em> When done,
click <em>Save.</em></dd>
click <em>Save.</em></p>

<h3><% $i++ %>) Keywords</h3>
<p>Enter any words or phrases relating to the story's subject(s) that will
help tie it to other documents and also allow it to be found by archive
searches. Enter the keyword you would like to associate with the story
and press the <em>Add</em> button.</p>

<h3>Button Bar</h3>
<p>The button bar at the bottom of the story profile provides a number of
tools to assist with the editing of your document.</p>

<dl>
<dt>Delete this Story</dt>
<dd>Click this checkbox and then click "Save" to delete the story. Note:
deleting a story does not expire (remove) the story from any of the
destinations to which it has been published. Deleted stories can be
reactivated by using the <q>Include deleted</q> option in the advanced
search interface.</dd>

<dt>Check In</dt>
<dd>Select an option from the menu and check in the story. The menu options
include desks into which to check the story, as well as options to publish
the story (if you have permission), shelve it (to completely remove it
from workflow), or revert it (to revert all changes made since you checked
it out).</dd>

<dt>Revert</dt>
<dd>Select an earlier version of the story from the menu and click this button
to revert to that version. All changes made since that version were
created will be removed. If you'd like to see what earlier versions looked
like without reverting, select a version from the menu and click "View" to
see the contents of the earlier version, or click "Diff" to see a
change-tracking-style view of what has changed since the earlier
version.</dd>

<dt>Cancel</dt>
<dd>Cancel any changes made since the last time the story was saved and return
to My Workspace or to the desk from which the story was checked out.</dd>

<dt>Save and Stay</dt>
<dd>Save any changes but stay on the current screen in order to keep editing the story.</dd>

<dt>Save</dt>
<dd>Save any changes to the story and return to My Workspace or to the desk
from which the story was checked out.</dd>
</dl>

</help>
Expand Down
48 changes: 47 additions & 1 deletion comp/help/en_us/workflow/profile/template.html
View file
@@ -1,6 +1,6 @@
<help page="Template Profile Data">

<h3>1) Information</h4>
<h3>1) Information</h3>

<dl>
<dt>Trail</dt>
Expand Down Expand Up @@ -61,4 +61,50 @@ <h3>2) Template Code</h3>
<p>Enter additional code for the Template in the field provided. Click
<i>Save</i> when finished.</p>

<h3>3) Upload Template File</h3>
<p>If you'd rather download the template file to edit on your local computer,
rather than in the "Template Code" field, click the link here to download it.
You can then use the "Upload" field to upload the file once you've made your
changes.</p>

<h3>Button Bar</h3>
<p>The button bar at the bottom of the template profile provides a number of
tools to assist with the editing of your document.</p>

<dl>
<dt>Delete this Template</dt>
<dd>Click this checkbox and then click "Save" to delete the template. Note:
deleting a template does not expire (remove) the template from any of the
destinations to which it has been published. Deleted stories can be
reactivated by using the <q>Include deleted</q> option in the advanced
search interface.</dd>

<dt>Check In</dt>
<dd>Select an option from the menu and check in the template. The menu options
include desks into which to check the template, as well as options to publish
the template (if you have permission), shelve it (to completely remove it
from workflow), or revert it (to revert all changes made since you checked
it out).</dd>

<dt>Revert</dt>
<dd>Select an earlier version of the template from the menu and click this button
to revert to that version. All changes made since that version were
created will be removed. If you'd like to see what earlier versions looked
like without reverting, select a version from the menu and click "View" to
see the contents of the earlier version, or click "Diff" to see a
change-tracking-style view of what has changed since the earlier
version.</dd>

<dt>Cancel</dt>
<dd>Cancel any changes made since the last time the template was saved and return
to My Workspace or to the desk from which the template was checked out.</dd>

<dt>Save and Stay</dt>
<dd>Save any changes but stay on the current screen in order to keep editing the template.</dd>

<dt>Save</dt>
<dd>Save any changes to the template and return to My Workspace or to the desk
from which the template was checked out.</dd>
</dl>

</help>
36 changes: 24 additions & 12 deletions comp/help/en_us/workflow/profile/workspace.html
View file
Expand Up @@ -67,35 +67,47 @@ <h3>Asset Properties (on Workspace)</h3>
<dt>Output Channel</dt>
<dd>The output channel with which the template is associated. Output channels
generally define a collection of templates that output content to a
particular format, such as XHTML or RSS. Does not apply to documents</dd>
particular format, such as XHTML or RSS. Does not apply to documents.</dd>

<dt>Priority</dt>
<dd>Tells users how urgently the asset should move through workflow.</dd>

<dt>Check in</dt>
<dd>Select the desired desk (or <q>and shelf</q>, to remove the asset from
workflow) from this select list, scroll to the bottom of the page and
click <em>Check In Assets.</em> You can check in more than one asset at a
time.</dd>
<dd>Double-click to check in thes asset. Or click once to check in the asset
and then do something else with it, such as move it to another desk,
publish it (if you have permision), shelve it (to completely remove it
from workflow), or revert it (to revert all changes made since you checked
it out).</dd>

<dt>Notes</dt>
<dd>View any editorial notes users have attached to the asset.</dd>
<dt>Move</dt>
<dd>This select menu moves the asset to another Desk. This select menu is not
available if the asset is checked out to another user.</dd>

<dt>Trail/Log</dt>
<dd>Lists what Desks the asset has been checked in to and displays the
asset's event history.</dd>
<dt>Edit</dt>
<dd>If you see this link, you currently have the asset checked out. Click to
edit it.</dd>

<dt>View</dt>
<dd>Click to view the contents of an asset.</dd>

<dt>Notes</dt>
<dd>View any editorial notes have attached to the asset.</dd>

<dt>Clone</dt>
<dd>Create a duplicate of the story. Applies only to stories</dd>

<dt>Log</dt>
<dd>Lists what Desks the asset has been checked in to and displays the
asset's event history.</dd>

<dt>Delete</dt>
<dd>Deletes the asset. Note: deleting an asset does not expire (remove) the
asset from any of the destinations that it has been published to.
Deleted assets can be reactivated by using the <q>Include deleted</q>
option in the advanced search to find the asset, checking the
<q>Reactivate</q> checkbox beside the asset, and selecting <q>Checkout</q>
at the bottom of the search screen.
</dd>
at the bottom of the search screen.</dd>

</dl>

</help>
2 changes: 1 addition & 1 deletion comp/widgets/desk/desk_item.html
View file
Expand Up @@ -44,7 +44,7 @@
% if ($class eq 'story') {
<li><a href="/workflow/profile/workspace/clone/<% $id %>" title="<% $lang->maketext("Clone") %>"><img src="/media/images/clone.png" alt="<% $lang->maketext("Clone") %>" /><% $lang->maketext("Clone") %></a></li>
% }
<li style="margin-right: 1.2em;"><a href="/workflow/events/<% $class %>/<% $id %>?filter_by=<% $class %>_moved" title="<% $lang->maketext('Trail/Log') %>"><img src="/media/images/log.png" alt="<% $lang->maketext('Trail/Log') %>" /><% $lang->maketext('Trail/Log') %></a></li>
<li style="margin-right: 1.2em;"><a href="/workflow/events/<% $class %>/<% $id %>?filter_by=<% $class %>_moved" title="<% $lang->maketext('Log') %>"><img src="/media/images/log.png" alt="<% $lang->maketext('Log') %>" /><% $lang->maketext('Log') %></a></li>
% if ($can_edit) {
<li> <a name="<% ${class} %>_delete_ids" id="<% ${widget} %>_<% $id %>" title="<% $lang->maketext('Delete') %>" onclick="if (Desk.confirmDelete()) { Desk.request({ parameters: '<% ${widget} %>|delete_cb=<% ${class} %>_<% $id %>' }); Effect.Shrink('<% ${class} %>_<% $id %>'); } return false"> <img src="/media/images/trash.png" alt="Trash Can" />Delete</a> </li>
% }
Expand Down

0 comments on commit 8d5cd51

Please sign in to comment.