Texas

Crates.ioTexas
lib.rsTexas
version0.2.3
sourcesrc
created_at2023-06-27 13:49:54.87978
updated_at2023-07-26 15:13:59.183975
descriptionCrate to generate latex documents
homepage
repositoryhttps://github.com/Abhay478/Texas
max_upload_size
id901316
size42,947
Abhay Shankar K (Abhay478)

documentation

https://docs.rs/Texas/0.2.2

README

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, 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, "\\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"))?;
  • Will add ability to generate stuff like ensuremath from code eventually.
  • Packages can be created and installed like so:
doc.new_package(package!("parskip", "parfill"));
  • Also has trait Opt, which allows for adding options to a command (like usepackage and documentclass, for now).

Log

  • 0.1.7

    • package! macro wasn't working, fixed that.
    • Moved the modules to the front (re-exported them in lib.rs) for convenience.
  • 0.1.8

    • Small whoops. Latex errors due to Line code.
  • 0.1.9

    • Brought structs into scope.
  • 0.2.1

    • Documentation is a thing now.
  • 0.2.2

    • Images and tables.
    • Fixed a few documentation hiccups.
    • Fixed another problem with the package! macro. Wasn't really crippling to begin with.
  • 0.2.3

    • Lil cleanup
    • Finally added the ensuremath stuff. Adding a bunch more.
Commit count: 14

cargo fmt