SBML.org — the global portal for all things SBML

SBML.org document release and update procedures

The following are some notes about how documents such as specifications are maintained on SBML.org. Note that these steps require ssh access to SBML.org.

SBML package specifications

The first step is to serve the file physically from a URL that follows the pattern given by the following example:

http://sbml.org/specifications/sbml-level-3/version-1/comp/sbml-comp-version-1-release-1.pdf

Achieving that requires going outside of the MediaWiki system running SBML.org and performing the following steps physically on the server via ssh. The following refer to subdirectories of the sbml website tree on SBML.org. For brevity, the root of that tree is indicated as sbml in the text below.

  1. Name the PDF file according to the pattern for SBML specifications. Examples:
    • sbml-level-3-version-1-core.pdf for Core specs.
    • sbml-comp-version-1-release-2.pdf for package specs like the 'comp' spec.
  2. Copy the PDF file to the appropriate subdirectory within sbml/Special/specifications/. For example, there is a subdirectory for the SBML Level 3 Core specification located in sbml-level-3/version-1/core/, and it contains two files, one for the release candidate and another for the final release of the Core specification. The latter file is named sbml-level-3-version-1-core.pdf.
  3. Update the Apache rewrite rules in sbml/specifications/.htaccess to include new rules for the specification. (Note: this is not in /Special! It's a separate subdirectory under sbml.) For a new release of a package specification document, typically this means adding one line that points to the physical location of the PDF file. Here is an example—note that the following must all be on a single line in the file.
RewriteRule ^sbml-level-3/version-1/comp/sbml-comp-version-1-release-2.pdf$ 
/Special/specifications/sbml-level-3/version-1/comp/sbml-comp-version-1-release-2.pdf [R=301,L]

Once the steps above are done, and you have verified that the document is indeed available from a path that starts with http://sbml.org/specifications/sbml-level-3/..., the following separate steps are needed to update the location referenced by other pages and documents.

  1. Create an entry in the list of specifications at co.mbine.org by following the instructions.
  2. Update the entry for the package in the master table of SBML Level 3 packages kept as a Google spreadsheet at http://tinyurl.com/sbml-level-3-package-statuses. Update the columns titled "Link to current specification'" and "Version/date of linked specification".
  3. If the document is an SBML Level 3 package specification, go to the appropriate package status page under http://sbml.org/Documents/Specifications and do the following:
    1. Add a note under the section "Status of specification and/or proposal development" that indicates a new document has been released. (These are the notes with the green dates under the table in that section of the page.) Here is an example.
    2. Update the list of past specification documents for that package by clicking on the link for the line "All previous specification documents" in the table and editing the linked page. Here is an example of a document list page.

Finally, once the links above have been updated, announce the new package at the following sources:

Retrieved from "http://sbml.org/SBML_Projects/SBML.org_document_release_and_update_procedures"

This page was last modified 19:06, 21 February 2013.



Please use our issue tracking system for any questions or suggestions about this website. This page was last modified 19:06, 21 February 2013.