Added configuration settings for SSML output.

Author: johniwasz

.vscodeignore

@@ -11,6 +11,7 @@ images/snippetssample03.gif
 images/syntaxhighlights.png
 images/intellisense01.gif
 images/markdownpref.gif
+images/config01.png
 tsconfig.json
 webpack.config.js
 *.ts

CHANGELOG.md

@@ -6,9 +6,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- Output selected text in SpeechMarkdown output channel
+
 - Known issue with phonemes in ipa tags that include quotes
 
+## [0.0.9] - 2020-07-17
+
+- Removed support for cardinal modifier as it is not supported in SpeechMarkdown
+- Output selected text in SpeechMarkdown output channel
+- Added four configuration settings:
+  - speechmarkdown.includeFormatterComment
+  - speechmarkdown.includeParagraphTags
+  - speechmarkdown.includeSpeakTags
+  - speechmarkdown.preserveEmptyLines
+
 ## [0.0.8] - 2020-07-14
 
 - Added an editor context menu option which provides SSML that results from selected Speech Markdown text.

README.md

@@ -12,10 +12,6 @@ This extentsion supports snippets, hover-over, syntax highlighting of Speech Mar
 - [Hover over](#hover-over)
 - [Comprehensive Snippets](#snippets)
 
-
-<img src="https://raw.githubusercontent.com/speechmarkdown/speechmarkdown-vscode/master/images/smd-demo-1.gif" width="75%" alt="Speech Markdown Visual Studio Code Sample"/>
-
-
 ### Speech Markdown Preview
 
 Speech Markdown outputs platform-compatible Speech Synthesis Markup Language (SSML). Selecting Speech Markdown in an editor, right-clicking and selecting the "Speech Markdown to SSML" menu option provides SSML output for all supported platforms. At the time of this release (v0.0.8) this includes:
@@ -31,6 +27,9 @@ For those that prefer keyboard shortcuts, use Ctrl+Shift+L.
 
 <img src="https://raw.githubusercontent.com/speechmarkdown/speechmarkdown-vscode/master/images/markdownpref.gif" width="75%" alt="Speech Markdown Preview"/>
 
+By default, the starting and ending speak tags are included in the output. This can be disabled in Settings -> Extensions -> SpeechMarkdown -> Include Speak Tags. Here are the current configuration options:
+
+<img src="https://raw.githubusercontent.com/speechmarkdown/speechmarkdown-vscode/master/images/config01.png" width="75%" alt="Configuration"/>
 
 ### IntelliSense
 
@@ -88,10 +87,6 @@ A pause [break:"250ms"] then continue.
 ```
 A pause [250ms] then continue. A longer pause [1s] then continue.
 ```
-- smd cardinal - Speaks a number as a cardinal: one, twenty, twelve thousand three hundred forty five, etc.
-```
-One, two, (3)[cardinal].
-```
 - smd characters - Speaks a number or text as individual characters.
 ```
 Countdown: (321)[characters]

images/config01.png

@@ -13,7 +13,7 @@
     "theme": "dark"
   },
   "license": "MIT",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "preview": false,
   "author": {
     "name": "johniwasz"
@@ -36,7 +36,9 @@
     "onLanguage:json",
     "onLanguage:javascript",
     "onLanguage:typescript",
-    "onLanguage:yaml"
+    "onLanguage:yaml",
+    "onLanguage:markdown",
+    "onLanguage:speechmarkdown"
   ],
   "main": "./dist/extension",
   "contributes": {
@@ -63,28 +65,53 @@
         "path": "./snippets.json"
       }
     ],
+    "configuration": {
+      "title": "SpeechMarkdown",
+      "properties": {
+        "speechmarkdown.includeSpeakTags": {
+          "type": "boolean",
+          "default": true,
+          "description": "Include open and close speech tags around generated SSML."
+        },
+        "speechmarkdown.includeParagraphTags": {
+          "type": "boolean",
+          "default": false,
+          "description": "Include paragraph tags in generated SSML."
+        },
+        "speechmarkdown.includeFormatterComment": {
+          "type": "boolean",
+          "default": false,
+          "description": "Include formatter comments in generated SSML."
+        },
+        "speechmarkdown.preserveEmptyLines": {
+          "type": "boolean",
+          "default": false,
+          "description": "Keep empty lines in generated SSML."
+        }
+      }
+    },
     "keybindings": [
       {
         "command": "extension.speechmarkdownpreview",
-        "key": "ctrl+shift+l",       
+        "key": "ctrl+shift+l",
         "when": "editorHasSelection"
       }
     ],
     "commands": [
       {
-          "command": "extension.speechmarkdownpreview", 
-          "title": "Speech Markdown to SSML",
-          "category": "Speech Markdown"
+        "command": "extension.speechmarkdownpreview",
+        "title": "Speech Markdown to SSML",
+        "category": "Speech Markdown"
       }
     ],
     "menus": {
-        "editor/context": [
-            {
-                "command": "extension.speechmarkdownpreview",
-                "group": "speechmarkdown@1",
-                "when": "editorHasSelection"
-            }
-        ]
+      "editor/context": [
+        {
+          "command": "extension.speechmarkdownpreview",
+          "group": "speechmarkdown@1",
+          "when": "editorHasSelection"
+        }
+      ]
     },
     "languages": [
       {

images/markdownpref.gif

@@ -69,11 +69,6 @@
     "body": "(${TM_SELECTED_TEXT})[address]",
     "description": "Speaks the selected text as a street address."
   },
-  "cardinal": {
-    "prefix": "smd cardinal",
-    "body": "(${TM_SELECTED_TEXT})[cardinal]",
-    "description": "Speaks a number as a cardinal: one, twenty, twelve thousand three hundred forty five, etc."
-  },
   "expletive": {
     "prefix": "smd expletive",
     "body": "(${TM_SELECTED_TEXT})[expletive]",
@@ -142,7 +137,7 @@
   "number": {
     "prefix": "smd number",
     "body": "(${TM_SELECTED_TEXT})[number]",
-    "description": "Speaks a number as a cardinal: one, twenty, twelve thousand three hundred forty five, etc. (same as cardinal)"
+    "description": "Speaks a number as a cardinal: one, twenty, twelve thousand three hundred forty five, etc."
   },
   "break ms": {
     "prefix": "smd break short",

package-lock.json

@@ -130,13 +130,6 @@ export var hoverInfoArr: SPHoverInfo[] = [
     true,
     false
   ),
-  new SPHoverInfo(
-    [new SPElement("cardinal", [ new SPSnippet("cardinal", "cardinal", true, false, false, false)]), new SPElement("number", [ new SPSnippet("number", "number", true, false, false, false)])],
-    "Speaks a number as a cardinal: one, twenty, twelve thousand three hundred forty five, etc. \n \n ```text \n One, two, (3)[cardinal]. \n Your balance is: (12345)[cardinal]. \n (801)[cardinal] is the same as (801)[number] \n ```",
-    true,
-    true,
-    false
-  ),
   new SPHoverInfo(
     [new SPElement("characters", [new SPSnippet("characters", "characters", true, false, false, false)])],
     "Speaks a number or text as individual characters. \n ```text \n Countdown: (321)[characters] \n The word is spelled: (park)[chars] \n ```",

package.json

@@ -14,9 +14,13 @@ export default class  {
 	  const speech = new SpeechMarkdown();
 
 	  let speechOpts :  SpeechOptions = { platform: "amazon-alexa" };
-	  speechOpts.includeSpeakTag = false;
-	  
-	  var output : string = 'Speech Mardown text: \n';		 
+
+      speechOpts.includeParagraphTag = <boolean>vscode.workspace.getConfiguration().get('speechmarkdown.includeParagraphTags');
+	  speechOpts.includeSpeakTag = <boolean>vscode.workspace.getConfiguration().get('speechmarkdown.includeSpeakTags');
+	  speechOpts.includeFormatterComment = <boolean>vscode.workspace.getConfiguration().get('speechmarkdown.includeFormatterComment');
+	  speechOpts.preserveEmptyLines = <boolean>vscode.workspace.getConfiguration().get('speechmarkdown.preserveEmptyLines');
+
+	  var output : string = 'Speech Mardown text: \n';
 
 	  if(smdText.length == 0)
 	  {
@@ -39,7 +43,7 @@ export default class  {
 			speechOut = ex;
 		}
 
-		output +='\n\nAlexa: \n';
+		output +='\nAlexa: \n';
 		output +=speechOut;
 		output +='\n';
 

snippets.json

@@ -183,7 +183,7 @@
       }
     },
     "simple-modifier-expression": {
-      "match": "(\\()([^)]+)(\\))(\\[)(address|cardinal|characters|bleep|expletive|fraction|interjection|number|ordinal|unit|whisper)(\\])",
+      "match": "(\\()([^)]+)(\\))(\\[)(address|characters|bleep|expletive|fraction|interjection|number|ordinal|unit|whisper)(\\])",
       "name": "meta.modifier.simple.speechmarkdown",
       "captures": {
         "1": { "name": "meta.embedded.meta.brace.round.speechmarkdown" },
@@ -351,7 +351,7 @@
           }
         },
         {
-          "match": "(address|cardinal|characters|bleep|expletive|fraction|interjection|number|ordinal|unit|whisper)",
+          "match": "(address|characters|bleep|expletive|fraction|interjection|number|ordinal|unit|whisper)",
           "name": "meta.modifier.simple.speechmarkdown",
           "captures": {
             "1": { "name": "entity.name.function.speechmarkdown.modifier" }