This file describes how to modify the QuickStart documentation.

An overview -- each documentation page as a file foo-source.html.  When you run build.bat, it runs BuildQuickStart.exe on *-source.html, which does a couple things:

When you create a sample, put it in the samples directory and create a sample that can be run by itself.  Remember that any functions and global variables you define in JavaScript should have unique names because when deployed to the quick start, your sample will be running alongside other samples.

Where to get the source for the quick starts: everything lives in the source depot provided by http://toolbox.  To enlist:

  1. md directory
  2. cd directory
  3. set sdport=BGIT-SDTOOLBOX:4001
  4. c:\nt\tools\x86\sd.exe client

    and set the view to:

    //depot/JoltQuickStartTools/... //MYMACHINENAME/...
  5. Look in the QuickStart subdirectory

BuildQuickStart.exe supports the following %% constructs:

Make sure to put directives on their own line, in a paragraph by themselves, e.g.:

<p> %% filename.xaml%% </p>

In theory, all %% directives are case-insensitive and ignore whitespace, but this hasn't been heavily tested.

Xaml, JavaScript, and C #files also support their own directives to control which text should be bold.  Put the directive on its own line inside a comment (using the appropriate comment format for the source file), whitespace is not supposed to be significant.  Supported directives:

Interesting files:

 

In general, these tools probably don't handle invalid xaml very well.

My HTML editor of choice is Expression Web.