axlsx 1.0.10 → 1.0.11

data/doc/Axlsx/Override.html

@@ -94,9 +94,10 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>An override content part. These parts are automatically created by for you
-based on the content of your package.</p>
+    <p>
+An override content part. These parts are automatically created by for you
+based on the content of your package.
+</p>
 
 
   </div>
@@ -128,8 +129,9 @@ based on the content of your package.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>The type of content.</p>
+    <span class="summary_desc"><div class='inline'><p>
+The type of content.
+</p>
 </div></span>
   
 </li>
@@ -154,8 +156,9 @@ based on the content of your package.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>The name and location of the part.</p>
+    <span class="summary_desc"><div class='inline'><p>
+The name and location of the part.
+</p>
 </div></span>
   
 </li>
@@ -192,8 +195,9 @@ based on the content of your package.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Creates a new Override object.</p>
+    <span class="summary_desc"><div class='inline'><p>
+Creates a new Override object.
+</p>
 </div></span>
   
 </li>
@@ -215,8 +219,9 @@ based on the content of your package.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Serializes the Override object to xml.</p>
+    <span class="summary_desc"><div class='inline'><p>
+Serializes the Override object to xml.
+</p>
 </div></span>
   
 </li>
@@ -237,8 +242,9 @@ based on the content of your package.</p>
   
 </p><div class="docstring">
   <div class="discussion">
-    
-<p>Creates a new Override object</p>
+    <p>
+Creates a new Override object
+</p>
 
 
   </div>
@@ -259,8 +265,9 @@ based on the content of your package.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>a customizable set of options</p>
+        <div class='inline'><p>
+a customizable set of options
+</p>
 </div>
       
     </li>
@@ -305,9 +312,10 @@ based on the content of your package.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>An argument error is raised if both PartName and ContentType are not
-specified.</p>
+        <div class='inline'><p>
+An argument error is raised if both PartName and ContentType are not
+specified.
+</p>
 </div>
       
     </li>
@@ -359,8 +367,9 @@ specified.</p>
   
 </p><div class="docstring">
   <div class="discussion">
-    
-<p>The type of content.</p>
+    <p>
+The type of content.
+</p>
 
 
   </div>
@@ -415,8 +424,9 @@ specified.</p>
   
 </p><div class="docstring">
   <div class="discussion">
-    
-<p>The name and location of the part.</p>
+    <p>
+The name and location of the part.
+</p>
 
 
   </div>
@@ -475,8 +485,9 @@ specified.</p>
   
 </p><div class="docstring">
   <div class="discussion">
-    
-<p>Serializes the Override object to xml</p>
+    <p>
+Serializes the Override object to xml
+</p>
 
 
   </div>
@@ -495,8 +506,9 @@ specified.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>The document builder instance this objects xml will be added to.</p>
+        <div class='inline'><p>
+The document builder instance this objects xml will be added to.
+</p>
 </div>
       
     </li>
@@ -531,7 +543,7 @@ specified.</p>
 </div>
     
     <div id="footer">
-  Generated on Wed Nov 30 08:53:49 2011 by 
+  Generated on Mon Dec  5 14:21:11 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.8.7).
 </div>

data/doc/Axlsx/Package.html

@@ -94,10 +94,11 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Package is responsible for managing all the bits and peices that Open
+    <p>
+Package is responsible for managing all the bits and peices that Open
 Office XML requires to make a valid xlsx document including valdation and
-serialization.</p>
+serialization.
+</p>
 
 
   </div>
@@ -136,31 +137,9 @@ serialization.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Initializes your package.</p>
-</div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#ruport_table-instance_method" title="#ruport_table (instance method)">- (Object) <strong>ruport_table</strong>(table) </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Accepts a ruport table for serialization to xlsx.</p>
+    <span class="summary_desc"><div class='inline'><p>
+Initializes your package.
+</p>
 </div></span>
   
 </li>
@@ -182,8 +161,9 @@ serialization.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Serialize your workbook to disk as an xlsx document.</p>
+    <span class="summary_desc"><div class='inline'><p>
+Serialize your workbook to disk as an xlsx document.
+</p>
 </div></span>
   
 </li>
@@ -205,8 +185,9 @@ serialization.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Validate all parts of the package against xsd schema.</p>
+    <span class="summary_desc"><div class='inline'><p>
+Validate all parts of the package against xsd schema.
+</p>
 </div></span>
   
 </li>
