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

What is the criteria for contributing to the Tikz library? #1311

Open
u7166251 opened this issue Mar 8, 2024 · 1 comment
Open

What is the criteria for contributing to the Tikz library? #1311

u7166251 opened this issue Mar 8, 2024 · 1 comment

Comments

@u7166251
Copy link

u7166251 commented Mar 8, 2024

Brief outline of the proposed feature

Dear administrator, can I ask if an individual develop a library to implement some functionality, what should we do to add it into the public library (e.g. code quality level, document standard)?

Usage example

No response

@muzimuzhi
Copy link
Member

muzimuzhi commented Mar 11, 2024

There are no must-obey rules I think.

  • Naming of entrance file
    If you'd like to let your tikz library loadable with \usetikzlibrary{<lib-name>}, then your library should provide a file named tikzlibrary<lib-name>.code.tex. Of course your code can live as a standalone (LaTeX) package and there're already quite some, see https://ctan.org/topic/pgf-tikz.
  • Maintaining and releasing
    As you may noticed the tikz package now moves slow. The newest version 3.1.10 was released 14 months ago. So personally I would suggest new libraries to be maintained separately so they can be released at own pace. You could invite pgf-tikz members and/or tikz experts on tex.stackexchange.com to review your code.
  • Naming of internal control sequences
    Some (but not all!) official tikz libraries name their control sequences with a \tikz@lib@<full-or-short-lib-name> prefix. If code is written in LaTeX3, then you only need to choose a free-to-use module name (also called prefix), see registered prefixes in l3prefixes.csv.
  • Documentation
    The pgfmanual itself is documented using markup environments and commands from pgfmanual package. Though the pgfmanual.sty is released as part of tikz, it's "completely undocumented" (Documentation for the pgfmanual package #1059) and I'm afraid there're still some configuration hidden in files in ./doc of this repository. So again you're free to document your tikz library in any way you like.

An example of relatively light and recent third-party tikz library: https://github.com/T-F-S/tikzfill.

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

No branches or pull requests

2 participants