examples/api-samples/public/docs/sample20.html in groupdocs-2.2.0 vs examples/api-samples/public/docs/sample20.html in groupdocs-2.3.0
- old
+ new
@@ -1,230 +1,230 @@
-<!DOCTYPE html>
-
-<html>
-<head>
- <title>sample20.rb</title>
- <meta http-equiv="content-type" content="text/html; charset=UTF-8">
- <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
- <link rel="stylesheet" media="all" href="docco.css" />
-</head>
-<body>
- <div id="container">
- <div id="background"></div>
-
- <ul class="sections">
-
- <li id="title">
- <div class="annotation">
- <h1>sample20.rb</h1>
- </div>
- </li>
-
-
-
- <li id="section-1">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-1">¶</a>
- </div>
- <p>GET request</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre>get <span class="hljs-string">'/sample-20-how-to-get-compare-change-list-for-document'</span> <span class="hljs-keyword">do</span>
- haml <span class="hljs-symbol">:sample20</span>
-<span class="hljs-keyword">end</span></pre></div></div>
-
- </li>
-
-
- <li id="section-2">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-2">¶</a>
- </div>
- <p>POST request</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre>post <span class="hljs-string">'/sample-20-how-to-get-compare-change-list-for-document'</span> <span class="hljs-keyword">do</span></pre></div></div>
-
- </li>
-
-
- <li id="section-3">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-3">¶</a>
- </div>
- <p>Set variables</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> set <span class="hljs-symbol">:client_id</span>, params[<span class="hljs-symbol">:clientId</span>]
- set <span class="hljs-symbol">:private_key</span>, params[<span class="hljs-symbol">:privateKey</span>]
- set <span class="hljs-symbol">:resultFileId</span>, params[<span class="hljs-symbol">:resultFileId</span>]
- set <span class="hljs-symbol">:base_path</span>, params[<span class="hljs-symbol">:basePath</span>]
-
- <span class="hljs-keyword">begin</span></pre></div></div>
-
- </li>
-
-
- <li id="section-4">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-4">¶</a>
- </div>
- <p>Check required variables</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> raise <span class="hljs-string">'Please enter all required parameters'</span> <span class="hljs-keyword">if</span> settings.client_id.empty? <span class="hljs-keyword">or</span> settings.private_key.empty? <span class="hljs-keyword">or</span> settings.resultFileId.empty?</pre></div></div>
-
- </li>
-
-
- <li id="section-5">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-5">¶</a>
- </div>
- <p>Prepare base path</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> settings.base_path.empty?
- base_path = <span class="hljs-string">'https://api.groupdocs.com'</span>
- <span class="hljs-keyword">elsif</span> settings.base_path.match(<span class="hljs-string">'/v2.0'</span>)
- base_path = settings.base_path.split(<span class="hljs-string">'/v2.0'</span>)[<span class="hljs-number">0</span>]
- <span class="hljs-keyword">else</span>
- base_path = settings.base_path
- <span class="hljs-keyword">end</span></pre></div></div>
-
- </li>
-
-
- <li id="section-6">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-6">¶</a>
- </div>
- <p>Configure your access to API server</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> <span class="hljs-constant">GroupDocs</span>.configure <span class="hljs-keyword">do</span> |groupdocs|
- groupdocs.client_id = settings.client_id
- groupdocs.private_key = settings.private_key</pre></div></div>
-
- </li>
-
-
- <li id="section-7">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-7">¶</a>
- </div>
- <p>Optionally specify API server and version</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="hljs-comment"># default is 'https://api.groupdocs.com'</span>
- <span class="hljs-keyword">end</span></pre></div></div>
-
- </li>
-
-
- <li id="section-8">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-8">¶</a>
- </div>
- <p>Construct new storage file</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.new(<span class="hljs-symbol">guid:</span> settings.resultFileId)</pre></div></div>
-
- </li>
-
-
- <li id="section-9">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-9">¶</a>
- </div>
- <p>Construct new document</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> document = <span class="hljs-constant">GroupDocs::Document</span>.new(<span class="hljs-symbol">file:</span> file)</pre></div></div>
-
- </li>
-
-
- <li id="section-10">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-10">¶</a>
- </div>
- <p>Get compare changes</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> changes = document.changes!()
- result = <span class="hljs-string">''</span>
- result += <span class="hljs-string">"<table class='border'>"</span>
- result += <span class="hljs-string">"<tr><td><font color='green'>Change Name</font></td><td><font color='green'>Change</font></td></tr>"</span>
- changes.each <span class="hljs-keyword">do</span> |change|
- result += <span class="hljs-string">"<tr><td>id</td><td><span class="hljs-subst">#{change.id}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>type</td><td><span class="hljs-subst">#{change.type}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>text</td><td><span class="hljs-subst">#{change.text}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>page id</td><td><span class="hljs-subst">#{change.page[<span class="hljs-symbol">:Id</span>]}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>page weight</td><td><span class="hljs-subst">#{change.page[<span class="hljs-symbol">:Width</span>]}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>page height</td><td><span class="hljs-subst">#{change.page[<span class="hljs-symbol">:Height</span>]}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>box x</td><td><span class="hljs-subst">#{change.box.x}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>box y</td><td><span class="hljs-subst">#{change.box.y}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>box weight</td><td><span class="hljs-subst">#{change.box.width}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr><td>box height</td><td><span class="hljs-subst">#{change.box.height}</span></td></tr>"</span>
- result += <span class="hljs-string">"<tr bgcolor='#808080'><td></td><td></td></tr>"</span>
- <span class="hljs-keyword">end</span>
-
- result += <span class="hljs-string">'</table>'</span>
-
- <span class="hljs-keyword">rescue</span> <span class="hljs-constant">Exception</span> => e
- err = e.message
- <span class="hljs-keyword">end</span></pre></div></div>
-
- </li>
-
-
- <li id="section-11">
- <div class="annotation">
-
- <div class="pilwrap ">
- <a class="pilcrow" href="#section-11">¶</a>
- </div>
- <p>Set variables for template</p>
-
- </div>
-
- <div class="content"><div class='highlight'><pre> haml <span class="hljs-symbol">:sample20</span>, <span class="hljs-symbol">:locals</span> => {<span class="hljs-symbol">:userId</span> => settings.client_id, <span class="hljs-symbol">:privateKey</span> => settings.private_key, <span class="hljs-symbol">:resultFileId</span> => settings.resultFileId, <span class="hljs-symbol">:result</span> => result, <span class="hljs-symbol">:err</span> => err}
-<span class="hljs-keyword">end</span></pre></div></div>
-
- </li>
-
- </ul>
- </div>
-</body>
-</html>
+<!DOCTYPE html>
+
+<html>
+<head>
+ <title>sample20.rb</title>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+ <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
+ <link rel="stylesheet" media="all" href="docco.css" />
+</head>
+<body>
+ <div id="container">
+ <div id="background"></div>
+
+ <ul class="sections">
+
+ <li id="title">
+ <div class="annotation">
+ <h1>sample20.rb</h1>
+ </div>
+ </li>
+
+
+
+ <li id="section-1">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-1">¶</a>
+ </div>
+ <p>GET request</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre>get <span class="hljs-string">'/sample-20-how-to-get-compare-change-list-for-document'</span> <span class="hljs-keyword">do</span>
+ haml <span class="hljs-symbol">:sample20</span>
+<span class="hljs-keyword">end</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-2">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-2">¶</a>
+ </div>
+ <p>POST request</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre>post <span class="hljs-string">'/sample-20-how-to-get-compare-change-list-for-document'</span> <span class="hljs-keyword">do</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-3">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-3">¶</a>
+ </div>
+ <p>Set variables</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> set <span class="hljs-symbol">:client_id</span>, params[<span class="hljs-symbol">:clientId</span>]
+ set <span class="hljs-symbol">:private_key</span>, params[<span class="hljs-symbol">:privateKey</span>]
+ set <span class="hljs-symbol">:resultFileId</span>, params[<span class="hljs-symbol">:resultFileId</span>]
+ set <span class="hljs-symbol">:base_path</span>, params[<span class="hljs-symbol">:basePath</span>]
+
+ <span class="hljs-keyword">begin</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-4">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-4">¶</a>
+ </div>
+ <p>Check required variables</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> raise <span class="hljs-string">'Please enter all required parameters'</span> <span class="hljs-keyword">if</span> settings.client_id.empty? <span class="hljs-keyword">or</span> settings.private_key.empty? <span class="hljs-keyword">or</span> settings.resultFileId.empty?</pre></div></div>
+
+ </li>
+
+
+ <li id="section-5">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-5">¶</a>
+ </div>
+ <p>Prepare base path</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> settings.base_path.empty?
+ base_path = <span class="hljs-string">'https://api.groupdocs.com'</span>
+ <span class="hljs-keyword">elsif</span> settings.base_path.match(<span class="hljs-string">'/v2.0'</span>)
+ base_path = settings.base_path.split(<span class="hljs-string">'/v2.0'</span>)[<span class="hljs-number">0</span>]
+ <span class="hljs-keyword">else</span>
+ base_path = settings.base_path
+ <span class="hljs-keyword">end</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-6">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-6">¶</a>
+ </div>
+ <p>Configure your access to API server</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> <span class="hljs-constant">GroupDocs</span>.configure <span class="hljs-keyword">do</span> |groupdocs|
+ groupdocs.client_id = settings.client_id
+ groupdocs.private_key = settings.private_key</pre></div></div>
+
+ </li>
+
+
+ <li id="section-7">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-7">¶</a>
+ </div>
+ <p>Optionally specify API server and version</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="hljs-comment"># default is 'https://api.groupdocs.com'</span>
+ <span class="hljs-keyword">end</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-8">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-8">¶</a>
+ </div>
+ <p>Construct new storage file</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.new(<span class="hljs-symbol">guid:</span> settings.resultFileId)</pre></div></div>
+
+ </li>
+
+
+ <li id="section-9">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-9">¶</a>
+ </div>
+ <p>Construct new document</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> document = <span class="hljs-constant">GroupDocs::Document</span>.new(<span class="hljs-symbol">file:</span> file)</pre></div></div>
+
+ </li>
+
+
+ <li id="section-10">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-10">¶</a>
+ </div>
+ <p>Get compare changes</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> changes = document.changes!()
+ result = <span class="hljs-string">''</span>
+ result += <span class="hljs-string">"<table class='border'>"</span>
+ result += <span class="hljs-string">"<tr><td><font color='green'>Change Name</font></td><td><font color='green'>Change</font></td></tr>"</span>
+ changes.each <span class="hljs-keyword">do</span> |change|
+ result += <span class="hljs-string">"<tr><td>id</td><td><span class="hljs-subst">#{change.id}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>type</td><td><span class="hljs-subst">#{change.type}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>text</td><td><span class="hljs-subst">#{change.text}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>page id</td><td><span class="hljs-subst">#{change.page[<span class="hljs-symbol">:Id</span>]}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>page weight</td><td><span class="hljs-subst">#{change.page[<span class="hljs-symbol">:Width</span>]}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>page height</td><td><span class="hljs-subst">#{change.page[<span class="hljs-symbol">:Height</span>]}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>box x</td><td><span class="hljs-subst">#{change.box.x}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>box y</td><td><span class="hljs-subst">#{change.box.y}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>box weight</td><td><span class="hljs-subst">#{change.box.width}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr><td>box height</td><td><span class="hljs-subst">#{change.box.height}</span></td></tr>"</span>
+ result += <span class="hljs-string">"<tr bgcolor='#808080'><td></td><td></td></tr>"</span>
+ <span class="hljs-keyword">end</span>
+
+ result += <span class="hljs-string">'</table>'</span>
+
+ <span class="hljs-keyword">rescue</span> <span class="hljs-constant">Exception</span> => e
+ err = e.message
+ <span class="hljs-keyword">end</span></pre></div></div>
+
+ </li>
+
+
+ <li id="section-11">
+ <div class="annotation">
+
+ <div class="pilwrap ">
+ <a class="pilcrow" href="#section-11">¶</a>
+ </div>
+ <p>Set variables for template</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> haml <span class="hljs-symbol">:sample20</span>, <span class="hljs-symbol">:locals</span> => {<span class="hljs-symbol">:userId</span> => settings.client_id, <span class="hljs-symbol">:privateKey</span> => settings.private_key, <span class="hljs-symbol">:resultFileId</span> => settings.resultFileId, <span class="hljs-symbol">:result</span> => result, <span class="hljs-symbol">:err</span> => err}
+<span class="hljs-keyword">end</span></pre></div></div>
+
+ </li>
+
+ </ul>
+ </div>
+</body>
+</html>