浏览代码

HPCC-16495 Edits based upon review

Signed-off-by: Jim DeFabia <jamesdefabia@lexisnexis.com>
Jim DeFabia 8 年之前
父节点
当前提交
69dd2837a4

+ 2 - 4
docs/VisualizingECL/Visualizing_Includer.xml

@@ -28,7 +28,7 @@
       of Reed Elsevier Properties Inc., used under license.</para>
       of Reed Elsevier Properties Inc., used under license.</para>
 
 
       <para>HPCC Systems<superscript>®</superscript> is a registered trademark
       <para>HPCC Systems<superscript>®</superscript> is a registered trademark
-      of LexisNexis Risk Data Management Inc.</para>
+      of LexisNexis Risk Data Managemenresul;t Inc.</para>
 
 
       <para>Other products, logos, and services may be trademarks or
       <para>Other products, logos, and services may be trademarks or
       registered trademarks of their respective companies.</para>
       registered trademarks of their respective companies.</para>
@@ -58,7 +58,6 @@
     </mediaobject>
     </mediaobject>
   </bookinfo>
   </bookinfo>
 
 
- 
   <xi:include href="VisualizingECL/VizMods/VizIntro.xml"
   <xi:include href="VisualizingECL/VizMods/VizIntro.xml"
               xmlns:xi="http://www.w3.org/2001/XInclude" />
               xmlns:xi="http://www.w3.org/2001/XInclude" />
 
 
@@ -75,6 +74,5 @@
               xmlns:xi="http://www.w3.org/2001/XInclude" />
               xmlns:xi="http://www.w3.org/2001/XInclude" />
 
 
   <xi:include href="VisualizingECL/VizMods/Any.xml"
   <xi:include href="VisualizingECL/VizMods/Any.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" /> 
-  
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
 </book>
 </book>

+ 1 - 1
docs/VisualizingECL/VizMods/Choropleth.xml

@@ -5,7 +5,7 @@
   <title><emphasis>Geospatial Methods</emphasis></title>
   <title><emphasis>Geospatial Methods</emphasis></title>
 
 
   <para>This section covers the Geospatial methods that create geographical
   <para>This section covers the Geospatial methods that create geographical
-  map visualizations contained in the Choropleth module. These methods depict
+  map visualizations contained in the Choropleth module. These methods project
   data onto maps using shading to depict values.</para>
   data onto maps using shading to depict values.</para>
 
 
   <para></para>
   <para></para>

+ 1 - 1
docs/VisualizingECL/VizMods/Methods.xml

@@ -5,7 +5,7 @@
   <title><emphasis>Methods</emphasis></title>
   <title><emphasis>Methods</emphasis></title>
 
 
   <para>Methods are categorized by the shape of the data they support. The
   <para>Methods are categorized by the shape of the data they support. The
-  categories are</para>
+  categories are:</para>
 
 
   <para><link linkend="VizTwoD">Two-Dimensional</link></para>
   <para><link linkend="VizTwoD">Two-Dimensional</link></para>
 
 

+ 1 - 1
docs/VisualizingECL/VizMods/TwoD.xml

@@ -382,7 +382,7 @@ viz_Summary;
     </informaltable>
     </informaltable>
 
 
     <para>The <emphasis role="bold">WordCloud </emphasis>visualization method
     <para>The <emphasis role="bold">WordCloud </emphasis>visualization method
-    creates a word cloud chart from two-dimensional data. A WordClous is
+    creates a word cloud chart from two-dimensional data. A WordCloud is
     weighted word list in visual design. It is a visual representation for
     weighted word list in visual design. It is a visual representation for
     text data, typically used to depict the weight or importance of words by
     text data, typically used to depict the weight or importance of words by
     the font size or color.</para>
     the font size or color.</para>

+ 43 - 27
docs/VisualizingECL/VizMods/VizIntro.xml

@@ -29,18 +29,16 @@
   <sect1 id="VizInstall">
   <sect1 id="VizInstall">
     <title>Installation</title>
     <title>Installation</title>
 
 
-    <para>The Visualization bundle is an open-source add-on to the HPCC
-    platform to allow you to create visualizations from the results from
-    queries written in ECL.</para>
-
-    <para>To install, use the ecl command line interface.</para>
+    <para>To install the Visualization bundle, use the ecl command line
+    interface.</para>
 
 
     <para></para>
     <para></para>
 
 
     <para><programlisting>ecl bundle install https://github.com/hpcc-systems/Visualizer.git</programlisting></para>
     <para><programlisting>ecl bundle install https://github.com/hpcc-systems/Visualizer.git</programlisting></para>
 
 
-    <para>To use the "ecl bundle install &lt;git url&gt;" command, git must be
-    installed on your machine and accessible to the user (in the path).</para>
+    <para>To use the "ecl bundle install &lt;git url&gt;" command, you must
+    have git installed and configured on your system. Git must be accessible
+    to the user (in the path).</para>
 
 
     <para></para>
     <para></para>
   </sect1>
   </sect1>
