feat: basic text mode #86

OrangeX4 · 2023-12-28T06:32:33Z

Basic text mode support, you can use it to write LaTeX drafts.
- \section, \textbf, \emph.
- Inline and block math equations.
- \ref, \eqref and \label.
- itemize and enumerate environments.

Use mitex-convert to convert LaTeX code into Typst code in string.
Use mi to embed an inline LaTeX equation into Typst.
Use mitex(numbering: none, supplement: auto, ..) to embed a block LaTeX equation into Typst.
Use mitext to embed a LaTeX text into Typst.

#import "@preview/mitex:0.1.0": *

#mitext(`
  \iftypst
    #set math.equation(numbering: "(1)", supplement: "equation")
  \fi

  \section{Title}

  A \textbf{strong} text, a \emph{emph} text and inline equation $x + y$.
  
  Also block \eqref{eq:pythagoras}.

  \begin{equation}
    a^2 + b^2 = c^2 \label{eq:pythagoras}
  \end{equation}
  
  \begin{enumerate}
    \item This is the first item
    \item This is the second item
    \begin{itemize}
      \item This is the first subitem
      \item This is the second subitem
    \end{itemize}
  \end{enumerate}
`)

Myriad-Dreamin

Added some comments

Myriad-Dreamin · 2023-12-28T13:40:17Z

crates/mitex/src/lib.rs

@@ -476,9 +611,39 @@ static DEFAULT_SPEC: once_cell::sync::Lazy<CommandSpec> = once_cell::sync::Lazy:
 #[cfg(test)]
 mod tests {
    use insta::{assert_debug_snapshot, assert_snapshot};
+    use mitex_parser::spec::CommandSpec;
+
+    static DEFAULT_SPEC: once_cell::sync::Lazy<CommandSpec> = once_cell::sync::Lazy::new(|| {


Since there is already a DEFAULT_SPEC in crate, we can import it by use crate::DEFAULT_SPEC;

Myriad-Dreamin · 2023-12-28T13:43:21Z

crates/mitex/src/lib.rs

-            self.2.borrow_mut().push_str(&e.to_string());
+        let mut ctx = Converter::new(self.1);
+        if let Err(e) = ctx.convert(f, self.0.clone(), &self.2) {
+            self.3.borrow_mut().push_str(&e.to_string());


There are two many fields in a single tuple. I would prefer to refactoring TypstMathRepr as

struct TypstRepr { elem: LatexSyntaxElem, mode: LaTeXMode, spec: CommandSpec, error: Rc<RefCell<String>> }

Myriad-Dreamin

Nice work. 😁

Myriad-Dreamin · 2023-12-30T09:44:42Z

README.md


 ## Features to Implement

 - [ ] Pass command specification to MiTeX plugin dynamically. With that you can define a typst function `let myop(it) = op(upright(it))` and then use it by `\myop{it}`.
 - [ ] Package support, which means that you can change set of commands by telling MiTeX to use a list of packages.
- [ ] Text mode support, enabling the rendering entire LaTeX documents in Typst!
+- [ ] More text mode support, enabling the rendering entire LaTeX documents in Typst!


"More text mode support" is not rather descriptive, could we mention at least one direction to improve?

Myriad-Dreamin · 2023-12-30T09:55:34Z

crates/mitex/src/lib.rs

+            TokenWhiteSpace => {
+                if self.skip_next_space {
+                    self.skip_next_space = false;
+                    return Ok(());
+                }
+                write!(f, "{}", elem.as_token().unwrap().text())?;
+            }
+            TokenLineBreak => {
                write!(f, "{}", elem.as_token().unwrap().text())?;
+                // indent for itemize and enumerate
+                for _ in 0..self.indent {
+                    f.write_char(' ')?;
+                }
+                self.skip_next_space = true;


A state switch self.skip_next_space looks easily broken to me. It doesn't quite resist AST changes. We may take a look on how typst processes spaces, which should be inspiring.

And I also think it is okay to have self.skip_next_space merged into main currently, but may we create a todo for it?

Myriad-Dreamin · 2023-12-30T10:02:25Z

crates/mitex/src/lib.rs

+                if name == "item" {
+                    if matches!(self.env, LaTeXEnv::Itemize | LaTeXEnv::Enumerate) {
+                        f.write_char('\n')?;
+                        for _ in 0..(self.indent - 2) {


we can collect indent things into a helper function?

Myriad-Dreamin · 2023-12-30T10:03:35Z

crates/mitex/src/lib.rs

+                        for _ in 0..(self.indent - 2) {
+                            f.write_char(' ')?;
+                        }
+                        if matches!(self.env, LaTeXEnv::Itemize) {


similarly, we can have a helper to make conditional output, which doesn't change performance at all, but improves readability.

Myriad-Dreamin · 2023-12-30T10:10:06Z

packages/mitex/examples/example.typ

+  \section{Title}
+
+  A \textbf{strong} text, a \emph{emph} text and inline equation $x + y$.
+
+  Also block \eqref{eq:pythagoras}.
+
+  \begin{equation}
+    a^2 + b^2 = c^2 \label{eq:pythagoras}
+  \end{equation}
+
+  \begin{enumerate}
+    \item This is the first item
+    \item This is the second item
+    \begin{itemize}
+      \item This is the first subitem
+      \item This is the second subitem
+    \end{itemize}
+  \end{enumerate}


could we shorten example of text mode a bit? Just three to five lines would be okay. IMO, the example should be cool and representative and don't have to show all features.

Myriad-Dreamin · 2023-12-30T10:10:37Z

packages/mitex/mitex.typ

+  if mode == "math" {
+    str(mitex-wasm.convert_math(bytes(get-elem-text(it)), spec))
+  } else {
+    str(mitex-wasm.convert_text(bytes(get-elem-text(it)), spec))


repeated pattern of code

Myriad-Dreamin · 2023-12-30T10:13:02Z

packages/mitex/specs/prelude.typ

+///   Therefore you need to use `(.. arg) = > {..}` to receive them.
+///
+/// Return: A spec item and a scope item (none for no scope item)
+#let define-math-env(num, alias: none, handle: none) = {


we can have a common define-env and the rest of define-xxx-env are just alias to define-env.with(ctx_feature: ...)

Myriad-Dreamin · 2023-12-30T10:14:38Z

packages/mitex/specs/prelude.typ

@@ -210,7 +253,12 @@
    spec.insert(key, value.at(0))
    if value.at(1) != none {


There are many value.at(0) and value.at(1), could be destruct value into nice names?

OrangeX4 added 9 commits December 27, 2023 00:26

dev(mitex): text mode init

3e64fda

dev: add heading, strong and emph

c53aaa3

Merge branch 'main' into text-mode

3b0bcb5

feat: complete basic text mode

a931fb3

style: fix code style

aa913d8

feat: add hack for itemize and enumerate environments

d2a4bfd

feat: basic math equation support

02b3bb4

style: fix code style

72dcd0d

fix: fix bug of ItemCurly

1cace2c

OrangeX4 added the draft label Dec 28, 2023

OrangeX4 changed the title ~~Text Mode for MiTeX~~ feat: text mode Dec 28, 2023

OrangeX4 marked this pull request as draft December 28, 2023 06:34

OrangeX4 added 2 commits December 28, 2023 14:38

fix: rename text handler to textmath

ea66064

test(converter): update tests

8c4d9d5

OrangeX4 assigned OrangeX4 and unassigned OrangeX4 Dec 28, 2023

Myriad-Dreamin reviewed Dec 28, 2023

View reviewed changes

Myriad-Dreamin mentioned this pull request Dec 28, 2023

Plan to convert users' TeX document into Typst code #35

Closed

4 tasks

Myriad-Dreamin linked an issue Dec 28, 2023 that may be closed by this pull request

Plan to convert users' TeX document into Typst code #35

Closed

4 tasks

OrangeX4 added 7 commits December 30, 2023 14:22

feat: add \ref and \eqref

7181596

feat: add support for \begin{equation} \end{equation}

fc45fd7

fix: fix bug in envirionment

199c6fa

refactor(converter): refactor TypstRepr from tuple to struct

3065d66

feat: add \label support

aeb6156

Merge branch 'main' into text-mode

e43aa34

docs: update README for basic text mode

2e39cf3

OrangeX4 removed the draft label Dec 30, 2023

OrangeX4 changed the title ~~feat: text mode~~ feat: basic text mode Dec 30, 2023

OrangeX4 added 2 commits December 30, 2023 17:13

fix: fix \label in math mode

da9c983

fix: add hack to fix \textbf and \textit in math mode

3a32987

docs: remove empty line in README

727d3c2

OrangeX4 requested a review from Myriad-Dreamin December 30, 2023 09:33

OrangeX4 marked this pull request as ready for review December 30, 2023 09:36

Myriad-Dreamin reviewed Dec 30, 2023

View reviewed changes

OrangeX4 added 2 commits December 30, 2023 19:58

style: clean code

eff7aa3

docs: update README and example

dd0df05

OrangeX4 merged commit 6c19bab into main Dec 31, 2023
5 checks passed

OrangeX4 deleted the text-mode branch January 1, 2024 07:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: basic text mode #86

feat: basic text mode #86

OrangeX4 commented Dec 28, 2023 •

edited

Myriad-Dreamin left a comment

Myriad-Dreamin Dec 28, 2023

Myriad-Dreamin Dec 28, 2023

Myriad-Dreamin left a comment

Myriad-Dreamin Dec 30, 2023

Myriad-Dreamin Dec 30, 2023

Myriad-Dreamin Dec 30, 2023 •

edited

Myriad-Dreamin Dec 30, 2023 •

edited

Myriad-Dreamin Dec 30, 2023 •

edited

Myriad-Dreamin Dec 30, 2023

Myriad-Dreamin Dec 30, 2023

Myriad-Dreamin Dec 30, 2023 •

edited

		@@ -210,7 +253,12 @@
		spec.insert(key, value.at(0))
		if value.at(1) != none {

feat: basic text mode #86

feat: basic text mode #86

Conversation

OrangeX4 commented Dec 28, 2023 • edited

Myriad-Dreamin left a comment

Choose a reason for hiding this comment

Myriad-Dreamin Dec 28, 2023

Choose a reason for hiding this comment

Myriad-Dreamin Dec 28, 2023

Choose a reason for hiding this comment

Myriad-Dreamin left a comment

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023 • edited

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023 • edited

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023 • edited

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023

Choose a reason for hiding this comment

Myriad-Dreamin Dec 30, 2023 • edited

Choose a reason for hiding this comment

OrangeX4 commented Dec 28, 2023 •

edited

Myriad-Dreamin Dec 30, 2023 •

edited

Myriad-Dreamin Dec 30, 2023 •

edited

Myriad-Dreamin Dec 30, 2023 •

edited

Myriad-Dreamin Dec 30, 2023 •

edited