Menu
▾
▴
[Krang-CVS] [4605] Help documentation - more updates based on new buttons, and other corrections where I happened across them.
|
From: <no...@kr...> - 2007-12-25 04:07:50
|
Revision: 4605
Author: noam
Date: 2007-12-24 23:07:45 -0500 (Mon, 24 Dec 2007)
Log Message:
-----------
Help documentation - more updates based on new buttons, and other corrections where I happened across them.
Modified Paths:
--------------
trunk/krang/htdocs/help/media_edit.html
trunk/krang/htdocs/help/media_new.html
trunk/krang/htdocs/help/story_edit.html
trunk/krang/htdocs/help/template_edit.html
trunk/krang/htdocs/help/template_new.html
trunk/krang/templates/Template/edit.base.tmpl
Modified: trunk/krang/htdocs/help/media_edit.html
===================================================================
--- trunk/krang/htdocs/help/media_edit.html 2007-12-25 03:00:56 UTC (rev 4604)
+++ trunk/krang/htdocs/help/media_edit.html 2007-12-25 04:07:45 UTC (rev 4605)
@@ -2,11 +2,11 @@
<h2>Edit Media</h2>
<p>
-If you need to make any changes to your Media, whether it is the actual file or changing the default caption you will make these modifications on the Edit Media screen.
+If you need to make any changes to your media, whether to the actual file or the default caption, you will make these modifications on the Edit Media page.
</p>
<p>
-On the edit Media page, there are three parts:
+There are three parts of the Edit Media page:
</p>
<ol>
@@ -18,33 +18,33 @@
<h3>Properties</h3>
<p>
-The top area on the Edit Media page has the Media's properties. This information is not editable.
+The top area on the Edit Media page has the media's properties. This information is not editable.
</p>
<ul>
-<li><b>Id:</b> Media ID. Set by the CMS on creation of a New Media. This field cannot be changed.</li>
-<li><b>Current Version:</b> Field set by the CMS. This is a non-editable field, reflects the version number of the Media.</li>
-<li><b>Published Version:</b> Version of the Media that was last published. This may be different from the current version if changes were made to the Media after the last publish. This field is controlled automatically by the CMS.</li>
-<li><b>URL:</b> The URL field is controlled by the CMS. Although it appears as a non-editable field, it can be changed by modifying the fields that make up the URL. These fields are the site and category. </li>
-<li><b>Creation Date:</b> The date your Media was created. This field is set by the CMS and is not editable.</li>
+<li><b>Media Id:</b> Set by the CMS on creation of new media.</li>
+<li><b>Current Version:</b> Field set by the CMS. This reflects the version number of the media.</li>
+<li><b>Published Version:</b> Version of the media that was last published. This may be different from the current version if changes were made to the media after the last publish. This field is set automatically by the CMS.</li>
+<li><b>URL:</b> The URL field is also controlled by the CMS. Although it appears as a non-editable field, it can be changed by modifying the fields that make up the URL. These fields are the site and category. </li>
+<li><b>Creation Date:</b> The date your media was created.</li>
</ul>
<h3>Content</h3>
<p>
-Below the properties, is the content. This is where you specify information about your Media, such as its Site/Category and default caption.
+Below the Properties is the Content. This is where you specify information about your media, such as its Site/Category and default caption.
</p>
<ul>
-<li><b>Type:</b> Each Media has a Type. This is set by the CMS on creation of a New Media and is not an editable field. If you selected the incorrect Media Type, you will need to return to the New Media page. Media Type selection determines the attributes available to the Media.</li>
-<li><b>Title:</b> Required field used to give your image a unique name.</li>
-<li><b>Site/Categories:</b> Required field used to designate the URL of the site or category where you want to upload your media. Clicking the <i>Choose</i> button will launch a menu tree where you can find the correct category. From the menu tree click <i>OK</i> to accept your choice and close the function or <i>Cancel</i> to return to the New Media page.</li>
+<li><b>Type:</b> Each media file has a Type. This is set by the CMS on creation of new media and is not an editable field. If you selected the incorrect Media Type, you will need to return to the New Media page. Media Type selection determines the attributes available to the media.</li>
+<li><b>Title:</b> Required field used to give your media file a unique name.</li>
+<li><b>Site/Category:</b> Required field used to designate the URL of the site or category where you want to upload your media. Clicking the <i>Choose</i> button will launch a menu tree where you can find the correct category. From the menu tree click <i>OK</i> to accept your choice or <i>Cancel</i> to return to the New Media page.</li>
<li><b>Upload File:</b> If you would like to replace the current media content with a new file, click on <i>Browse</i> and find an item to upload.</li>
<li><b>Default Caption:</b> Text field where you can enter a default caption to associate with your media. This is an optional field and may not appear within the output depending on the template configuration.</li>
<li><b>Default Copyright:</b> Text field where you can enter a default copyright to associate with your media. This is an optional field and may not appear within the output depending on the template configuration.</li>
-<li><b>Alt Tag:</b> Text field where you can enter an alt tag to associate with your media. Alt tags are displayed on a web page when the image is not available or spoken by a screen reader.</li>
-<li><b>Notes:</b> Optional field where you can enter information about the image that will not be displayed in the story.</li>
+<li><b>Alt Tag:</b> Text field where you can enter an alt tag to associate with your media. Alt tags are displayed on a web page when the image is not available, or spoken by a screen reader.</li>
+<li><b>Notes:</b> Optional field where you can enter information about the media that will not be displayed in the story.</li>
<li><b>Version:</b> You can revert to a previously saved version. Select the version number from the drop-down and click on <i>Revert</i>. If you prefer, you can also <i>View</i> a previously saved version.</li>
-<li><b>Contributors:</b> A contributor can be any person, ex. Writer or photographer who contributed to the Media. Click on <i>Edit Contributors</i> to associate, or un-associate your contributors. See <a href="help.pl?topic=contributor_associate" class="helplink">Associate Contributors</a> for additional help.</li>
+<li><b>Contributors:</b> A contributor can be any person, for example a writer or photographer who contributed to the media. Click on <i>Edit Contributors</i> to associate, or un-associate your contributors. See <a href="help.pl?topic=contributor_associate" class="helplink">Associate Contributors</a> for additional help.</li>
<li><b>Content:</b> Starting with Krang v3.01, media files consisting of text content can be edited online rather than uploaded. (Images and other types of binary media will not show this field.)</li>
</ul>
@@ -56,12 +56,12 @@
<ul>
<li><b>Cancel:</b> Click on <i>Cancel</i> to discard any unsaved changes.<li>
-<li><b>Save:</b> Click on <i>Save</i> to save your Media. Clicking on this button will take you up a level to 'My Workspace'.</li>
-<li><b>Save & Stay:</b> Click on <i>Save & Stay</i> to save your Media, publish it to preview, and remain on the Edit Media screen.</li>
-<li><b>Publish:</b> Click on <i>Publish</i> and your Media is published immediately. If you would like to schedule your Media to publish at a later date. Click on <i>Schedule</i> at the top of the page. See <a href="help.pl?topic=schedule" class="helplink">Schedule Editor</a> for more information.</li>
-<li><b>Publish to Preview:</b> Click on <i>Publish to Preview</i> and your Media is published immediately to preview. (Starting with Krang v3.01, clicking Save & Stay will also trigger an automatic Publish-to-Preview.)</li>
+<li><b>Save & Stay:</b> Click on <i>Save & Stay</i> to save your media, publish it to preview, and remain on the Edit Media screen.</li>
+<li><b>Save:</b> Click on <i>Save</i> to save your media and return to your Workspace.</li>
+<li><b>Publish to Preview:</b> Click on <i>Publish to Preview</i> to publish your media immediately to the preview site. (Starting with Krang v3.01, clicking Save & Stay also triggers an automatic Publish-to-Preview.)</li>
+<li><b>Publish:</b> Click on <i>Publish</i> to publish your media immediately to the live site. If you would like to schedule your media to publish at a later date, click on <i>Schedule</i> at the top of the page. See <a href="help.pl?topic=schedule" class="helplink">Schedule Editor</a> for more information.</li>
-<li><b>Delete:</b> Click on <i>Delete</i> to delete your Media from the CMS.</li>
+<li><b>Delete:</b> Click on <i>Delete</i> to delete your media from the CMS.</li>
</ul>
<ul>
Modified: trunk/krang/htdocs/help/media_new.html
===================================================================
--- trunk/krang/htdocs/help/media_new.html 2007-12-25 03:00:56 UTC (rev 4604)
+++ trunk/krang/htdocs/help/media_new.html 2007-12-25 04:07:45 UTC (rev 4605)
@@ -1,26 +1,33 @@
<tmpl_include help_header.tmpl>
<h2>New Media</h2>
<p>
-The New Media page is used to upload or create media, such as images (.jpg, .gif) and video, for use in your stories. Any media that you want to display with your story has to be uploaded to Krang. Fields marked with an asterisk (*) are required fields and must be entered.
+The New Media page is used to upload or create media, such as images (.jpg, .gif) and video, for use in your stories. Any media that you want to display with your story has to be uploaded or created in Krang. Fields marked with an asterisk (*) are required fields and must be entered.
</p>
<ul>
-<li><b>Type:</b> Each Media has a Type. This is set by the CMS on creation of a New Media and is not an editable field. If you selected the incorrect Media Type, you will need to return to 'New Media.' Media Type selection determines the attributes available to the Media.</li>
+<li><b>Type:</b> Each media file has a Type. This is set by the CMS on creation of new media and is not an editable field. If you selected the incorrect Media Type, you will need to return to 'New Media.' Media Type selection determines the attributes available to the media.</li>
<li><b>Title:</b> Required field used to give your image a unique name.</li>
-<li><b>Site/Categories:</b> Required field used to designate the URL of the site or category where you want to upload your media. Clicking the <i>Choose</i> button will launch a menu tree where you can find the correct category. From the menu tree click <i>OK</i> to accept your choice and close the function or <i>Cancel</i> to return to the New Media page.</li>
+<li><b>Site/Categories:</b> Required field used to designate the URL of the site or category where you want to upload your media. Clicking the <i>Choose</i> button will launch a menu tree where you can find the correct category. From the menu tree click <i>OK</i> to accept your choice or <i>Cancel</i> to return to the New Media page.</li>
<li><b>Upload File:</b> Click on <i>Browse</i> to find an image or other media you would like to upload. This is a required field for binary types; otherwise you may leave it blank, and Krang will attempt to create an empty file named after your Title.</li>
<li><b>Default Caption:</b> Text field where you can enter a default caption to associate with your media. This is an optional field and may not appear within the output depending on the template configuration.</li>
<li><b>Default Copyright:</b> Text field where you can enter a default copyright to associate with your media. This is an optional field and may not appear within the output depending on the template configuration.</li>
<li><b>Alt Tag:</b> Text field where you can enter an alt tag to associate with your media. Alt tags are displayed on a web page when the image is not available or spoken by a screen reader.</li>
<li><b>Notes:</b> Optional field where you can enter information about the image. Notes are not displayed in a story.</li>
-<li><b>Contributors:</b> A contributor can be any person, ex. writer or photographer who contributed to the Media. Click on <i>Edit Contributors</i> to associate, or un-associate your contributors. See <a href="help.pl?topic=contributor_associate" class="helplink">Associate Contributors</a> for additional Help.</li>
+<li><b>Contributors:</b> A contributor can be any person, for example a writer or photographer who contributed to the media. Click on <i>Edit Contributors</i> to associate, or un-associate your contributors. See <a href="help.pl?topic=contributor_associate" class="helplink">Associate Contributors</a> for additional Help.</li>
</ul>
+After entering in the above information choose one of the buttons at the bottom of the page.
+
+<ul>
+
+<li><b>Cancel:</b> Click on <i>Cancel</i> to discard your new media.<li>
+<li><b>Save & Stay:</b> Click on <i>Save & Stay</i> to save your media, publish it to preview, and remain on the Edit Media screen.</li>
+<li><b>Save:</b> Click on <i>Save</i> to save your media and return to your Workspace.</li>
+<li><b>Publish to Preview:</b> Click on <i>Publish to Preview</i> to publish your media immediately to the preview site. (Starting with Krang v3.01, clicking Save & Stay also triggers an automatic Publish-to-Preview.)</li>
+<li><b>Publish:</b> Click on <i>Publish</i> to publish your media immediately to the live site. If you would like to schedule your media to publish at a later date, click on <i>Schedule</i> at the top of the page. See <a href="help.pl?topic=schedule" class="helplink">Schedule Editor</a> for more information.</li>
+
<p>
-After entering in the above information click on one of the buttons at the bottom of page. Clicking on <i>Save</i> will save your media and return you to your Workspace. <i>Save & Stay</i> will save your media and refresh the current page.
+
</p>
-<ul>
-<li><i>Reset</i> is also available. Resetting will delete all text from the text boxes on this page since the last Save.</li>
-</ul>
<tmpl_include help_footer.tmpl>
Modified: trunk/krang/htdocs/help/story_edit.html
===================================================================
--- trunk/krang/htdocs/help/story_edit.html 2007-12-25 03:00:56 UTC (rev 4604)
+++ trunk/krang/htdocs/help/story_edit.html 2007-12-25 04:07:45 UTC (rev 4605)
@@ -1,15 +1,15 @@
<tmpl_include help_header.tmpl>
<h2>Edit Story</h2>
<p>
-The Edit Story page is where you enter and edit all story content.
+The Edit Story page is where you enter and edit all Story content.
</p>
<p>
-The elements included on the Edit Story page are the body of your Story, such as paragraphs, images, and links to other stories.
+The elements included on the Edit Story page are the body of your Story, such as paragraphs, images, and links to other Stories.
</p>
<p>
-On the Edit Story page, there are four parts. They are:
+There are four parts of the Edit Story page. They are:
</p>
<ol>
@@ -36,13 +36,13 @@
<li><b>Current Version: </b> Field set by the CMS. This is a non-editable field, reflects the version number of the Story.</li>
<li><b>Published Version: </b>Version of the Story that was last published. This may be different from the Current Version if changes were made to the Story after the last publish. This field is controlled automatically by the CMS.</li>
<li><b>All Versions: </b>You can revert to a previously saved version. Select the version number from the drop-down and click on <i>Revert</i>. If you prefer, you can also <i>View</i> a previously saved version.</l>
-<li><b>Contributors: </b> A contributor can be any person, ex. Writer or photographer who contributed to the Story. Click on <i>Edit Contributors</i> to associate, or un-associate your contributors. See <a href="help.pl?topic=contributor_associate" class="helplink">Associate Contributors</a> for additional Help.</li>
+<li><b>Contributors: </b> A contributor can be any person, for example a writer or photographer who contributed to the Story. Click on <i>Edit Contributors</i> to associate, or un-associate your contributors. See <a href="help.pl?topic=contributor_associate" class="helplink">Associate Contributors</a> for additional Help.</li>
</ul>
<h3>Content</h3>
<p>
-Below the Properties box, is the Content box. This is where you give shape to the Story, by editing its existing elements and adding new ones. Each different Story type has its own set of elements -- some are automatically included and some are optional.
+Below the Properties box is the Content box. This is where you give shape to the Story, by editing its existing elements and adding new ones. Each different Story type has its own set of elements -- some are automatically included and some are optional.
</p>
<p>
Modified: trunk/krang/htdocs/help/template_edit.html
===================================================================
--- trunk/krang/htdocs/help/template_edit.html 2007-12-25 03:00:56 UTC (rev 4604)
+++ trunk/krang/htdocs/help/template_edit.html 2007-12-25 04:07:45 UTC (rev 4605)
@@ -2,7 +2,7 @@
<h2>Edit Template</h2>
<p>
-If you need to make any changes to your Template, you will make these modifications on the Edit Template screen.
+If you need to make any changes to your template, you will make these modifications on the Edit Template screen.
</p>
<p>
@@ -10,9 +10,10 @@
</p>
<ul>
-<li><b>Upload File:</b> Click on <i>Browse</i> to find a file on your computer. This is not required.</li>
-<li><b>Template code:</b> Create/edit your template directly in the CMS. Use this text box for code.</li>
-<li><b>Test with this template:</b> Check this box and you can test the template without deploying it and affecting stories being published.</li>
+<li><b>Upload File:</b> Click on <i>Browse</i> to find a file on your computer. This is not required, as the emplate can be edited directly in the CMS (see <i>Content</i>).</li>
+<li><b>All Versions:</b> You can revert to a previously saved version. Select the version number from the drop-down and click on <i>Revert</i>. If you prefer, you can also <i>View</i> a previously saved version.</li>
+<li><b>Content:</b> You can edit your template directly in the CMS. Use this text box for template code.</li>
+<li><b>Test:</b> Check this box and you can test the template without deploying it and affecting stories being published.</li>
</ul>
<h3>Actions</h3>
@@ -21,12 +22,12 @@
</p>
<ul>
-<li><b>Revert:</b> You can revert to a previously saved version. Select the version number from the drop-down and click on <i>Revert</i>. If you prefer, you can also View a previously saved version.</li>
-<li><b>Save:</b> Click on <i>Save</i> to save your Template. Clicking on this button will take you up a level to 'My Workspace'.</li>
-<li><b>Save & Stay:</b> Click on <i>Save & Stay</i> to save your Template and remain on the Edit Template screen.</li>
-<li><b>Deploy:</b> Click on <i>Deploy</i> and your template will be deployed. Templates that are deployed will be used to format Stories that are published. </li>
-<li><b>Reset:</b> Clicking on <i>Reset</i> will reset all text fields to last Saved version.</li>
-<li><b>Delete:</b> Click on <i>Delete</i> to delete your Template from the CMS.</li>
+
+<li><b>Cancel:</b> Click on <i>Cancel</i> to discard any unsaved changes.<li>
+<li><b>Save & Stay:</b> Click on <i>Save & Stay</i> to save your template and remain on the Edit Template screen.</li>
+<li><b>Save:</b> Click on <i>Save</i> to save your template and return to your Workspace.</li>
+<li><b>Deploy:</b> Click on <i>Deploy</i> to immediately deploy your template. Templates that are deployed will be used to format Stories that are published. </li>
+<li><b>Delete:</b> Click on <i>Delete</i> to delete your template from the CMS.</li>
</ul>
<p>
Modified: trunk/krang/htdocs/help/template_new.html
===================================================================
--- trunk/krang/htdocs/help/template_new.html 2007-12-25 03:00:56 UTC (rev 4604)
+++ trunk/krang/htdocs/help/template_new.html 2007-12-25 04:07:45 UTC (rev 4605)
@@ -3,19 +3,17 @@
<span class="helptitle">New Template</span> <br><br>
The New Template page is used to create new templates. Templates format the content in your CMS with HTML and other formatting languages.<br><br>
-To create a new Template, enter in the following fields:<br><br>
+To create a new template, enter the following fields:<br><br>
-<b>Element:</b> Select an element from the drop-down. The element should be related to the template. Elements are not required, you can create a template without selecting an element.<br>
+<b>Element:</b> Select an element from the drop-down. The element should be related to the template. This is an optional field: you can create a template without selecting an element.<br>
<b>Filename:</b> Name your template file. This field is not required if you upload a template file.<br>
-<b>Site/Categories:</b> Required field used to designate the URL of the site or category where you want to upload/create your Template. Clicking the Choose button will launch a menu tree where you can find the correct category. From the menu tree click <i>OK</i> to accept your choice and close the function or <i>Cancel</i> to return to the New Template page.<br>
-<b>Upload File:</b> Click on Browse to find a file on your computer. This is not required.<br>
-<b>Template code:</b> Create/edit your template directly in the CMS. Use this text box for code.<br>
-<b>Test with this template:</b> Check this box and you can test the template without deploying it and affecting stories being published.<br><br>
+<b>Site/Category:</b> This is a required field used to designate the URL of the site or category where you want to upload/create your template. Clicking the Choose button will launch a menu tree where you can find the correct category. From the menu tree click <i>OK</i> to accept your choice or <i>Cancel</i> to return to the New Template page.<br>
+<b>Upload File:</b> Click on <i>Browse</i> to find a file on your computer. This is not required, as the template can be created directly in the CMS (see <i>Content</i>).<br>
+<b>Content:</b> You can create your template directly in the CMS. Use this text box for template code.<br>
+<b>Test:</b> Check this box and you can test the template without deploying it and affecting stories being published.<br><br>
-After entering in the above information click on one of the Buttons at the bottom of page. Clicking on <i>Save</i> will save your Template and return you to your Workspace. <i>Save and Stay</i> will save your Template and refresh the current page.<br><br>
+After entering in the above information click on one of the Buttons at the bottom of the page. <i>Cancel</i> will discard your new template. <i>Save & Stay</i> will save your template and refresh the current page. <i>Save</i> will save your template and send you to your Workspace.<br><br>
<i>Deploy</i> will deploy the template to production. It is suggested that you test with your template before deploying.<br><br>
-<i>Reset</i> is also available. Resetting will delete all text from the text boxes on this page since the last Save. <i>Deploy</i> will Deploy the template to production. It is suggested that you test with your template before Deploying.<br><br>
+</div>
-<a href="#top">Back to the Top</a></div>
-
<tmpl_include help_footer.tmpl>
Modified: trunk/krang/templates/Template/edit.base.tmpl
===================================================================
--- trunk/krang/templates/Template/edit.base.tmpl 2007-12-25 03:00:56 UTC (rev 4604)
+++ trunk/krang/templates/Template/edit.base.tmpl 2007-12-25 04:07:45 UTC (rev 4605)
@@ -214,6 +214,7 @@
<!-- </h3> -->
<p class="full">
+<tmpl_lang CONTENT>
<textarea name="content" id="templateEditor" class="codepress html" rows="30" cols="60"><tmpl_var escape=html content></textarea>
</p>
|