rust-texas

Crates.iorust-texas
lib.rsrust-texas
version0.3.5
sourcesrc
created_at2023-08-12 12:39:31.445717
updated_at2024-05-31 14:39:03.74276
descriptionCrate to generate latex documents
homepage
repositoryhttps://github.com/Abhay478/texas
max_upload_size
id942720
size70,007
Abhay Shankar K (Abhay478)

documentation

https://docs.rs/rust-texas/latest/rust-texas

README

TEXAS

This crate used to be Texas with a capital T. An issue was raised, and thus I have 'renamed' it the only way I know how. Apologies for any inconvenience. It is now rust-texas.

Purpose

This crate does not, in any way, even remotely cover the vast variety of things you can do with latex. Instead, it attempts to provide a friendly API for some of the most basic functions. Furthermore, it does not catch most latex errors.

It's also my first foray into the open-source world, so constructive criticism is welcome and appreciated. https://github.com/Abhay478/texas/issues

Basics

  • The primary type is Document, which you populate per your whims and fancies. This can be written to a file like so:
let mut q = File::create("file.tex")?;
let doc = document!("book");
write!(q, "{}", doc.to_string())?
  • The document can be filled with Components (inclluding Labels, References, Environments, etc.), Packages, and Commands. They can be created using both functions and macros.
  • Component is an enum, with each variant containing a separate struct. If a component impls the Populate trait, you can fill it with more Components, then install it in the Document like so:
let mut p1 = part!("one");
p1.attach(chapter!("c1"))?
    .attach(chapter!("c2"))?; // and so on.

p1.attach_vec(vec![chapter!("c3"); 2])?;

doc.new_component(p1);
  • Commands can be created and installed like so:
doc.new_command(Command::new("brak", 1, r"\ensuremath{\left(#1\right)}"));
  • And commands can be called in-text like so:
let mut p1 = section!("one");
p1.attach(command!(doc, "brak", "hello there"))?;
  • Packages can be created and installed too:
doc.new_package(package!("parskip", "parfill"));
  • Also has trait Opt, which allows for adding options to a command (like usepackage and documentclass, for now).
    • Opt is now implemented for environments

Components

We have a lot of them.

Hierarchy

These are regions in the document.

  • Part
  • Chapter
  • Section
  • Subsection
  • Paragraph
  • Line

Beamer

Support for beamer has been around since 0.3.0. The following components are available:

  • Frame
  • Block

Environments

Well, I haven't added all of them. You can't make your own environments (that's upcoming) but you can use any environment with the Environment struct.

  • Environment
  • List: Specialised struct for Itemize and Enumerate environments.
  • Figure: Specialised struct for the Figure environment.

Basic Text

  • TextChunk: Text of several different types (normal, italic, bold, etc.). Refer the TextType enum for more.

Tables

  • Table
  • Row: A series of TextChunks seperated by &. Can be used in align environments too.

Builtin

  • Builtin: All the little symbols (\phi, \infty) and stuff (\ensuremath). Refer the BuiltinType enum for more.

Labels

  • Label
  • Reference

Misc

  • Image
  • Command
  • Input

Log

  • 0.3.0

    • Aight, this is a big one.
    • Added Beamer documentclass.
      • Yet to add themes.
    • Added more TextTypes.
    • Added with_components methods to various structs.
    • Some cleanup.
  • 0.3.5

    • Added Labels! Again, something no other Latex crate has as far as I know.
    • Made a prelude! For anything texas-y, just add use rust_texas::prelude::*;.
    • Split component.rs and document.rs into multiple files.
    • Made documents include graphicx and hyperref by default.
    • Added more TextTypes.
    • Fixed a few bugs with Opt, namely that it was doing nothing for environments.
    • Other minor changes.
Commit count: 14

cargo fmt