Merge pull request #9339 from g-pan/I544-Bookmks

IDE-544 Document IDE Bookmarks

Reviewed-By: Jim DeFabia <james.defabia@lexisnexis.com>
Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/HPCCClientTools/CT_Mods/CT_ECL_IDE.xml

@@ -1001,7 +1001,8 @@
                   </row>
 
                   <row>
-                    <entry><emphasis role="bold">Check out</emphasis></entry>
+                    <entry><emphasis role="bold">Checked
+                    out</emphasis></entry>
 
                     <entry>Check this box to only find ECL files that have
                     been checked out.</entry>
@@ -3179,6 +3180,47 @@ ENDMACRO;
         found on the <emphasis role="bold">Edit</emphasis> menu.</para>
       </sect2>
 
+      <sect2>
+        <title>Bookmarks</title>
+
+        <para>The ECL IDE supports internal bookmarks. Bookmarks provide a way
+        to mark a place that you can easily return to any time in the
+        future.</para>
+
+        <para>To create a <emphasis role="bold">bookmark</emphasis>, a
+        <emphasis role="bold">todo</emphasis>, or <emphasis
+        role="bold">hack</emphasis>, simply enter the appropriate code into
+        the place you want to mark, and save it. The syntax is in the form of
+        an ECL comment. Note that bookmarks ARE case-sensitive.</para>
+
+        <para>Bookmark syntax. Note the square brackets and that it is all
+        upper case.</para>
+
+        <programlisting>//[BM]</programlisting>
+
+        <para>To do syntax. Note that it is all upper case and terminated with
+        a colon.</para>
+
+        <programlisting>//TODO:</programlisting>
+
+        <para>Hack syntax. Note that it is all upper case and terminated with
+        a colon.</para>
+
+        <programlisting>//HACK:</programlisting>
+
+        <para>Enter the code into your workspace in the builder window then
+        save.</para>
+
+        <para><graphic fileref="../../images/IDE-BM01.jpg" />Your bookmark
+        appears in the bookmarks window right below your builder
+        window.</para>
+
+        <para><graphic fileref="../../images/IDE-BM02.jpg" /></para>
+
+        <para>To return to your bookmarked place, double-click on the
+        corresponding bookmark in the bookmarks panel.</para>
+      </sect2>
+
       <sect2 id="Results_Viewer">
         <title><emphasis>Results Viewer</emphasis></title>