Ticket #198 - Added docs for string option

OscarGodson · Jan 16, 2013 · e69d02e · e69d02e
1 parent baea637
commit e69d02e
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -71,6 +71,11 @@ var opts = {
     modifier: 18,
     fullscreen: 70,
     preview: 80
+  },
+  string: {
+    togglePreview: 'Toggle Preview Mode',
+    toggleEdit: 'Toggle Edit Mode',
+    toggleFullscreen: 'Enter Fullscreen'
   }
 }
 var editor = new EpicEditor(opts);
@@ -163,6 +168,21 @@ var editor = new EpicEditor(opts);
     <td>The shortcut to toggle the previewer.</td>
     <td><code>80</code> (<code>p</code> key)</td>
   </tr>
+  <tr>
+    <td><code>string.togglePreview</code></td>
+    <td>The tooltip text that appears when hovering the preview icon.</td>
+    <td><code>Toggle Preview Mode</code></td>
+  </tr>
+  <tr>
+    <td><code>string.toggleEdit</code></td>
+    <td>The tooltip text that appears when hovering the edit icon.</td>
+    <td><code>Toggle Edit Mode</code></td>
+  </tr>
+  <tr>
+    <td><code>string.toggleFullscreen</code></td>
+    <td>The tooltip text that appears when hovering the fullscreen icon.</td>
+    <td><code>Enter Fullscreen</code></td>
+  </tr>
 </table>
 
 ### load([_callback_])

diff --git a/index.html b/index.html
@@ -76,6 +76,11 @@ <h3>EpicEditor([<em>options</em>])</h3>
     modifier: 18,
     fullscreen: 70,
     preview: 80
+  },
+  string: {
+    togglePreview: &#39;Toggle Preview Mode&#39;,
+    toggleEdit: &#39;Toggle Edit Mode&#39;,
+    toggleFullscreen: &#39;Enter Fullscreen&#39;
   }
 }
 var editor = new EpicEditor(opts);</code></pre>
@@ -166,6 +171,21 @@ <h3>Options</h3>
     <td>The shortcut to toggle the previewer.</td>
     <td><code>80</code> (<code>p</code> key)</td>
   </tr>
+  <tr>
+    <td><code>string.togglePreview</code></td>
+    <td>The tooltip text that appears when hovering the preview icon.</td>
+    <td><code>Toggle Preview Mode</code></td>
+  </tr>
+  <tr>
+    <td><code>string.toggleEdit</code></td>
+    <td>The tooltip text that appears when hovering the edit icon.</td>
+    <td><code>Toggle Edit Mode</code></td>
+  </tr>
+  <tr>
+    <td><code>string.toggleFullscreen</code></td>
+    <td>The tooltip text that appears when hovering the fullscreen icon.</td>
+    <td><code>Enter Fullscreen</code></td>
+  </tr>
 </table>
 
 <h3>load([<em>callback</em>])</h3>