First look at Guide update

[John Ralls]

On Aug 13, 2010, at 9:19 AM, Tom Bullock wrote:

> Developers,
> 
> Until I get past my xml validation problem, my patch is delayed.
> 
> As stated in a previous email I have created an interim wiki page as a vehicle to make the information available to all users until such time as it can be integrated into the Tutorial and  Concepts Guide.
> 
> To access the information, use this URL:
> http://en.wikipedia.org/wiki/User:Tbullock17/Gnucash_tutorial_and_concepts_guide
> Please give reactions as you have time and see the need.
> 
> Before working on any additional updates to the Guide I intend to complete these items:
> a)  correct the xml validation problem in the current patch effort
> b)  move to the point of creating a patch and presenting it in bugzilla
> c)  completing the review of the stated changes on gnucash.org from version 2.2 thru current
> d)  start a review all changes revealed by svn log for code and documentation
> e)  integrate items c) and d) findings and submit those for developer review and prioritization
> f)   from e) should come a plan for ongoing documentation development
> 
> In all these steps I expect input from any who are willing and interested to do so.
> 
> I will be on vacation 8/25 thru 8/31 and not paying much attention to emails or to the lists.
> 

OK, I've taken your wiki posting and run it through xmllint. The output (after reformating it for clarity) is

> (sect1info? , 
>   (title , subtitle? , titleabbrev?) , 
>   (toc | lot | index | glossary | bibliography)* , 
>   (
>     (
>       (calloutlist | glosslist | itemizedlist | orderedlist | segmentedlist | 
> 	   simplelist | variablelist | caution | important | note | tip | warning |
> 	   literallayout | programlisting | programlistingco | screen | screenco |
> 	   screenshot | synopsis | cmdsynopsis | funcsynopsis | classsynopsis |
> 	   fieldsynopsis | constructorsynopsis | destructorsynopsis | 
> 	   methodsynopsis | formalpara | para | simpara | address | blockquote | 
> 	   graphic | graphicco | mediaobject | mediaobjectco | informalequation | 
> 	   informalexample | informalfigure | informaltable | equation | example | 
> 	   figure | table | msgset | procedure | sidebar | qandaset | anchor | 
> 	   bridgehead | remark | highlights | abstract | authorblurb | epigraph | 
> 	   indexterm | beginpage)+, 	  
>       (refentry* | sect2* | simplesect*)
>     ) | 
>   refentry+ | sect2+ | simplesect+), 
>   (toc | lot | index | glossary | bibliography)*
> ), got 
> (title 
>        para 
>        para 
>        para 
>        para 
>        sect2 <- "BEGIN NEW CONTENT" is in the middle of this section
>        sect2 
>        sect2 
>        sect2 
>        sect2 <- "SIGNIFICANT NEW CONTENT ENDS HERE" is at the end of this one. 
>        tip 
>        sect2 
>        tip 
>        sect2 
>        tip 
>        note 
>        sect2 
> )


which pretty clearly shows the problem: You promoted those <tip> and <note> elements to the top level; they should have remained in the <sect2> elements that they were in originally. In every case, the </sect2> tag needs to be moved from just above to just below the offending elements, after which xmllint passes.

Regards,
John Ralls