README.md

Thu, 19 Oct 2023 15:40:04 -0500

author
Tuomo Valkonen <tuomov@iki.fi>
date
Thu, 19 Oct 2023 15:40:04 -0500
changeset 5
3716d0eaa356
parent 4
8082eb5a754b
permissions
-rw-r--r--

Add changes-simple

0
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
1
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
2 # strip-changes-markup
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
3
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
4 This program removes [changes](https://www.ctan.org/pkg/changes) package markup from LaTeX documents. It was written because none of the existing regular expression based scripts actually worked on any sort of complex markup. This program (written in [Rust](https://www.rust-lang.org)) is not based on regular expressions, but has an actual semi-proper parser.
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
5
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
6 ## Installation and usage
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
7
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
8 1. Install [Rust](https://www.rust-lang.org) following instructions.
3
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
9 2. To compile and install the program (typically in `~/.cargo/bin/`), run
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
10 ```
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
11 cargo install --path=.
0
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
12 ```
3
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
13 If you would prefer just building or running the program without installing, use `cargo build` or `cargo run`.
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
14 4. To process a document, use
0
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
15 ```
4
8082eb5a754b doc typofix
Tuomo Valkonen <tuomov@iki.fi>
parents: 3
diff changeset
16 strip-changes-markup input.tex -o output.tex
3
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
17 ```
0
548bf3cc032e Initial rough version
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
18
3
cec573b16b46 Add command line options for input and output files
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
19 For further options, such as whitespace and comment stripping, use the `--help` argument (`cargo run -- --help` when running through `cargo` without installing).
5
3716d0eaa356 Add changes-simple
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
20
3716d0eaa356 Add changes-simple
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
21 ## Miscellaneous
3716d0eaa356 Add changes-simple
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
22
3716d0eaa356 Add changes-simple
Tuomo Valkonen <tuomov@iki.fi>
parents: 4
diff changeset
23 Included is also a plug-in replacement `changes-simple` package for LaTeX, that is less likely to blow up with broken journal styles than the more complex `changes` package.

mercurial