@gmb/bitmark-parser-generator 3.31.1 → 3.33.0

package/LICENSE

@@ -1,7 +1,3 @@
-ISC License
+Proprietary
 
-Copyright ©2023 Get More Brain
-
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+© 2023-25 Get More Brain Ltd

package/README.md

@@ -139,6 +139,64 @@ bpg.convert(ast, { output: "./output.bitmark" });
 bpg.convert(ast, { output: "./output.json", outputFormat: 'json' });
 ```
 
+### Breakscaping
+
+A text can be breakscaped programmatically for inclusion in bitmark.
+
+NOTE: It is recommended the bit builder documented above in Programmatic Bitmark Creation is used rather than
+hand-coding bitmark creation, because it guarantees the bitmark will be valid, and all breakscaping will be correct.
+
+When breakscaping a text for inclusion in bitmark, the breakscaping applied depends on where that text appears in the
+bitmark. The following four text locations require different breakscaping:
+
+| Bit Format           | Text Location |
+|----------|-------------|
+| bitmark++            | body |
+| bitmark++            | tag |
+| text (not bitmark++) | body |
+| text (not bitmark++) | tag |
+
+Also, if a plain text divider `==== text ====` is used, then text after the divider must be breakscaped using
+`text:body` even if the bit is `bitmark++`.
+
+```ts
+import { BitmarkParserGenerator, BodyTextFormat, TextLocation, InputType } from 'bitmark-parser-generator';
+
+const bpg = new BitmarkParserGenerator();
+
+
+const breakscaped = bpg.breakscapeText("This is the [!text] to be breakscaped", {
+  inputFormat: InputType.string, // or "string"
+  textFormat: BodyTextFormat.bitmarkPlusPlus, // or "bitmark++"
+  textLocation: TextLocation.body, // or "body"
+});
+// breakscaped = "This is the [^!text] to be breakscaped"
+
+
+const breakscaped = bpg.breakscapeText("This is the [!text] to be breakscaped", {
+  inputFormat: InputType.string, // or "string"
+  textFormat: BodyTextFormat.bitmarkPlusPlus, // or "bitmark++"
+  textLocation: TextLocation.tag, // or "tag"
+});
+// breakscaped = "This is the [!text^] to be breakscaped"
+```
+
+
+
+### Info
+
+Information about the supported bits can be retreived via the info API
+
+```ts
+import { BitmarkParserGenerator } from 'bitmark-parser-generator';
+
+const bpg = new BitmarkParserGenerator();
+
+// Write supported bit info to the console
+const info = bpg.info();
+console.log(JSON.stringify(info, null, 2));
+```
+
 
 ### Upgrade