Yes, the space around is even better. The only reason I proposed the compacted version was that - looking for alternatives - I crossed-checked quickly with the rexxref.pdf, where the compacted version is used consistently. I guess what matters is that one style is used consistently in one doc.
Cheers, Madou 2012/3/3 Mark Miesfeld <[email protected]>: > Thanks Jean-Louis, > > I think the space around is easier to read in text also. > > -- > Mark Miesfeld > > On Sat, Mar 3, 2012 at 9:14 AM, Jean-Louis Faucher <[email protected]> > wrote: >> >> Hi Mark >> >> I don't have a strong opinion on which format is the best for textual >> syntax diagram, but I would say that space-around is more easy to read. >> There are similar notations in rexxpg, section 9.14 >> >> I was curious to see the impact on the graphical representation...Both >> notations, compact and space-around, generate the same DITA XML. A >> <groupcomp> is generated, whose representation is indeed more compact than >> the <groupseq> previously generated with -=- >> >> I think I prefer the old graphical representation, where the '=' is more >> isolated, but the new one looks good as well. >> >> Jean-Louis >> >> 2012/3/3 Mark Miesfeld <[email protected]> >>> >>> Hi All, >>> >>> Madou just supplied the project with a number of patches fixing my >>> zillions of spelling errors in the 4.2.0 ooDialog doc. Which is very much >>> appreciated. >>> >>> One thing he brought up was the railroad track syntax diagram I've been >>> using for attributes: >>> >>> He said: the format "---attr-=-value---" which is somewhat difficult to >>> read >>> >>> and he suggested compacting it to: "---attr=value---" >>> >>> It's a good point that it's difficult to read, but my first instinct >>> would be to drop the two dashes rather than compacting it. Like this >>> instead: >>> >>> "---attr = value---" >>> >>> I always put a space around an equals sign, so none of the code snippets >>> in the doc will have code like: >>> >>> self~initCode=1 >>> >>> it is always: >>> >>> self~initCode = 1 >>> >>> I just compiled the doc, and in the dialog object chapter, for the >>> autoDetect, constDir, dlgHandle, factorX, and factorY I put a apace around >>> the equals sign in the railroad track. I left all the other ones compacted, >>> so it would be easy to compare how the two formats actually look like in the >>> doc. >>> >>> I put that compiled doc on SourceForge with the ooDialog downloads. I'd >>> appreciate anyone that wanted to take a look and comment on which format >>> they would choose. >>> >>> The file on SourceForge is: oodialog-r7626.pdf which is the latest >>> version. The section to look at to see the differences is: >>> >>> 3.4. Attribute Methods >>> >>> >>> -- >>> Mark Miesfeld >>> >>> >>> >>> ------------------------------------------------------------------------------ >>> Virtualization & Cloud Management Using Capacity Planning >>> Cloud computing makes use of virtualization - but cloud computing >>> also focuses on allowing computing to be delivered as a service. >>> http://www.accelacomm.com/jaw/sfnl/114/51521223/ >>> _______________________________________________ >>> Oorexx-users mailing list >>> [email protected] >>> https://lists.sourceforge.net/lists/listinfo/oorexx-users >>> >> >> >> >> ------------------------------------------------------------------------------ >> Virtualization & Cloud Management Using Capacity Planning >> Cloud computing makes use of virtualization - but cloud computing >> also focuses on allowing computing to be delivered as a service. >> http://www.accelacomm.com/jaw/sfnl/114/51521223/ >> _______________________________________________ >> Oorexx-users mailing list >> [email protected] >> https://lists.sourceforge.net/lists/listinfo/oorexx-users >> > > > ------------------------------------------------------------------------------ > Virtualization & Cloud Management Using Capacity Planning > Cloud computing makes use of virtualization - but cloud computing > also focuses on allowing computing to be delivered as a service. > http://www.accelacomm.com/jaw/sfnl/114/51521223/ > _______________________________________________ > Oorexx-users mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/oorexx-users > ------------------------------------------------------------------------------ Virtualization & Cloud Management Using Capacity Planning Cloud computing makes use of virtualization - but cloud computing also focuses on allowing computing to be delivered as a service. http://www.accelacomm.com/jaw/sfnl/114/51521223/ _______________________________________________ Oorexx-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/oorexx-users