@@ -228,8 +209,9 @@ serialization.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>The workbook this package will serialize or validate.</p>
+    <span class="summary_desc"><div class='inline'><p>
+The workbook this package will serialize or validate.
+</p>
 </div></span>
   
 </li>
@@ -271,8 +253,9 @@ serialization.</p>
   
 </p><div class="docstring">
   <div class="discussion">
-    
-<p>Initializes your package</p>
+    <p>
+Initializes your package
+</p>
 
 
   </div>
@@ -282,8 +265,9 @@ serialization.</p>
   <div class="examples">
     <h3>Examples:</h3>
     
-      <h4><div class='inline'>
-<p>Package.new :author =&gt; ‘you!’, :workbook =&gt; Workbook.new</p>
+      <h4><div class='inline'><p>
+Package.new :author =&gt; &#8216;you!&#8217;, :workbook =&gt; Workbook.new
+</p>
 </div></h4>
       <pre class="example code">
 </pre>
@@ -304,9 +288,10 @@ serialization.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>A hash that you can use to specify the author and workbook for this
-package.</p>
+        <div class='inline'><p>
+A hash that you can use to specify the author and workbook for this
+package.
+</p>
 </div>
       
     </li>
@@ -325,8 +310,9 @@ package.</p>
           <span class="default">
             
           </span>
-          &mdash; <div class='inline'>
-<p>The author of the document</p>
+          &mdash; <div class='inline'><p>
+The author of the document
+</p>
 </div>
         </li>
       
@@ -359,8 +345,9 @@ package.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>the object that the method was called on</p>
+        <div class='inline'><p>
+the object that the method was called on
+</p>
 </div>
       
     </li>
@@ -403,67 +390,7 @@ package.</p>
     
     
       <div class="method_details first">
-  <p class="signature first" id="ruport_table-instance_method">
-  
-    - (<tt>Object</tt>) <strong>ruport_table</strong>(table) 
-  
-
-  
-</p><div class="docstring">
-  <div class="discussion">
-    
-<p>Accepts a ruport table for serialization to xlsx</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-  
-    <li>
-      
-        <span class='name'>table</span>
-      
-      
-        <span class='type'>(<tt>Table</tt>)</span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
-<p>a ruport Table object</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-21
-22
-23</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span>
-
-<span class='def def kw'>def</span> <span class='ruport_table identifier id'>ruport_table</span><span class='lparen token'>(</span><span class='table identifier id'>table</span><span class='rparen token'>)</span>
-  <span class='puts identifier id'>puts</span> <span class='table identifier id'>table</span>
-<span class='end end kw'>end</span>
-</pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      <div class="method_details ">
-  <p class="signature " id="serialize-instance_method">
+  <p class="signature first" id="serialize-instance_method">
   
     - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false) 
   
@@ -474,15 +401,17 @@ package.</p>
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'>
-<p>A tremendous amount of effort has gone into ensuring that you cannot create
+    <div class='inline'><p>
+A tremendous amount of effort has gone into ensuring that you cannot create
 invalid xlsx documents. confirm_valid should be used in the rare case that
-you cannot open the serialized file.</p>
+you cannot open the serialized file.
+</p>
 </div>
   </div>
 
-
-<p>Serialize your workbook to disk as an xlsx document.</p>
+<p>
+Serialize your workbook to disk as an xlsx document.
+</p>
 
 
   </div>
@@ -515,8 +444,9 @@ you cannot open the serialized file.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>The file you want to serialize your package to</p>
+        <div class='inline'><p>
+The file you want to serialize your package to
+</p>
 </div>
       
     </li>
@@ -533,8 +463,9 @@ you cannot open the serialized file.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>Validate the package prior to serialization.</p>
+        <div class='inline'><p>
+Validate the package prior to serialization.
+</p>
 </div>
       
     </li>
@@ -552,9 +483,10 @@ you cannot open the serialized file.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>False if confirm_valid and validation errors exist. True if the package was
-serialized</p>
+        <div class='inline'><p>
+False if confirm_valid and validation errors exist. True if the package was
+serialized
+</p>
 </div>
       
     </li>
@@ -574,7 +506,6 @@ serialized</p>
       <pre class="lines">
 
 
-61
 62
 63
 64
@@ -591,10 +522,11 @@ serialized</p>
 75
 76
 77
-78</pre>
+78
+79</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 61</span>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 62</span>
 
 <span class='def def kw'>def</span> <span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='confirm_valid identifier id'>confirm_valid</span><span class='assign token'>=</span><span class='false false kw'>false</span><span class='rparen token'>)</span>
   <span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='notop op'>!</span><span class='confirm_valid identifier id'>confirm_valid</span> <span class='orop op'>||</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span>
