Skip to main content

Code documentation

Development tools

Code Structure

Techniques and Standards

How To

Functional Info

Background Info

JMRI: Web Site

This page discusses technical aspects behind the JMRI web site at jmri.org and also providing parts of the help system in JMRI.

If you just want to know how to make a small change to a web or help page, please see the Updating JMRI Documentation instructions.

Structure of Information

We distinguish between three types of information on the main web site:

  1. User information which is useful at run time. This is made available both via our JavaHelp, and also directly by placing those files on the web.
  2. User information which is either not useful at run time, such as instructions for installing the software, or is too large for inclusion in releases, e.g. video clinics.
  3. Reference information from releases, such as decoder definitions, copies of scripts, JavaDocs, etc.

We provide these separately:

  1. Run-time user information is made available by putting the help system on the web site.
  2. Other user information is stored in our JMRI/website GitHub repository and placed directly on the web site.
  3. Reference information is put on the web site from their own repository locations, or created by automated Ant scripts during release builds.

Technology

Page formatting is done using CSS, originally set up by John Plocher. All pages should reference the CSS files for screen and printing from the "/css" directory. This also means that you should leave the formatting to the style sheets, and minimize the explicit formatting that you do in HTML directly.

Because we use our web pages in JavaHelp, there are some restrictions on use of tags. See our JavaHelp web page for more on this.

We are using server-side includes to provide consistent headers, sidebars and footers. This allows us to share HTML content between the web and the JavaHelp system used by the program itself. Each page will contain just content, plus includes for files named "Header", "Sidebar" and "Footer" which contain the navigation information. Eventually, all but a few index pages will have ".shtml" extensions. (The remaining index.html pages keep that name so that people who request just a directory URL will be served something useful).

We are using .htaccess files to do redirects when a web page is removed. This lets older bookmarks continue to work. The hardware/.htaccess file provides an example. For more information on the syntax, see the Apache mod_rewrite documentation.

Directory Organization

The web site contains several separate areas:

Another group are from the JMRI/website repository, and are checked out at the root of the web server.

Finally, some of the site is generated from the JMRI source itself, as opposed to being contained in the source. The Javadoc is one such section, along with some of the human-readable information about defined decoders.

Updating the jmri.org site

Most of the web site contents is updated hourly from jobs running on one of the project's Jenkins build servers. The directories listed above constitute most of the site, and this content is updated from the JMRI repository without any additional work.

The regeneration of the Javadoc and xml content involves significantly more work than merely updating a directory, and so these are only done once per day, as needed, by the Generate Website job on the production Jenkins server.

Local Web Site: Mac OS X

If you want to host a copy of the JMRI web site on your local Mac OS X machine, follow these instructions to first configure the Apache server to do server-side includes, and then make a copy of the web site files available to the server.

A similar process may work for Linux (or even Windows) systems with Apache installed.

  1. To make sure that your local server has the right options enabled, edit the Apache web server's configuration file.
    • On Mac OS X 10.4 (Tiger), this is the /etc/httpd/httpd.conf file
    • On Mac OS X 10.5 (Leopard) and later, this is the /etc/apache2/httpd.conf file
    Once you've located the file, open it with your favorite editor (You'll need to authenticate with the administrator password to modify this file).
    • To turn on server-side includes, find the section that looks like 
              # This may also be "None", "All", or any combination of "Indexes",
        # "Includes", "FollowSymLinks", "ExecCGI", or "MultiViews".
        #
        # Note that "MultiViews" must be named *explicitly* --- "Options All"
        # doesn't give it to you.
        #
            Options Indexes FollowSymLinks MultiViews
      Add the word "Includes" to the last line so it looks like 
                  Options Includes Indexes FollowSymLinks MultiViews
    • Now, configure the server to handle files with ".shtml" extensions. Find the section that looks like (the leading comment may be different): 
                  #
            # To use server-parsed HTML files
            #
            #AddType text/html .shtml
            #AddHandler server-parsed .shtml
      and un-comment the last two lines so that it looks like 
                  #
            # To use server-parsed HTML files
            #
            AddType text/html .shtml
            AddHandler server-parsed .shtml
      Then find the reference to the include_module and make sure it's loaded by a line like: 
              LoadModule include_module libexec/apache2/mod_include.so
      By default, that's commented out with a leading # character.
    • Finally, configure the server to allow .htaccess files to provide redirects. We use this to allow people with old URLs in bookmarks to reach the right current pages.

      Find a section that looks like: 

              DocumentRoot "/Library/WebServer/Documents"
        Directory "/Library/WebServer/Documents"
      There's an indented section directly below that. Find the part that looks like: 
                  #
            # AllowOverride controls what directives may be placed in .htaccess files.
            # It can be "All", "None", or any combination of the keywords:
            #   AllowOverride FileInfo AuthConfig Limit
            #
            AllowOverride None
      Change the last line to allow overrides (which is what a .htaccess file does): 
                  AllowOverride All
      Then find the reference to the rewrite_module and make sure it's loaded by a line like: 
              LoadModule rewrite_module libexec/apache2/mod_rewrite.so
      By default, that's commented out with a leading # character.

      JMRI's web site uses index.shtml files as index pages. To make sure that those will display by default, e.g. if you use a partial URL like http://jmri.org/download, find the line containing "DirectoryIndex" and add "index.shtml" to the existing list of index-like file names.

      We also want PHP turned on, so that the indices for the resources pages will work. Find the follow line and make sure it's not commented out: 

              LoadModule php5_module libexec/apache2/libphp5.so
  2. Install the JMRI files to be served:
    • Check out both the JMRI/JMRI and JMRI/website repositories to somewhere on your computer. It's OK for these to be outside the web server's directory tree.
    • Change to the web server directory 
              cd /Library/WebServer/Documents
    • Set symbolic links to bring in content from the two repositories: 
              ~me/git/website/setSymLinks.sh  ~me/git/JMRI ~me/git/website
      where "~me/git/website" is the path to the JMRI/website repository that you just checked out, and "~me/git/JMRI" is the path to the JMRI/website repository. setSymLinks.sh sets up symbolic links that let your web server see the top of the JMRI web site as if the files were directly present.
  3. Restart your computer to reinitialize the web server.
  4. Test it by trying to display the URL http://localhost/index.shtml, which should get you a JMRI top-level page.

Installing a local XML catalog

Many JMRI XML files contain XIncludes that reference other XML files with URLs like "http://jmri.org/xml/schema/types/turnouts-2-9-6.xsd". When a JMRI program encounters those, it automatically converts those to a local file reference. Other tools, like NetBeans and xmllint, don't know to do that.

Installing a local XML catalog, and then telling your tools to use it, can solve this.