@@ -51,6 +49,29 @@
     <para>Once installed, you merely IMPORT the library, then call any method
     <para>Once installed, you merely IMPORT the library, then call any method
     that is appropriate for your data shape.</para>
     that is appropriate for your data shape.</para>
 
 
+    <para>Creating a basic visualization typically requires the following
+    steps: </para>
+
+    <para><orderedlist>
+        <listitem>
+          <para>Creation of a suitable dataset.</para>
+        </listitem>
+
+        <listitem>
+          <para>Output the dataset with a suitable name, so that visualization
+          can locate the data. </para>
+        </listitem>
+
+        <listitem>
+          <para>Create (and output) a the visualization, referencing the named
+          output from step 2. </para>
+        </listitem>
+      </orderedlist></para>
+
+    <para>To change the appearance of the visualization, dermatology
+    properties can be provided while creating the visualization or can be
+    applied at runtime via the live dermatology property editor.</para>
+
     <para>For Example:</para>
     <para>For Example:</para>
 
 
     <programlisting format="linespecific">IMPORT Visualizer;
     <programlisting format="linespecific">IMPORT Visualizer;
@@ -74,42 +95,42 @@ viz_bubble;
 
 
     <graphic fileref="../../images/viz10.jpg" />
     <graphic fileref="../../images/viz10.jpg" />
 
 
-    <para> </para>
+    <para></para>
 
 
     <para>See <link linkend="VizMethods">Methods</link> for details about the
     <para>See <link linkend="VizMethods">Methods</link> for details about the
     categories of visualization methods and all available methods.</para>
     categories of visualization methods and all available methods.</para>
-
-    <para></para>
-
-    <para></para>
   </sect1>
   </sect1>
 
 
   <sect1 id="VizViewing">
   <sect1 id="VizViewing">
     <title>Viewing the Visualization</title>
     <title>Viewing the Visualization</title>
 
 
     <para>After running a query with a visualization included, you can see the
     <para>After running a query with a visualization included, you can see the
-    visualization in ECL Watch.</para>
+    visualization in ECL Watch. Visualizations are appended to the workunit as
+    additional <emphasis>resources</emphasis> and can be viewed from the
+    <emphasis role="bold">Resources</emphasis> tab on the Workunit Details
+    page.</para>
 
 
     <para>Open the workunit, then select the <emphasis
     <para>Open the workunit, then select the <emphasis
     role="bold">Resources</emphasis> tab.</para>
     role="bold">Resources</emphasis> tab.</para>
 
 
     <para><graphic fileref="../../images/viz07.jpg" /></para>
     <para><graphic fileref="../../images/viz07.jpg" /></para>
-
-    <para></para>
   </sect1>
   </sect1>
 
 
   <sect1 id="VizDermProp">
   <sect1 id="VizDermProp">
     <title>Dermatology Properties</title>
     <title>Dermatology Properties</title>
 
 
     <para>The dermatology layer provides a means of setting properties for the
     <para>The dermatology layer provides a means of setting properties for the
-    manner in which a visualization appears. </para>
+    manner in which a visualization appears. For example, you can change the
+    palletteID to a new color scheme. After running a query with a
+    visualization included, it can be viewed within ECL Watch.</para>
 
 
-    <para>For example, you can change the palletteID to a new color scheme.
-    After running a query with a visualization included, you can see the
-    visualization in ECL Watch.</para>
+    <para>The <emphasis role="bold">Dermatology Editor</emphasis> lets you
+    alter the appearance of the visualization after it has been executed. The
+    same properties can also be specified in the ECL when creating the
+    visualization.</para>
 
 
-    <para>You can set properties in your ECL code or afterwards in ECL Watch:
-    </para>
+    <para>You can set properties in your ECL code or afterwards in ECL
+    Watch:</para>
 
 
     <orderedlist>
     <orderedlist>
       <listitem>
       <listitem>
@@ -119,8 +140,7 @@ viz_bubble;
 
 
       <listitem>
       <listitem>
         <para>Press the <emphasis role="bold">Properties</emphasis> button.
         <para>Press the <emphasis role="bold">Properties</emphasis> button.
-        Open the workunit, then select the <emphasis
-        role="bold">Resources</emphasis> tab.</para>
+        <emphasis role="bold"></emphasis></para>
 
 
         <graphic fileref="../../images/viz08.jpg" />
         <graphic fileref="../../images/viz08.jpg" />
       </listitem>
       </listitem>
@@ -138,9 +158,5 @@ viz_bubble;
     </orderedlist>
     </orderedlist>
 
 
     <para></para>
     <para></para>
-
-    <para></para>
-
-    <para></para>
   </sect1>
   </sect1>
 </chapter>
 </chapter>