Merge pull request #54 from colinc86/better-formatting

Better formatting

Author: colinc86

README.md

@@ -8,27 +8,28 @@ A SwiftUI view that renders LaTeX equations.
 
 ## 📖 Contents
 
-- [About](#ℹ️-about)
-- [Installation](#📦-installation)
-- [Usage](#⌨️-usage)
-  - [Modifiers](#⚙️-modifiers)
-    - [Parsing Mode](#🔤-parsing-mode)
-    - [Image Rendering Mode](#🌄-image-rendering-mode)
-    - [Error Mode](#🚨-error-mode)
-    - [Block Rendering Mode](#🧱-block-rendering-mode)
-    - [Numbered Block Equations](#🔢-numbered-block-equations)
+- [ℹ️ About](#about)
+- [📦 Installation](#installation)
+- [⌨️ Usage](#usage)
+  - [⚙️ Modifiers](#modifiers)
+    - [🔤 Parsing Mode](#parsing-mode)
+    - [🌄 Image Rendering Mode](#image-rendering-mode)
+    - [🚨 Error Mode](#error-mode)
+    - [🧱Block Rendering Mode](#block-rendering-mode)
+    - [🔢 Numbered Block Equations](#numbered-block-equations)
       - [Equation Number Mode](#equation-number-mode)
       - [Equation Number Start](#equation-number-start)
       - [Equation Number Offset](#equation-number-offset)
       - [Format Equation Number](#format-equation-number)
-    - [Unencode HTML](#🔗-unencode-html)
-    - [Rendering Style](#🕶️-rendering-style)
-    - [Rendering Animation](#🪩-animated)
-  - [Styles](#🪮-styles)
-  - [Caching](#🗄️-caching)
-  - [Preloading](#🏃‍♀️-preloading)
+    - [🔗 Unencode HTML](#unencode-html)
+    - [📄 Ignore String Formatting](#ignore-string-formatting)
+    - [🕶️ Rendering Style](#rendering-style)
+    - [🪩 Rendering Animation](#rendering-animation)
+  - [🪮 Styles](#styles)
+  - [🗄️ Caching](#caching)
+  - [🏃‍♀️ Preloading](#preloading)
 
-## ℹ️ About
+## About
 
 `LaTexSwiftUI` is a package that exposes a view named `LaTeX` that can parse and render TeX and LaTeX equations which contain math-mode marcos.
 
@@ -43,15 +44,15 @@ It will
 It won't
 - render TeX and LaTeX documents (text-mode macros, with the exception of the rule above).
 
-## 📦 Installation
+## Installation
 
 Add the dependency to your package manifest file.
 
 ```swift
 .package(url: "https://github.com/colinc86/LaTeXSwiftUI", from: "1.3.2")
 ```
 
-## ⌨️ Usage
+## Usage
 
 Import the package and use the view.
 
@@ -69,7 +70,7 @@ struct MyView: View {
 
 > <img src="./assets/images/hello.png" width="85" height="21.5">
 
-### ⚙️ Modifiers
+### Modifiers
 
 The `LaTeX` view's body is built up of `Text` views so feel free to use any of the supported modifiers.
 
@@ -83,14 +84,15 @@ LaTeX("Hello, $\\LaTeX$!")
 
 Along with supporting the built-in SwiftUI modifies, `LaTeXSwiftUI` defines more to let you configure the view.
 
-#### 🔤 Parsing Mode
+#### Parsing Mode
 
 Text input can either be completely rendered, or the view can search for top-level equations delimited by the following terminators.
 
 | Terminators |
 |-------------|
 | `$...$` |
 | `$$...$$` |
+| `\(...\)` |
 | `\[...\]` |
 | `\begin{equation}...\end{equation}` |
 | `\begin{equation*}...\end{equation*}` |
@@ -110,7 +112,7 @@ LaTeX("\\text{Euler's identity is } e^{i\\pi}+1=0\\text{.}")
 
 > <img src="./assets/images/euler.png" width="293" height="80">
 
-#### 🌄 Image Rendering Mode
+#### Image Rendering Mode
 
 You can specify the rendering mode of the rendered equations so that they either take on the style of the surrounding text or display the style rendered by MathJax. The default behavior is to use the `template` rendering mode so that images match surrounding text.
 
@@ -126,7 +128,7 @@ LaTeX("Hello, ${\\color{red} \\LaTeX}$!")
 
 > <img src="./assets/images/rendering_mode.png" width="84.5" height="43">
 
-#### 🚨 Error Mode
+#### Error Mode
 
 When an error occurs while parsing the input the view will display the original LaTeX. You can change this behavior by modifying the view's `errorMode`.
 
@@ -148,7 +150,7 @@ LaTeX("$\\asdf$")
 
 > <img src="./assets/images/errors.png" width="199.5" height="55">
 
-#### 🧱 Block Rendering Mode
+#### Block Rendering Mode
 
 The typical "LaTeX-ish" way to render the input is with `blockViews`. This mode renders text as usual, and block equations as... blocks; on their own line and centered. MathJax 3 does not support line breaking, so the view places block equations in horizontal scroll views in case the width of the equation is more than the width of the view.
 
@@ -174,7 +176,7 @@ LaTeX("The quadratic formula is $$x=\\frac{-b\\pm\\sqrt{b^2-4ac}}{2a}$$ and it h
 
 > <img src="./assets/images/blocks.png" width="430" height="350">
 
-#### 🔢 Numbered Block Equations
+#### Numbered Block Equations
 
 The `LaTeX` view can do simple numbering of block equations with the `blockViews` block mode.
 
@@ -211,7 +213,7 @@ LaTeX("$$E = mc^2$$ $$E = mc^2$$")
 
 > <img src="./assets/images/numbers.png" width="433" height="153">
 
-#### 🔗 Unencode HTML
+#### Unencode HTML
 
 Input may contain HTML entities such as `&lt;` which will not be parsed by LaTeX as anything meaningful. In this case, you may use the `unencoded` modifier.
 
@@ -226,19 +228,46 @@ LaTeX("$x^2&lt;1$")
 
 > <img src="./assets/images/unencoded.png" width="72.5" height="34">
 
-#### 🕶️ Rendering Style
+#### Ignore String Formatting
+
+The `LaTeX` view will render the following markdown synatax.
+
+| Syntax | Description |
+|-------------|-------------|
+| `*...*` | Italic |
+| `**...**` | Bold |
+| `***...***` | Bold & Italic |
+| `~~...~~` | Strikethrough |
+| `` `...` `` | Monospaced |
+| `[...](...)` | Links |
+
+If you don't want markdown rendered, then you may use the `ignoreStringFormatting` modifier.
+
+```swift
+LaTeX(input)
+  .ignoreStringFormatting()
+```
+
+##### Escaped Characters
+
+The characeters `&`, `%`, `$`, `#`, `_`, `{`, `}`, `~`, `^`, and `\` are reserved characters in LaTeX and may appear in a document with an escape characeter preceeding them.
+
+The view will look for these characters preceeded by an escape, and replace them with the non-escaped version. If you would like to prevent this replacement, then you may use the `ignoreStringFormatting` modifier.
+
+#### Rendering Style
 
 The view has four rendering styles. The `wait` style is the default style, and loads the view synchronously on the main queue. To get better performance and move SVG rendering off of the main queue, use any of the other three styles.
 
 | Style      | Asynchronous | Description                                                              |
 |:-----------|:-------------|:-------------------------------------------------------------------------|
-| `empty`    | Yes          | The view remains empty until its finished rendering.                     |
-| `original` | Yes          | The view displays the input text until its finished rendering.           |
-| `progress` | Yes          | The view displays a progress view until its finished rendering.          |
-| `wait`     | No           | *(default)* The view blocks the main queue until its finished rendering. |
+| `empty`    | Yes          | The view remains empty until it's finished rendering.                     |
+| `original` | Yes          | The view displays the input text until it's finished rendering.           |
+| `redactedOriginal` | Yes  | The view displays a redacted version of the view until it's finished rendering |
+| `progress` | Yes          | The view displays a progress view until it's finished rendering.          |
+| `wait`     | No           | *(default)* The view blocks the main queue until it's finished rendering. |
 
 
-#### 🪩 Rendering Animation
+#### Rendering Animation
 
 When using the asynchronous rendering styles `empty`, `original`, or `progress`, use this modifier to determine the animation applied to the transition between views. The default value is `none`.
 
@@ -250,7 +279,7 @@ LaTeX(input)
 
 > In the above example, the input text will be displayed until the SVGs have been rendered at which point the rendered views will animate in to view.
 
-### 🪮 Styles
+### Styles
 
 You can use the provided view styles or create your own.
 
@@ -288,7 +317,7 @@ public struct TitleLaTeXStyle: LaTeXStyle {
 }
 ```
 
-### 🗄️ Caching
+### Caching
 
 `LaTeXSwiftUI` caches its SVG responses from MathJax and the images rendered as a result of the view's environment. If you want to control the cache, then you can access the static `dataCache` and `imageCache` properties.
 
@@ -300,7 +329,7 @@ LaTeX.dataCache.removeAllObjects()
 LaTeX.imageCache.removeAllObjects()
 ```
 
-### 🏃‍♀️ Preloading
+### Preloading
 
 SVGs and images are rendered and cached on demand, but there may be situations where you want to preload the data so that there is minimal lag when the view appears.
 

Sources/LaTeXSwiftUI/Extensions/EnvironmentValues+Extensions.swift

@@ -74,11 +74,7 @@ private struct RenderingAnimationKey: EnvironmentKey {
   static let defaultValue: Animation? = .none
 }
 
-private struct IgnoreEscapedCharactersKey: EnvironmentKey {
-  static let defaultValue: Bool = false
-}
-
-private struct IgnoreMarkdownKey: EnvironmentKey {
+private struct IgnoreSringFormatting: EnvironmentKey {
   static let defaultValue: Bool = false
 }
 
@@ -156,16 +152,10 @@ extension EnvironmentValues {
     set { self[RenderingAnimationKey.self] = newValue }
   }
 
-  /// Whether escaped characeters should be ignored or replaced.
-  var ignoreEscapedCharacters: Bool {
-    get { self[IgnoreEscapedCharactersKey.self] }
-    set { self[IgnoreEscapedCharactersKey.self] = newValue }
-  }
-  
-  /// Whether markdown should be ignored or rendered.
-  var ignoreMarkdown: Bool {
-    get { self[IgnoreMarkdownKey.self] }
-    set { self[IgnoreMarkdownKey.self] = newValue }
+  /// Whether string formatting such as markdown should be ignored or rendered.
+  var ignoreStringFormatting: Bool {
+    get { self[IgnoreSringFormatting.self] }
+    set { self[IgnoreSringFormatting.self] = newValue }
   }
 
 }

Sources/LaTeXSwiftUI/Extensions/View+Extensions.swift

@@ -162,45 +162,12 @@ public extension View {
     environment(\.renderingAnimation, animation)
   }
 
-  /// Sets whether the view should ignore escaped characters or replace them.
+  /// Whether string formatting such as markdown should be ignored or rendered.
   ///
-  /// The characeters `&`, `%`, `$`, `#`, `_`, `{`, `}`, `~`, `^`, and `\` are
-  /// reserved characters in LaTeX and may appear in a document with an escape
-  /// characeter preceeding them.
-  ///
-  /// Set this environment variable to `true` to render the escape and the
-  /// character, or to `false` to have the view replace the escaped characeter
-  /// with itself.
-  ///
-  /// For example
-  ///
-  /// ```
-  /// LaTeX("Bob has \$5.00")
-  /// ```
-  ///
-  /// will display `Bob has $5.00`.
-  ///
-  /// Whereas
-  ///
-  /// ```
-  /// LaTeX("Bob has $5.00")
-  ///   .ignoreEscapedCharacters()
-  /// ```
-  ///
-  /// will display `Bob has \$5.00`.
-  ///
-  /// - Parameter ignore: Whether to ignore escaped characters.
-  /// - Returns: A view that ignores or replaces escaped characters.
-  func ignoreEscapedCharacters(_ ignore: Bool = true) -> some View {
-    environment(\.ignoreEscapedCharacters, ignore)
-  }
-  
-  /// Whether markdown should be ignored or rendered.
-  ///
-  /// - Parameter ignore: Ignore markdown.
-  /// - Returns: A view that ignores or renders markdown.
-  func ignoreMarkdown(_ ignore: Bool = true) -> some View {
-    environment(\.ignoreMarkdown, ignore)
+  /// - Parameter ignore: Ignore string formatting.
+  /// - Returns: A view that ignores or renders string formatting.
+  func ignoreStringFormatting(_ ignore: Bool = true) -> some View {
+    environment(\.ignoreStringFormatting, ignore)
   }
 
 }

Sources/LaTeXSwiftUI/LaTeX.swift

@@ -157,11 +157,8 @@ public struct LaTeX: View {
   /// The animation the view should apply to its rendered images.
   @Environment(\.renderingAnimation) private var renderingAnimation
 
-  /// Whether escaped characters should be ignored or replaced.
-  @Environment(\.ignoreEscapedCharacters) private var ignoreEscapedCharacters
-  
-  /// Whether markdown should be ignored or rendered.
-  @Environment(\.ignoreMarkdown) private var ignoreMarkdown
+  /// Whether string formatting such as markdown should be ignored or rendered.
+  @Environment(\.ignoreStringFormatting) private var ignoreStringFormatting
 
   /// The view's current display scale.
   @Environment(\.displayScale) private var displayScale

Sources/LaTeXSwiftUI/Models/Component.swift

@@ -198,9 +198,8 @@ extension Component {
   ///   - errorMode: The error handling mode.
   ///   - blockRenderingModel: The rendering mode of the block.
   ///   - isInEquationBlock: Whether this block is in an equation block.
-  ///   - ignoreEscapedCharacters: Whether escaped characters should be ignored
-  ///     or replaced.
-  ///   - ignoreMarkdown: Whether markdown should be ignored or rendered.
+  ///   - ignoreStringFormatting: Whether string formatting such as markdown
+  ///     should be ignored or rendered.
   /// - Returns: A text view.
   func convertToText(
     font: Font,
@@ -209,8 +208,7 @@ extension Component {
     errorMode: LaTeX.ErrorMode,
     blockRenderingMode: LaTeX.BlockMode,
     isInEquationBlock: Bool,
-    ignoreEscapedCharacters: Bool,
-    ignoreMarkdown: Bool
+    ignoreStringFormatting: Bool
   ) -> Text {
     // Get the component's text
     let text: Text
@@ -238,30 +236,38 @@ extension Component {
       }
     }
     else if blockRenderingMode == .alwaysInline {
-      let input = replaceEscapedCharacters(in: originalTextTrimmingNewlines, ignoreEscapedCharacters: ignoreEscapedCharacters)
-      if ignoreMarkdown { text = Text(input) }
-      else { text = Text(LocalizedStringKey(input)) }
+      text = formattedText(input: originalTextTrimmingNewlines, ignoreStringFormatting: ignoreStringFormatting)
     }
     else {
-      let input = replaceEscapedCharacters(in: originalText, ignoreEscapedCharacters: ignoreEscapedCharacters)
-      if ignoreMarkdown { text = Text(input) }
-      else { text = Text(LocalizedStringKey(input)) }
+      text = formattedText(input: originalText, ignoreStringFormatting: ignoreStringFormatting)
     }
 
     return text
   }
 
-  /// Replaces the escaped characters in the input text if the component type is
-  /// `text` and ignore escaped characters is false.
+  /// Formats the input text and returns a text view.
   ///
   /// - Parameters:
-  ///   - text: The text to replace.
-  ///   - ignoreEscapedCharacters: Whether escaped characters should be ingored
-  ///     or replaced.
-  /// - Returns: The replaced text.
-  func replaceEscapedCharacters(in text: String, ignoreEscapedCharacters: Bool) -> String {
-    guard type == .text && !ignoreEscapedCharacters else { return text }
-    return Replacer.replace(text)
+  ///   - input: The plaintext to format.
+  ///   - ignoreStringFormatting: Whether the method should ignore formatting.
+  /// - Returns: A text view.
+  func formattedText(input: String, ignoreStringFormatting: Bool) -> Text {
+    if ignoreStringFormatting {
+      return Text(input)
+    }
+    else {
+      do {
+        return Text(try AttributedString(
+          markdown: input,
+          options: AttributedString.MarkdownParsingOptions(
+            allowsExtendedAttributes: true,
+            interpretedSyntax: .inlineOnlyPreservingWhitespace,
+            failurePolicy: .returnPartiallyParsedIfPossible)))
+      }
+      catch {
+        return Text(input)
+      }
+    }
   }
 
 }