Site updated: 2020-03-22 20:57:02

Author: xprilion

javascript/reference/index.html

@@ -108,7 +108,39 @@ <h1 id="Examples">Examples</h1>
         </div>
         <div class="book-content">
           <div class="book-post">
-  <p>Coming Soon.</p>
+  <h1 id="JavaScript-Library-Reference">JavaScript Library Reference</h1>
+<p>The methods available in the library currently are as follows:</p>
+<table>
+<thead>
+<tr>
+<th>Method</th>
+<th>Return</th>
+<th>Definition</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>check()</code></td>
+<td>JSON</td>
+<td>Sends a ping to the network and determines the authenticity of request and if the server is responding</td>
+</tr>
+<tr>
+<td><code>labels(pageBody: HTML Document)</code></td>
+<td>JSON</td>
+<td>Generates labels for all elements on the page and updates their alternative text.</td>
+</tr>
+<tr>
+<td><code>captions(pageBody: HTML Document, pageURL: URL of current page)</code></td>
+<td>JSON</td>
+<td>Generates captions for all images on the page and updates their alternative text.</td>
+</tr>
+<tr>
+<td><code>recommendations()</code></td>
+<td>JSON</td>
+<td>Returns the pages recommended for this page.</td>
+</tr>
+</tbody>
+</table>
 
 </div>
 

javascript/usage/index.html

@@ -108,26 +108,33 @@ <h1 id="Examples">Examples</h1>
         </div>
         <div class="book-content">
           <div class="book-post">
-  <ol start="6">
+  <h1 id="Usage-JavaScript-Library">Usage - JavaScript Library</h1>
+<ol>
 <li>On your web page, include the following line to import the AifyJS package into your application -</li>
 </ol>
 <figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">&lt;script src&#x3D;&quot;https:&#x2F;&#x2F;thecodefoundation.dev&#x2F;aify.js&quot;&gt;&lt;&#x2F;script&gt;</span><br></pre></td></tr></table></figure>
-<ol start="7">
+<ol start="2">
 <li>In your web page, use the following line to instantiate a connection to the Aify API -</li>
 </ol>
-<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">var ai &#x3D; new aifyjs();</span><br></pre></td></tr></table></figure>
-<ol start="8">
+<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">var ai &#x3D; new aifyjs(&quot;YOUR-API-KEY&quot;);</span><br></pre></td></tr></table></figure>
+<p>If you have not yet generated the API Key, read <a href="http://localhost:4000/getting-started/#Step-3-Get-your-API-Keys" target="_blank" rel="noopener">How to get your API Keys</a>.</p>
+<ol start="3">
 <li>To generate element labels on the web page, use the following line -</li>
 </ol>
 <figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">ai.labels();</span><br></pre></td></tr></table></figure>
-<ol start="9">
+<ol start="4">
 <li>To fetch captions for the images on the page, use the following line -</li>
 </ol>
 <figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">ai.captions();</span><br></pre></td></tr></table></figure>
-<ol start="10">
-<li>When your page loads, it will silently cause an update of the page source to reflect the labels and captions fetched from the Aify API.</li>
-<li>Voila! Your website is more accessible to people with visual challenges now!</li>
+<ol start="5">
+<li>
+<p>When your page loads, it will silently cause an update of the page source to reflect the labels and captions fetched from the Aify API.</p>
+</li>
+<li>
+<p>Voila! Your website is more accessible to people with visual challenges now!</p>
+</li>
 </ol>
+<p>You can read about all available library methods in the <a href="/javascript/reference">JavaScript Library Reference</a>.</p>
 
 </div>
 

sitemap.xml

@@ -6,16 +6,23 @@
   </url>
 
   <url>
-    <loc>https://docs.thecodefoundation.dev/getting-started/</loc>
+    <loc>https://docs.thecodefoundation.dev/javascript/reference/</loc>
 
-    <lastmod>2020-03-12T21:33:09.327Z</lastmod>
+    <lastmod>2020-03-22T15:26:41.414Z</lastmod>
 
   </url>
 
   <url>
     <loc>https://docs.thecodefoundation.dev/javascript/usage/</loc>
 
-    <lastmod>2020-03-12T21:11:14.757Z</lastmod>
+    <lastmod>2020-03-22T15:17:35.624Z</lastmod>
+    
+  </url>
+  
+  <url>
+    <loc>https://docs.thecodefoundation.dev/getting-started/</loc>
+    
+    <lastmod>2020-03-12T21:33:09.327Z</lastmod>
 
   </url>
 
@@ -40,13 +47,6 @@
 
   </url>
 
-  <url>
-    <loc>https://docs.thecodefoundation.dev/javascript/reference/</loc>
-    
-    <lastmod>2020-03-12T14:12:42.012Z</lastmod>
-    
-  </url>
-  
   <url>
     <loc>https://docs.thecodefoundation.dev/examples/showcase/</loc>