Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List of possible (out-of-the-box) options #448

Open
hughesjs opened this issue Dec 2, 2022 · 1 comment
Open

List of possible (out-of-the-box) options #448

hughesjs opened this issue Dec 2, 2022 · 1 comment

Comments

@hughesjs
Copy link

hughesjs commented Dec 2, 2022

I'm trying to write a C# PGFPlots SDK, so that I can take data crunched in C# and output PGFPlots LaTex.

This means that I need to understand all of the possible components that make up a PGFPlot definition so that I can create C# counterparts to these.

Unfortunately, looking at the official documentation there's a lot of "here's how you do X" but not a lot of "here are all of the possible fields that could go into an axis definition".

For instance, I'm tackling the axis definition first, perhaps this would be better referred to as the axis options, and so far, I have this:

public record AxisDefinition
{
	public string? XLabel { get; init; }
	public string? YLabel { get; init; }
	public float?  XMin   { get; init; }
	public float?  YMin   { get; init; }
	public float?  XMax   { get; init; }
	public float?  YMax   { get; init; }
	
	public List<float> XTicks { get; init; } = new();
	public List<float> YTicks { get; init; } = new();
}

However, I'm fairly sure this is far from comprehensive, and if I have to search for tonnes and tonnes of examples to find all the possible permutations for every command, I'll never finish this project.

What I really need is something that would tell me "here are all the options available for each command", the kind of thing you'd typically get when reading the manpage of a linux util.

Could someone point me towards this (if it exists) or where in the package source I could discern this? Apoliogies in advance, I've very much only ever written documents in LaTex so delving into the inner workings of a complex package such as this entirely unguided is a bit beyond me at this point.

@hmenke
Copy link
Member

hmenke commented Dec 2, 2022

There is no spec and since TeX does not really have types, there is no structured representation in the source either.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants