Difference between revisions of "Creating guided tours"

From OpenRocket wiki
Jump to navigation Jump to search
(Created page with '== File formatting == The tour description file is a text file in UTF-8 encoding with the following format: # # Any lines starting with a hash are comments. # # First non…')
 
Line 3: Line 3:
 
The tour description file is a text file in UTF-8 encoding with the following format:
 
The tour description file is a text file in UTF-8 encoding with the following format:
  
  #
+
  ''#''
  # Any lines starting with a hash are comments.
+
  ''# Any lines starting with a hash are comments.''
  #
+
  ''#''
 
   
 
   
  # First non-blank, non-comment line in the file is the title - this cannot contain HTML
+
  ''# First non-blank, non-comment line in the file is the title - this cannot contain HTML''
 
  '''A sample tour'''
 
  '''A sample tour'''
 
   
 
   
  # The lines before the first slide are the tour description
+
  ''# The lines before the first slide are the tour description''
  '''<p>This is the tour description.'''
+
  <p>This is the tour description.
  '''<p>It can contain multiple paragraphs using a simple HTML syntax.
+
  <p>It can contain multiple paragraphs using a simple HTML syntax.
 
   
 
   
 
   
 
   
  # Slides are started by containing an image name withing brackets
+
  ''# Slides are started by containing an image name withing brackets''
 
  '''<nowiki>[slide1.png]</nowiki>'''
 
  '''<nowiki>[slide1.png]</nowiki>'''
  '''&lt;p&gt;The description for the slide follows.  It can contain HTML marking such as &lt;b&gt;bold&lt;/b&gt;, &lt;i&gt;italics&lt;/i&gt;, &lt;sub&gt;subscripts&lt;/sub&gt; or &lt;sup&gt;superscripts&lt;/sup&gt;.'''
+
  &lt;p&gt;The description for the slide follows.  It can contain HTML marking such as '''&lt;b&gt;bold&lt;/b&gt;''', '''&lt;i&gt;italics&lt;/i&gt;''', &lt;sub&gt;subscripts&lt;/sub&gt; or &lt;sup&gt;superscripts&lt;/sup&gt;.
  '''&lt;p&gt;Each paragraph within the slide should be started with an HTML paragraph element.'''
+
  &lt;p&gt;Each paragraph within the slide should be started with an HTML paragraph element.
 
   
 
   
  # Next slide, please
+
  ''# Next slide, please''
 
  '''<nowiki>[slide2.jpg]</nowiki>'''
 
  '''<nowiki>[slide2.jpg]</nowiki>'''
  '''&lt;p&gt;Slide images can be either PNG or JPG.'''
+
  &lt;p&gt;Slide images can be either PNG or JPG.
  '''&lt;p&gt;Slides &lt;a href="another_tour"&gt;can even contain links&lt;/a&gt; to other tours.
+
  &lt;p&gt;Slides '''&lt;a href="another_tour"&gt;'''can even contain links'''&lt;/a&gt;''' to other tours.

Revision as of 07:30, 20 December 2011

File formatting

The tour description file is a text file in UTF-8 encoding with the following format:

#
# Any lines starting with a hash are comments.
#

# First non-blank, non-comment line in the file is the title - this cannot contain HTML
A sample tour

# The lines before the first slide are the tour description
<p>This is the tour description.
<p>It can contain multiple paragraphs using a simple HTML syntax.


# Slides are started by containing an image name withing brackets
[slide1.png]
<p>The description for the slide follows.  It can contain HTML marking such as <b>bold</b>, <i>italics</i>, <sub>subscripts</sub> or <sup>superscripts</sup>.
<p>Each paragraph within the slide should be started with an HTML paragraph element.

# Next slide, please
[slide2.jpg]
<p>Slide images can be either PNG or JPG.
<p>Slides <a href="another_tour">can even contain links</a> to other tours.