[patch] Quick Start Guide to FDP Primer

[Warren Block]

On Wed, 9 Jan 2013, Dru Lavigne wrote:

> Attached is the svn diff for proposed changes to the Quick Start Guide of the FDP Primer. Igor is mostly happy, except for a few tab indents I can't figure out.

I see a few in the diff.  When a tag is opened, the indent level is 
increased.  In some long tags like ulink, this suprises people:

+         choice of two ports.  If you install <filename
+         role="package">textproc/docproj-nojadetex</filename>, you

The start of the second line is still inside the <filename> tag, so it 
should be indented:

+         choice of two ports.  If you install <filename
+           role="package">textproc/docproj-nojadetex</filename>, you

The closing tag is on the second line, so the indent goes back a level 
on the next line (not shown).

> Note that this patch incorporates the information in the Tools section 
> into the Overview section. As a new user I got bitten by following the 
> Quick Start only to find that it did not mention all of the needed 
> tools until the next chapter. Tools was also quite redundant in the 
> docproj/jadetex discussion, none of which was mentioned in the earlier 
> Quick Start section. If accepted, the svn diff shows the removal of 
> Tools.

The patch fails for me on tools/chapter.xml at line 0.

> I tried to include in the Quick Start all of the info I could think of 
> to get a new user started and ready to go. The content should be 
> reviewed to make sure it isn't missing anything useful or suggests 
> something which isn't standard practice.

A quick first glance would make me suggest using igor -R | less -RS. 
This shows the color highlights, which most people prefer.  The plain 
ASCII alternate can be mentioned.

I'll look at it in more depth later.

> Thanks to bcr@ for his patience in getting my head wrapped around indentation.

And thanks to you, also!