Parcourir la source

HPCC-14325 DOCS:Update Sect ID Attributes Prog. Guide

FIX HPCC-14325 DOCS:Update Sect ID Attributes Prog. Guide
Update Sect ID=Attributes where needed to harmonize with current doc. style

Signed-off-by: G Panagiotatos <greg.panagiotatos@lexisnexis.com>
G Panagiotatos il y a 9 ans
Parent
commit
a8a00dce81

+ 8 - 8
docs/ECLProgrammersGuide/PRG_Mods/PrG_Efficient_Value_TypeUsage.xml

@@ -17,7 +17,7 @@
     the values are integers or contain fractional portions (floating point
     data).</para>
 
-    <sect3>
+    <sect3 id="EfficientValue_IntegerData">
       <title><emphasis role="bold">Integer Data</emphasis></title>
 
       <para>When working with integer data, you should always specify the
@@ -66,7 +66,7 @@ INTEGER8   -9,223,372,036,854,775,808  0 to 18,446,744,073,709,551,615
       interfacing with external data sources, only.</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="EfficientValue_FloatingPoint">
       <title><emphasis role="bold">Floating Point Data</emphasis></title>
 
       <para>When using floating point types, you should always specify the
@@ -109,7 +109,7 @@ REAL8   15 (999999999999999)   1.797693e+308      2.225074e-308</programlisting>
     the case, then the selection is simple. However, deciding exactly which
     type of string type to use can be more challenging.</para>
 
-    <sect3>
+    <sect3 id="String_Data_String_vs_Varstring">
       <title><emphasis role="bold">STRING vs. VARSTRING</emphasis></title>
 
       <para>Data that comes in from or goes out to the “outside world” may
@@ -129,7 +129,7 @@ REAL8   15 (999999999999999)   1.797693e+308      2.225074e-308</programlisting>
       versus VARUNICODE.</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="String_Data_String_vs_QString">
       <title><emphasis role="bold">STRING vs. QSTRING</emphasis></title>
 
       <para>Depending on what use you need to make of your data, you may or
@@ -154,7 +154,7 @@ REAL8   15 (999999999999999)   1.797693e+308      2.225074e-308</programlisting>
       four).</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="StringData_FixedLength_vs_VariableLength_">
       <title><emphasis role="bold">Fixed Length vs. Variable Length
       Strings</emphasis></title>
 
@@ -192,7 +192,7 @@ STRING   CityName := 'Orlando';  // LENGTH(CityName) is 7</programlisting>
     <para>There are several ways you may define your own data types in ECL.
     The RECORD and TYPE structures are the most common.</para>
 
-    <sect3>
+    <sect3 id="EfficientData_RecordStructure">
       <title><emphasis role="bold">RECORD Structure</emphasis></title>
 
       <para>The RECORD structure can be likened to a
@@ -292,7 +292,7 @@ x := Accounts.AcctStruct.Balance;
       output for the CombineRecs TRANSFORM function.</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="EfficientData_TYPE_Structure">
       <title><emphasis role="bold">TYPE Structure</emphasis></title>
 
       <para>The TYPE structure is an obvious user-defined type because you are
@@ -342,7 +342,7 @@ OUTPUT(out);
       length stored as one to four bytes prepended to the data.</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="EfficientData_TypeDefAttributes">
       <title><emphasis role="bold">TypeDef Attributes</emphasis></title>
 
       <para>The TypeDef attribute is another obvious user-defined type because

+ 8 - 7
docs/ECLProgrammersGuide/PRG_Mods/PrG_query_libraries.xml

@@ -130,8 +130,9 @@ BUILD(FilterDsLib2);</programlisting>
     parameters passed for the instance in which you want to use it, which may
     be used to access the EXPORT attributes from the library.</para>
 
-    <sect3>
-      <title>Internal Libraries</title>
+    <sect3 id="RoxieQuery_InternalLibraries">
+      <title id="RoxieQueryLibrary_InternalLibraries">Internal
+      Libraries</title>
 
       <para>An internal library generates the library code as a separate unit,
       but then includes that unit within the query workunit. It doesn't have
@@ -177,7 +178,7 @@ OUTPUT(lib3.matches);
 OUTPUT(lib3.others);</programlisting>
     </sect3>
 
-    <sect3>
+    <sect3 id="RoxieQuery_ExternalLibraries">
       <title><emphasis role="bold">External Libraries</emphasis></title>
 
       <para>Once the library is implemented as an external library (using the
@@ -331,7 +332,7 @@ MyResults := LIBRARY(LibToUse, InterfaceCommonToBoth(args));
     libraries in the system are consistent. Here are some guidelines to use
     during your query library design phase:</para>
 
-    <sect3>
+    <sect3 id="RoxieQuery_SuggStructure_NamingConventions">
       <title>Naming Conventions</title>
 
       <para>I would also suggest coming up with a consistent naming convention
@@ -342,7 +343,7 @@ MyResults := LIBRARY(LibToUse, InterfaceCommonToBoth(args));
       Xlibrary, and X()).</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="RoxieQuery_SuggStructure_InterfaceToDefineParameters">
       <title>Use an INTERFACE to define parameters</title>
 
       <para>This mechanism (example shown below) provides documentation for
@@ -352,7 +353,7 @@ MyResults := LIBRARY(LibToUse, InterfaceCommonToBoth(args));
       following suggestions simpler.</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="RoxieQuery_SuggStructure_HideTheLibrary">
       <title>Hide the LIBRARY</title>
 
       <para>Making the LIBRARY function call a functional attribute (example
@@ -362,7 +363,7 @@ MyResults := LIBRARY(LibToUse, InterfaceCommonToBoth(args));
       code.</para>
     </sect3>
 
-    <sect3>
+    <sect3 id="RoxieQuery_SuggStructure_UseModuleInheritance">
       <title>Use MODULE Inheritance</title>
 
       <para>Use a MODULE structure (without the LIBRARY option) that

+ 7 - 7
docs/ECLProgrammersGuide/PrGd-Includer.xml

@@ -17,7 +17,7 @@
 
     <legalnotice>
       <para>We welcome your comments and feedback about this document via
-      email to <email>docfeedback@hpccsystems.com</email> </para>
+      email to <email>docfeedback@hpccsystems.com</email></para>
 
       <para>Please include <emphasis role="bold">Documentation
       Feedback</emphasis> in the subject line and reference the document name,
@@ -25,13 +25,13 @@
       message.</para>
 
       <para>LexisNexis and the Knowledge Burst logo are registered trademarks
-      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
       of LexisNexis Risk Data Management Inc.</para>
 
       <para>Other products, logos, and services may be trademarks or
-      registered trademarks of their respective companies. </para>
+      registered trademarks of their respective companies.</para>
 
       <para>All names and example data used in this manual are fictitious. Any
       similarity to actual persons, living or dead, is purely
@@ -58,7 +58,7 @@
     </mediaobject>
   </bookinfo>
 
-  <chapter>
+  <chapter id="ECL_Programming_Concepts">
     <title>ECL Programming Concepts</title>
 
     <xi:include href="ECLProgrammersGuide/PRG_Mods/PrG_Attribute_Creation.xml"
@@ -106,7 +106,7 @@
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
   </chapter>
 
-  <chapter>
+  <chapter id="WorkingWithSuperFiles">
     <title>Working With SuperFiles</title>
 
     <xi:include href="ECLProgrammersGuide/PRG_Mods/PrG_Superfile_Overview.xml"
@@ -126,7 +126,7 @@
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
   </chapter>
 
-  <chapter>
+  <chapter id="ProgGuide_WorkingWithRoxie">
     <title>Working With Roxie</title>
 
     <xi:include href="ECLProgrammersGuide/PRG_Mods/PrG_Roxie_Overview.xml"
@@ -158,7 +158,7 @@
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
   </chapter>
 
-  <chapter>
+  <chapter id="GettingThingsDone">
     <title>Getting Things Done</title>
 
     <xi:include href="ECLProgrammersGuide/PRG_Mods/PrG_Cartesian_Product_of_Two_Datasets.xml"