summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/Core.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-11-20 23:44:58 +0900
committerRandy Morgan <[email protected]>2011-11-20 23:44:58 +0900
commit2d0ac967e94c5944ccccf9adad8da5a9d082df29 (patch)
tree194839f4ce3687bd51577bab7e75dddc21ad5c9c /doc/Axlsx/Core.html
parent9d210b319c43141120c42aa740fd4a8670e5029a (diff)
downloadcaxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.tar.gz
caxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.zip
pushing docs
Diffstat (limited to 'doc/Axlsx/Core.html')
-rw-r--r--doc/Axlsx/Core.html465
1 files changed, 465 insertions, 0 deletions
diff --git a/doc/Axlsx/Core.html b/doc/Axlsx/Core.html
new file mode 100644
index 00000000..ab5ae902
--- /dev/null
+++ b/doc/Axlsx/Core.html
@@ -0,0 +1,465 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+ Class: Axlsx::Core
+
+ &mdash; Documentation by YARD 0.7.3
+
+</title>
+
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ relpath = '..';
+ if (relpath != '') relpath += '/';
+</script>
+
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (C)</a> &raquo;
+ <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
+ &raquo;
+ <span class="title">Core</span>
+
+
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+ <div id="search">
+
+ <a id="class_list_link" href="#">Class List</a>
+
+ <a id="method_list_link" href="#">Method List</a>
+
+ <a id="file_list_link" href="#">File List</a>
+
+</div>
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Class: Axlsx::Core
+
+
+
+</h1>
+
+<dl class="box">
+
+ <dt class="r1">Inherits:</dt>
+ <dd class="r1">
+ <span class="inheritName">Object</span>
+
+ <ul class="fullTree">
+ <li>Object</li>
+
+ <li class="next">Axlsx::Core</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+
+
+
+
+
+
+
+
+
+ <dt class="r2 last">Defined in:</dt>
+ <dd class="r2 last">lib/axlsx/doc_props/core.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+
+ <div class="note notetag">
+ <strong>Note:</strong>
+ <div class='inline'><p>
+Packages manage their own core object.
+</p>
+</div>
+ </div>
+
+<p>
+The core object for the package.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+ <h3>See Also:</h3>
+ <ul class="see">
+
+ <li>Package#core</li>
+
+ </ul>
+
+</div>
+
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#creator-instance_method" title="#creator (instance method)">- (String) <strong>creator</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+The author of the document.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+
+ <h2>
+ Instance Method Summary
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Core) <strong>initialize</strong>(options = {}) </a>
+
+
+
+ </span>
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Creates a new Core object.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Serializes the core object.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+<div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <p class="signature first" id="initialize-instance_method">
+
+ - (<tt><span class='object_link'><a href="" title="Axlsx::Core (class)">Core</a></span></tt>) <strong>initialize</strong>(options = {})
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Creates a new Core object.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Parameters:</h3>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>options</span>
+
+
+ <span class='type'>(<tt>Hash</tt>)</span>
+
+
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+
+ &mdash;
+ <div class='inline'><p>
+a customizable set of options
+</p>
+</div>
+
+ </li>
+
+</ul>
+
+
+
+
+ <h3>Options Hash (<tt>options</tt>):</h3>
+ <ul class="option">
+
+ <li>
+ <span class="name">creator</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ </ul>
+
+
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+12
+13
+14</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 12</span>
+
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='@creator ivar id'>@creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:creator</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>'axlsx'</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+</div>
+
+ <div id="instance_attr_details" class="attr_details">
+ <h2>Instance Attribute Details</h2>
+
+
+ <span id="creator=-instance_method"></span>
+ <span id="creator-instance_method"></span>
+ <div class="method_details first">
+ <p class="signature first" id="creator-instance_method">
+
+ - (<tt>String</tt>) <strong>creator</strong>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+The author of the document. By default this is &#8216;axlsx&#8217;
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+8
+9
+10</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 8</span>
+
+<span class='def def kw'>def</span> <span class='creator identifier id'>creator</span>
+ <span class='@creator ivar id'>@creator</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="to_xml-instance_method">
+
+ - (<tt>String</tt>) <strong>to_xml</strong>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Serializes the core object. The created dcterms item is set to the current
+time when this method is called.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 18</span>
+
+<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
+ <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span>
+ <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'cp:coreProperties'</span><span class='comma token'>,</span>
+ <span class='symbol val'>:&quot;xmlns:cp&quot;</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CORE_NS constant id'>CORE_NS</span><span class='comma token'>,</span>
+ <span class='symbol val'>:'xmlns:dc'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='CORE_NS_DC constant id'>CORE_NS_DC</span><span class='comma token'>,</span>
+ <span class='symbol val'>:'xmlns:dcmitype'</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='CORE_NS_DCMIT constant id'>CORE_NS_DCMIT</span><span class='comma token'>,</span>
+ <span class='symbol val'>:'xmlns:dcterms'</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='CORE_NS_DCT constant id'>CORE_NS_DCT</span><span class='comma token'>,</span>
+ <span class='symbol val'>:'xmlns:xsi'</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='CORE_NS_XSI constant id'>CORE_NS_XSI</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span>
+ <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dc'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span>
+ <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dcterms'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='created identifier id'>created</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='dot token'>.</span><span class='strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>'%Y-%m-%dT%H:%M:%S'</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:'xsi:type'</span><span class='assign token'>=</span><span class='gt op'>&gt;</span><span class='string val'>&quot;dcterms:W3CDTF&quot;</span>
+ <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'cp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='revision identifier id'>revision</span> <span class='integer val'>0</span>
+ <span class='rbrace token'>}</span>
+ <span class='end end kw'>end</span>
+ <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Sun Nov 20 23:43:57 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>
+
+ </body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2026-05-06 06:47:13 +0000