https://github.com/chazeon/revtex2docx

Wrapper scripts and pandoc filters to convert LaTeX documents to Word docx files
https://github.com/chazeon/revtex2docx

docx latex pandoc pandoc-filter

Last synced: about 2 months ago
JSON representation

Wrapper scripts and pandoc filters to convert LaTeX documents to Word docx files

• Host: GitHub
• URL: https://github.com/chazeon/revtex2docx
• Owner: chazeon
• License: mit
• Created: 2024-05-23T03:22:54.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-06-07T21:29:47.000Z (7 months ago)
• Last Synced: 2024-06-07T22:40:25.734Z (7 months ago)
• Topics: docx, latex, pandoc, pandoc-filter
• Language: Python
• Homepage:
• Size: 1.41 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RevTeX2docx

[![Python tests](https://github.com/chazeon/revtex2docx/actions/workflows/python-tests.yml/badge.svg)](https://github.com/chazeon/revtex2docx/actions/workflows/python-tests.yml)

[![codecov](https://codecov.io/github/chazeon/revtex2docx/graph/badge.svg?token=KLDNP7JUWE)](https://codecov.io/github/chazeon/revtex2docx)

This repo includes wrapper scripts (currently implemented in [`just`][1] script) and [`pandoc` filters][2] to convert LaTeX files written (especially, in the RevTeX format) to docx files. In addition to `pandoc`'s built-in features, the filters and wrapper scripts are designed to handle the following:

* Cross-reference numbering for equations, figures, tables and titles: this is achieved by reading the `.aux` files generated at LaTeX compile time.

* Include author blocks (author and affiliations) in the title page.

* Include the equation numbers.

* Replacing unsupported LaTeX commands with their supported equivalents.

## Usage

Install the dependencies, including `pandoc`, `just`, a LaTeX distribution with `latexmk`, and Python packages `pandocfilters` and `texsoup` used by the filters.

Then drop the zipped LaTeX files as `src.zip` into this current folder and run the following command:

```bash

just src docx

```

This will unzip the `src.zip` file into the `src` folder, and convert the LaTeX files to docx files. The `docx_supp` target will also generate a supplementary docx file that includes the supplementary information files.

For additional targets, look into the `justfile` script.

## Known issues

Currently, some issues persist:

* The text replacements in the `just` script are performed with `sed`, the command is written in a way that works with the macOS's `sed` command around the use of `-i` flag. 

* The first paragraph after the equation, will always be indented.

* Ubuntu 22.04 LTS still uses `pandoc` 2.x, which does not support the `--citeproc` flag. This is required for the citation and bibliography to be generated correctly. One should use the deb package from the `pandoc` GitHub releases to install the latest version. Alternatively, one can install `the pandoc-citeproc` package and use the `--filter pandoc-citeproc` flag.

* Book format (chapters) is not supported.

## Roadmap

* Add tests and examples (LaTeX source and aux file).

* Add docx templates based on the LaTeX source.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

[1]: https://github.com/casey/just

[2]: https://pandoc.org/filters.html