@@ -632,22 +564,25 @@ serialized</p>
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'>
-<p>This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
+    <div class='inline'><p>
+This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
 and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition.
 opc schema require an internet connection to import remote schema from
 dublin core for dc, dcterms and xml namespaces. Those remote schema are
-included in this gem, and the original files have been altered to  refer to
-the local versions.</p>
-
-<p>If by chance you are able to creat a package that does not validate it
+included in this gem, and the original files have been altered to refer to
+the local versions.
+</p>
+<p>
+If by chance you are able to creat a package that does not validate it
 indicates that the internal validation is not robust enough and needs to be
-improved. Please report your errors to the gem author.</p>
+improved. Please report your errors to the gem author.
+</p>
 </div>
   </div>
 
-
-<p>Validate all parts of the package against xsd schema.</p>
+<p>
+Validate all parts of the package against xsd schema.
+</p>
 
 
   </div>
@@ -677,8 +612,9 @@ improved. Please report your errors to the gem author.</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>An array of all validation errors found.</p>
+        <div class='inline'><p>
+An array of all validation errors found.
+</p>
 </div>
       
     </li>
@@ -698,14 +634,14 @@ improved. Please report your errors to the gem author.</p>
       <pre class="lines">
 
 
-95
-96
 97
 98
-99</pre>
+99
+100
+101</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 95</span>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 97</span>
 
 <span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
   <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
@@ -730,23 +666,25 @@ improved. Please report your errors to the gem author.</p>
     
   <div class="note notetag">
     <strong>Note:</strong> 
-    <div class='inline'>
-<p>As there are multiple ways to instantiate a workbook for the package,  here
-are a few examples:</p>
-
-<pre class="ruby"><span class="ruby-comment"># assign directly during package instanciation</span>
-<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">workbook</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>).<span class="ruby-identifier">workbook</span>
-
-<span class="ruby-comment"># get a fresh workbook automatically from the package</span>
-<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Pacakge</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span>
-<span class="ruby-comment">#     # set the workbook after creating the package</span>
-<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span> = <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>
+    <div class='inline'><p>
+As there are multiple ways to instantiate a workbook for the package, here
+are a few examples:
+</p>
+<pre class="code">
+  <span class='comment val'># assign directly during package instanciation</span>
+  <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:workbook</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span>
+
+  <span class='comment val'># get a fresh workbook automatically from the package</span>
+  <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Pacakge constant id'>Pacakge</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span>
+  <span class='comment val'>#     # set the workbook after creating the package</span>
+  <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
 </pre>
 </div>
   </div>
 
-
-<p>The workbook this package will serialize or validate.</p>
+<p>
+The workbook this package will serialize or validate.
+</p>
 
 
   </div>
@@ -777,9 +715,10 @@ are a few examples:</p>
       
       
         &mdash;
-        <div class='inline'>
-<p>If no workbook instance has been assigned with this package a new Workbook
-instance is returned.</p>
+        <div class='inline'><p>
+If no workbook instance has been assigned with this package a new Workbook
+instance is returned.
+</p>
 </div>
       
     </li>
@@ -796,8 +735,9 @@ instance is returned.</p>
       
       
         
-        <div class='inline'>
-<p>ArgumentError if workbook parameter is not a Workbook instance.</p>
+        <div class='inline'><p>
+ArgumentError if workbook parameter is not a Workbook instance.
+</p>
 </div>
       
     </li>
@@ -810,14 +750,14 @@ instance is returned.</p>
       <pre class="lines">
 
 
-37
-38
-39
-40
-41</pre>
+31
+32
+33
+34
+35</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 31</span>
 
 <span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
   <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
@@ -859,10 +799,10 @@ instance is returned.</p>
       <pre class="lines">
 
 
-44</pre>
+45</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 45</span>
 
 <span class='def def kw'>def</span> <span class='workbook= identifier id'>workbook=</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='rparen token'>)</span> <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>&quot;Package.workbook&quot;</span><span class='comma token'>,</span> <span class='Workbook constant id'>Workbook</span><span class='comma token'>,</span> <span class='workbook identifier id'>workbook</span><span class='semicolon token'>;</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</span> <span class='end end kw'>end</span>
 </pre>
@@ -876,7 +816,7 @@ instance is returned.</p>
 </div>
     
     <div id="footer">
-  Generated on Wed Nov 30 08:53:51 2011 by 
+  Generated on Mon Dec  5 14:21:15 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.8.7).
 </div>