Diff for /calendarhelp/www/buildguide.html between versions 1.5 and 1.6

version 1.5, 2005/04/29 08:53:07 version 1.6, 2005/05/23 13:13:09
Line 5  This page is a guide to building help fo Line 5  This page is a guide to building help fo
 using Calendar Help's BuildHelp tool.  using Calendar Help's BuildHelp tool.
 </p>  </p>
   
   <p><strong>Note: </strong>
   Parts of BuildHelp might be specially coded in a way that only works in Calendar Help.
   The general intention is to allow BuildHelp to be used with other projects,
   but if your project's requirements differ from Calendar Help's requirements,
   then you might have to modify BuildHelp's code.
   </p>
   
   
 <h4>Overview</h4>  <h4>Overview</h4>
 <p>  <p>
 The BuildHelp tool is part of the Calendar Help project.  The BuildHelp tool is part of the Calendar Help project.
 It is designed to build the help for Calendar and Sunbird.  It is designed to build the help for Calendar and Sunbird.
But you can use BuildHelp to build help content packs for other projects.But you can use BuildHelp to build other projects,
 especially if they contain help content packs.
 </p>  </p>
   
 <p>  <p>
 This page contains information about how to set up the source files  This page contains information about how to set up the source files
for your help content pack so that you can use it with BuildHelp.for your project and help content pack so that you can use it with BuildHelp.
 </p>  </p>
   
 <p>  <p>
Line 69  It also creates one file that applies to Line 78  It also creates one file that applies to
 </p>  </p>
   
 <p>  <p>
   In addition, BuildHelp can copy project source files from a sandbox (or developement directory)
   to a CVS directory, adding license information to the files.
   </p>
   
   <p>
 You can choose which parts of BuildHelp are appropriate for your project.  You can choose which parts of BuildHelp are appropriate for your project.
 For example, if you do not want a context map, you do not have to build it.  For example, if you do not want a context map, you do not have to build it.
 </p>  </p>
Line 78  For example, if you do not want a contex Line 92  For example, if you do not want a contex
 <p>  <p>
 Create a local directory structure for your project similar to  Create a local directory structure for your project similar to
 Calendar Help's directory structure on CVS.  Calendar Help's directory structure on CVS.
   This local directory structure is your CVS area.
 </p>  </p>
   
 <p>  <p>
One way to do this is to check out Calendar Help's source filesIf you wish to develop your project in a sandbox area,
 create a second similar local directory structure.
 A sandbox area allows you to make experimental changes to source files
 without affectng files that are under CVS control.
 The files in a sandbox area are private to you,
 so they do not contain license information.
 </p>
 
 <p>
 One way to create a local directory structure is to check out Calendar Help's source files
 from CVS, then rename the directories and change the files as required  from CVS, then rename the directories and change the files as required
 for your project.  for your project.
 </p>  </p>
Line 207  To create a jar file for the content pac Line 231  To create a jar file for the content pac
 <code>text/xx-XX/*.xhtml</code> to a form that the help viewer can use, writing the  <code>text/xx-XX/*.xhtml</code> to a form that the help viewer can use, writing the
 converted files to <code>locale/xx-XX/*.xhtml</code>.  converted files to <code>locale/xx-XX/*.xhtml</code>.
 It uses <code>build/build.properties</code> to supply the DTDs and the tags in the head.  It uses <code>build/build.properties</code> to supply the DTDs and the tags in the head.
It removes <code>&lt;context&gt;</code> and <code>&lt;index&gt;</code> tags, which are not needed at run time.It removes <code>&lt;context&gt;</code> and <code>&lt;index&gt;</code> tags, which are not needed at run time,
 and applies some additional filters.
 It adds the tiny license specified in <code>build/build.properties</code>.
 </p>
 
 This conversion only runs on source files that have changed.  This conversion only runs on source files that have changed.
 </p>  </p>
   
Line 251  Currently, some features of the online c Line 279  Currently, some features of the online c
 To create online content, BuildHelp first converts the source files  To create online content, BuildHelp first converts the source files
 <code>text/xx-XX/*.xhtml</code> to a form that the online viewer can use, writing the  <code>text/xx-XX/*.xhtml</code> to a form that the online viewer can use, writing the
 converted files to <code>www/xx-XX/*.xhtml</code>.  converted files to <code>www/xx-XX/*.xhtml</code>.
It removes <code>&lt;context&gt;</code> and <code>&lt;index&gt;</code> tags, which are not needed at run time.It removes <code>&lt;context&gt;</code> and <code>&lt;index&gt;</code> tags, which are not needed at run time,
 and applies some additional filters.
 This conversion only runs on source files that have changed.  This conversion only runs on source files that have changed.
 </p>  </p>
   
Line 266  It uses translated strings from <code>lo Line 295  It uses translated strings from <code>lo
   
   
   
   <h5>Update CVS from sandbox</h5>
   <p>
   If you develop your project in a sandbox area, BuildHelp can copy source files from
   there to your CVS area, adding license information to the files.
   BuildHelp only copies files that have changed.
   </p>
   
   <p>
   <code>build/build.properties</code> supplies data for the update,
   specifying a list of source and target directories,
   a list of file names to hold back,
   and the text of the full license added.
   For an example of the format, see Calendar Help's <code>build/build.properties</code> file.
   </p>
   
   <p>
   BuildHelp does not commit changes to CVS.
   Use a CVS client for this step.
   </p>
   
   
   
   
 <h4>Run-time features</h4>  <h4>Run-time features</h4>
Line 362  instead of <code>&amp;#233;</code> or th Line 412  instead of <code>&amp;#233;</code> or th
 </p>  </p>
   
 <p>  <p>
If you do not need this, you can remove <code>xhtml11.dtd</code> from theIf you do not need this, you can remove <code>html.dtd</code> from the
 DTDs that BuildHelp includes.  DTDs that BuildHelp includes.
 See the section <a href="#options">Options</a> below for details.  See the section <a href="#options">Options</a> below for details.
 </p>  </p>
   
   
   
<h4 id="options">Options</h4><h4 id="options">Project information and options</h4>
 <p>
 BuildHelp reads project information from a file <code>buildhelp.ini</code>
 in Firefox's <code>res</code> directory.
 For example, the file can contain settings like these,
 corresponding to fields in the user interface:
 <pre>
 proj.1=calendarhelp
 proj.1.version=0.1
 proj.1.base=F:\\Projects
 proj.1.subdir=false
 </pre>
 </p>
 
 <p>
 To specify second and subsequent projects, add setings for <code>proj.2</code>, <i>etc</i>.
 </p>
 
 <p>  <p>
Some BuildHelp options can be set without modifying the program code.Some other BuildHelp options can be set.
 To work with these options, open the URL <code>about:config</code> in  To work with these options, open the URL <code>about:config</code> in
 Firefox and filter on <code>buildhelp</code>.  Firefox and filter on <code>buildhelp</code>.
 Alternatively, close Firefox and edit the <code>prefs.js</code> file  Alternatively, close Firefox and edit the <code>prefs.js</code> file

Removed from v.1.5  
changed lines
  Added in v.1.6


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>