SBMLPkgSpec

The SBMLPkgSpec class for LaTeX provides a standard document format for SBML Level 3 package specifications.

License: This code is licensed under the LGPL version 2.1. Please see the file LICENSE.txt for details.

Repository: https://github.com/sbmlteam/sbmlpkgclass

Developers' discussion group: https://groups.google.com/forum/#!forum/sbml-discuss

🏁 Recent news and activities

September 2017: Fixed another bug in footers and headers of the appendix section, caused by an incomplete fix in version 1.7.2. Hopefully this is the last of it.

August 2017: Fixed bug in commands for referencing sections, caused by a poor implementation of \apdx. This fixes the problem that references to sections would sometimes end up as Section Appendix 3.3.12. (Thanks to Lucian Smith for reporting this issue.)

May 2017: Moved the SBMLPkgClass directory to a separate GitHub repository, away from its original location as a subdirectory in the general SBML project area on SourceForge. There are no code, LaTeX or licensing changes in this release.

☀ Introduction

SBML is an XML-based format for storing and communicating computational models of biological processes. SBML Level 3 packages are optional modular extensions to the core of SBML to add constructs that support additional features. The specification documents for SBML Level 3 packages define the syntax and semantics of individual SBML Level 3 packages.

The SBMLPkgSpec class for LaTeX provides a standard format for SBML Level 3 package specification documents. It provides a uniform look-and-feel to the family of SBML Level 3 documents, and provides guidance to specification authors about the information that should be included in each specification.

⚙️ Installation and configuration

Before using SBMLPkgClass in a document, you will need to download the distribution or clone this GitHub repository to your computer, and adjust your TeX/LaTeX installation to find your copy of SBMLPkgClass. (The instructions for this differ depending on your system; various tips can be found, e.g., on tex.stackexchange.com.)

► Usage

Once you have a copy of the package and your LaTeX installation can find it, the basic approach to using SBMLPkgClass is simple: you create a .tex file in your favorite text editor and start with a template such as this example:

\documentclass{sbmlpkgspec}
\begin{document}

\packageTitle{Example}
\packageVersion{Version 1 (Draft)}
\packageVersionDate{14 August 2011}
\packageGeneralURL{http://sbml.org/Documents/Specifications/Example}
\packageThisVersionURL{http://sbml.org/Documents/Specifications/Example_14_August_2011}

\author{Michael Hucka\\[0.25em]
  \mailto{mhucka@caltech.edu}\\[0.25em]
  Computing and Mathematical Sciences\\
  California Institute of Technology\\
  Pasadena, CA, USA
}

\maketitlepage
\maketableofcontents

\section{...}
...
\end{document}

However, there are few more considerations and guidelines besides this. Please make sure to read the user's guide to SBMLPkgSpec in the file titled sbmlpkgspec-doc.pdf. This file explains everything you need to know to use SBMLPkgClass, and includes tips for how to make the most of this specialized LaTeX document class.

⁇ Getting help and support

If you find an issue, please submit it in the GitHub issue tracker for this repository. Alternatively, you are welcome to contact the author or the SBML Team via email with questions about SBMLPkgClass.

♬ Contributing

I welcome improvements of all kinds, no matter how small, to the code and to the documentation! If you know how to fix an issue and want to contribute the fix (and be acknowledged) please feel free to do the following:

Fork this repo. See the links at the top of the github page.
Create your feature branch (git checkout -b my-new-feature) and write your changes to the code or documentation.
Commit your changes (git commit -am 'Describe your changes here').
Create a new pull request to notify me of your suggested changes.

Please be aware that this project follows the common code of conduct for SBML Team projects.

🏛 Copyright and license

SBMLPkgClass is distributed freely under the terms of the LGPL. Please see the file LICENSE.txt for more copyright and license details.

❤️ Acknowledgments

Funding for this and other SBML work has come from the National Institute of General Medical Sciences via grant NIH R01 GM070923 (Principal Investigator: Michael Hucka).

fakirAyoub/sbmlpkgspec