Difference between revisions of "Creating Scoreboard HTML"

From PC2wiki
Jump to: navigation, search
m (Directions to add a new HTML file: added XSL location in samps)
m (update description/add info)
Line 1: Line 1:
 
[[Scoreboard HTML]] files are automatically generated by the [[scoreboard]] module.
 
[[Scoreboard HTML]] files are automatically generated by the [[scoreboard]] module.
 +
 +
Review the Contest Administrator’s Installation and Configuration Guide (in the doc/ directory)
 +
section 9.7 Adding New HTML Files.
 +
 +
This article describes create html files using pc2. 
 +
 +
pc2 generates scoreboard HTML by generating XML ([[Scoreboard XML]]) then transforming
 +
it into HTML using a XML Sytlesheet ([[XSLT]]) file.
  
 
Each time there is a standings or settings change the [[scoreboard]] module creates
 
Each time there is a standings or settings change the [[scoreboard]] module creates
a [[Scoreboard XML]] then creates an HTML file for each .xsl file found in the <tt>data/xml</tt>
+
a [[Scoreboard XML]] then pc2 loops through all .xsl files found in the scoreboard's <tt>data/xml</tt>
directory.  Each HTML file name is based on the .xsl file name.  For example, for
+
directory and generates html files in the html/ directory.
the sumatt.xsl file a HTML file named sumatt.html is created.
+
 
 +
For example, pc2 will read data/xml/sumatt.xsl file, run in using the [[Scoreboard XML]] as input and create html/sumatt.html.
  
 
==Directions to add a new HTML file==
 
==Directions to add a new HTML file==

Revision as of 13:09, 5 September 2016

Scoreboard HTML files are automatically generated by the scoreboard module.

Review the Contest Administrator’s Installation and Configuration Guide (in the doc/ directory) section 9.7 Adding New HTML Files.

This article describes create html files using pc2.

pc2 generates scoreboard HTML by generating XML (Scoreboard XML) then transforming it into HTML using a XML Sytlesheet (XSLT) file.

Each time there is a standings or settings change the scoreboard module creates a Scoreboard XML then pc2 loops through all .xsl files found in the scoreboard's data/xml directory and generates html files in the html/ directory.

For example, pc2 will read data/xml/sumatt.xsl file, run in using the Scoreboard XML as input and create html/sumatt.html.

Directions to add a new HTML file

  1. Create a new XSLT file
  2. Copy the XSLT file into the scoreboard data/xml directory
  3. Regenerate the scoreboard HTML, use the Refresh button (also see When HTML Pages are created).

Consider copying and using the existing .xsl files supplied with PC² under samps/web/xsl/ directory.

Gotchas

  1. If the HTML file is not generated, insure that the .xsl filename is in the data/xml directory on the scoreboard module.

See Also

  • Scoreboard XML - scoreboard XML created each time web pages are created.