User Guide Menu

* Add menu to open the online User Guide: Preferences > Package Settings > Asciidoctor > User Guide * Update User Guide: * Mention how to access the Guide via ST menus. * Change title from "ST4-Asciidoctor Manual" to "ST4-Asciidoctor User Guide".
tajmone · May 5, 2022 · 83c3ec2 · 83c3ec2
1 parent 35622f6
commit 83c3ec2
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 20 deletions.
diff --git a/Main.sublime-menu b/Main.sublime-menu
@@ -1,31 +1,41 @@
 [
   {
-    "caption": "Preferences",
+    "id": "preferences",
     "children": [
       {
         "caption": "Package Settings",
+        "mnemonic": "P",
+        "id": "package-settings",
         "children": [
           {
             "caption": "Asciidoctor",
             "children": [
               {
-                "args": { "file": "${packages}/ST4-Asciidoctor/Asciidoctor.sublime-settings" },
                 "caption": "Settings \u2013 Default",
-                "command": "open_file"
+                "command": "open_file",
+                "args": {
+                  "file": "${packages}/ST4-Asciidoctor/Asciidoctor.sublime-settings"
+                }
               },
               {
-                "args": { "file": "${packages}/User/Asciidoctor.sublime-settings" },
                 "caption": "Settings \u2013 User",
-                "command": "open_file"
+                "command": "open_file",
+                "args": {
+                  "file": "${packages}/User/Asciidoctor.sublime-settings"
+                }
+              },
+              { "caption": "-", },
+              {
+                "caption": "User Guide",
+                "command": "open_url",
+                "args": {
+                  "url": "https://tajmone.github.io/ST4-Asciidoctor/"
+                }
               }
             ]
           }
-        ],
-        "id": "package-settings",
-        "mnemonic": "P"
+        ]
       }
-    ],
-    "id": "preferences",
-    "mnemonic": "n"
+    ]
   }
 ]
diff --git a/docs-src/features.adoc b/docs-src/features.adoc
@@ -3,6 +3,15 @@
 The list of editing features natively supported by the package.
 
 
+== Associated File Extensions
+
+The following file extensions are automatically recognized as AsciiDoc files:
+
+* `.adoc`
+* `.asc`
+* `.asciidoc`
+
+
 == Snippets
 
 The following table lists the package snippets and their features.

diff --git a/docs-src/index.asciidoc b/docs-src/index.asciidoc
@@ -1,7 +1,7 @@
-= ST4-Asciidoctor Manual
+= ST4-Asciidoctor User Guide
 :author: Tristano Ajmone
 :email: <[email protected]>
-:revdate: 2022-05-04
+:revdate: 2022-05-05
 :revnumber: 0.1.0
 :revremark: Alpha
 :version-label: v
@@ -34,7 +34,7 @@ include::_inc-attributes-custom.adoc[]
 // Preamble
 // ========
 
-Userguide for the
+User guide for the
 https://github.com/tajmone/ST4-Asciidoctor[ST4-Asciidoctor^, title="Visit the package repository at GitHub"]
 package.
 

diff --git a/docs-src/intro.adoc b/docs-src/intro.adoc
@@ -1,10 +1,26 @@
 [preface]
 = Introduction
 
-The goal of this Manual is to document the various features of the ST4-Asciidoctor package, serving as a reference guide, and at the same time try to illustrate how to maximize the benefits of the package by providing practical editing tips via usage guidelines.
+The goal of this guide is to document the various features of the ST4-Asciidoctor package, serving as a reference guide, and at the same time try to illustrate how to maximize the benefits of the package by providing practical editing tips via usage guidelines.
 
 To simplify learning for AsciiDoc or Sublime Text newbies, some technical terms contain links to their official documentation, so that they might be easily looked up for more information.
 
 The Manual is still a work-in-progress in its early stages.
 
+[TIP]
+===================
+You're advised to consult this guide from time to time because while the package is in Alpha stage it's subject to features changes, so you might discover that after an update the package is not working as before.
+Once the package will reach v1.0.0, braking changes will occur rarely.
+===================
+
+
+[discrete]
+== Accessing the User Guide
+
+You can quickly access this online user guide from within Sublime Text via the menu:
+
+* menu:Preferences[Package Settings > Asciidoctor > User Guide]
+
+Although access to the guide requires an Internet connection, the advantage of an online guide is that you'll always have access to the latest documentation, since this guide is often updated between package releases.
+
 // EOF //
diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.17">
 <meta name="author" content="Tristano Ajmone">
-<title>ST4-Asciidoctor Manual</title>
+<title>ST4-Asciidoctor User Guide</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -440,12 +440,12 @@
 </head>
 <body class="book toc2 toc-left">
 <div id="header">
-<h1>ST4-Asciidoctor Manual</h1>
+<h1>ST4-Asciidoctor User Guide</h1>
 <div class="details">
 <span id="author" class="author">Tristano Ajmone</span><br>
 <span id="email" class="email">&lt;<a href="mailto:[email protected]">[email protected]</a>&gt;</span><br>
 <span id="revnumber">v 0.1.0,</span>
-<span id="revdate">2022-05-04</span>
+<span id="revdate">2022-05-05</span>
 <br><span id="revremark">Alpha</span>
 </div>
 <div id="toc" class="toc2">
@@ -454,6 +454,7 @@ <h1>ST4-Asciidoctor Manual</h1>
 <li><a href="#introduction">Introduction</a></li>
 <li><a href="#package_features">Package Features</a>
 <ul class="sectlevel1">
+<li><a href="#associated_file_extensions">Associated File Extensions</a></li>
 <li><a href="#snippets">Snippets</a></li>
 <li><a href="#completions">Completions</a></li>
 <li><a href="#keymap_details">Keymap Details</a>
@@ -477,7 +478,7 @@ <h1>ST4-Asciidoctor Manual</h1>
 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
-<p>Userguide for the
+<p>User guide for the
 <a href="https://github.com/tajmone/ST4-Asciidoctor" title="Visit the package repository at GitHub" target="_blank" rel="noopener">ST4-Asciidoctor</a>
 package.</p>
 </div>
@@ -487,14 +488,43 @@ <h1>ST4-Asciidoctor Manual</h1>
 <h2 id="introduction"><a class="anchor" href="#introduction"></a>Introduction</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>The goal of this Manual is to document the various features of the ST4-Asciidoctor package, serving as a reference guide, and at the same time try to illustrate how to maximize the benefits of the package by providing practical editing tips via usage guidelines.</p>
+<p>The goal of this guide is to document the various features of the ST4-Asciidoctor package, serving as a reference guide, and at the same time try to illustrate how to maximize the benefits of the package by providing practical editing tips via usage guidelines.</p>
 </div>
 <div class="paragraph">
 <p>To simplify learning for AsciiDoc or Sublime Text newbies, some technical terms contain links to their official documentation, so that they might be easily looked up for more information.</p>
 </div>
 <div class="paragraph">
 <p>The Manual is still a work-in-progress in its early stages.</p>
 </div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>You&#8217;re advised to consult this guide from time to time because while the package is in Alpha stage it&#8217;s subject to features changes, so you might discover that after an update the package is not working as before.
+Once the package will reach v1.0.0, braking changes will occur rarely.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<h2 id="accessing_the_user_guide" class="discrete">Accessing the User Guide</h2>
+<div class="paragraph">
+<p>You can quickly access this online user guide from within Sublime Text via the menu:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><span class="menuseq"><b class="menu">Preferences</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Package Settings</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Asciidoctor</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">User Guide</b></span></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Although access to the guide requires an Internet connection, the advantage of an online guide is that you&#8217;ll always have access to the latest documentation, since this guide is often updated between package releases.</p>
+</div>
 </div>
 </div>
 <h1 id="package_features" class="sect0"><a class="anchor" href="#package_features"></a>Package Features</h1>
@@ -504,6 +534,27 @@ <h1 id="package_features" class="sect0"><a class="anchor" href="#package_feature
 </div>
 </div>
 <div class="sect1">
+<h2 id="associated_file_extensions"><a class="anchor" href="#associated_file_extensions"></a>Associated File Extensions</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The following file extensions are automatically recognized as AsciiDoc files:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>.adoc</code></p>
+</li>
+<li>
+<p><code>.asc</code></p>
+</li>
+<li>
+<p><code>.asciidoc</code></p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="snippets"><a class="anchor" href="#snippets"></a>Snippets</h2>
 <div class="sectionbody">
 <div class="paragraph">