Stuart (et al), To follow up on your question from IRC, we don't have to use vim for formatting the reference docs source (docbook). What I want to avoid is reflows of the XML because that makes it virtually impossible to track changes. So far, vim gives me the maximum control over that. Eclipse loves to reformat the whole document in ways i don't agree with. I've tried other docbook editors, and they seem to have their own way of formatting too. If we can find a way to avoid reflows and use something better than vim, I'm all ears. Vim isn't the greatest at editing XML anyway. ...however, the modelines I suggested [1] to set a target for the formatting that we want. -Dan [1] http://seamframework.org/Documentation/ReferenceDocumentationStyleGuide -- Dan Allen Senior Software Engineer, Red Hat | Author of Seam in Action Registered Linux User #231597 http://mojavelinux.com http://mojavelinux.com/seaminaction http://www.google.com/profiles/dan.j.allen _______________________________________________ seam-dev mailing list seam-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/seam-dev

On Thu, Apr 15, 2010 at 12:38 PM, Pete Muir <pmuir(a)redhat.com&gt; wrote: The easiest option I know is just to use the Eclipse XML editor and never use the autoformat feature. Right, but if you turn off the autoformat feature, then who is responsible for the wrapping? Do you have to hit return when the sentence reaches the right margin line

and then space, space, space to get it to line up again?

I'm trying to find a way where you don't have to think. You can just type and it only formats what is necessary. If that's how it works, then I need to give it another chance.

Perhaps we can agree on an Eclipse autoformat style to use, just to make things slightly easier to make consistent? On Thu, Apr 15, 2010 at 12:55 PM, Pete Muir <pmuir(a)redhat.com&gt; wrote: On 15 Apr 2010, at 17:49, Dan Allen wrote: > On Thu, Apr 15, 2010 at 12:38 PM, Pete Muir <pmuir(a)redhat.com&gt; wrote: > The easiest option I know is just to use the Eclipse XML editor and never use the autoformat feature. > > Right, but if you turn off the autoformat feature, then who is responsible for the wrapping? Do you have to hit return when the sentence reaches the right margin line yes. > and then space, space, space to get it to line up again? no, it can do that automatically :-) > I'm trying to find a way where you don't have to think. You can just type and it only formats what is necessary. If that's how it works, then I need to give it another chance. I never found a plugin for eclipse to do this. I don't want to move outside my IDE to edit these files. _______________________________________________ seam-dev mailing list seam-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/seam-dev -- Lincoln Baxter, III http://ocpsoft.com http://scrumshark.com "Keep it Simple"

Does JBoss tools have this same XML formatting problem? If so, maybe we could get them to invest a little time in enhancing it for us if we can enumerate the deficiencies? --LB On Fri, Apr 16, 2010 at 5:35 AM, Pete Muir <pmuir(a)redhat.com&gt; wrote: > The trouble is the XML formatter in eclipse has very little > customizability (spaces vs tabs, gutter are the only ones I've found that > are useful) (and none on a per-project level) and certainly can't be told > NOT to put all elements on a new line. So if we use it, it ends up looking > so nasty that we should just invest the time to make it look ok. > > There are some better XML editors out there for sure which *can* apply ok > formatting (but never found a great one as Dan says). > > So, here's a challenge for readers: find a formatting template that will > take a file which has been (lovingly) hand formatted, like > https://svn.jboss.org/repos/weld/doc/trunk/reference/en-US/ri-spi.xml and > not screw it all up (there might be a couple of errors in there) :-) > > On 16 Apr 2010, at 04:31, Lincoln Baxter, III wrote: > > > Perhaps we can agree on an Eclipse autoformat style to use, just to make > things slightly easier to make consistent? > > > > On Thu, Apr 15, 2010 at 12:55 PM, Pete Muir <pmuir(a)redhat.com&gt; wrote: > > > > On 15 Apr 2010, at 17:49, Dan Allen wrote: > > > > > On Thu, Apr 15, 2010 at 12:38 PM, Pete Muir <pmuir(a)redhat.com&gt; wrote: > > > The easiest option I know is just to use the Eclipse XML editor and > never use the autoformat feature. > > > > > > Right, but if you turn off the autoformat feature, then who is > responsible for the wrapping? Do you have to hit return when the sentence > reaches the right margin line > > > > yes. > > > > > and then space, space, space to get it to line up again? > > > > no, it can do that automatically :-) > > > > > I'm trying to find a way where you don't have to think. You can just > type and it only formats what is necessary. If that's how it works, then I > need to give it another chance. > > > > I never found a plugin for eclipse to do this. I don't want to move > outside my IDE to edit these files. > > _______________________________________________ > > seam-dev mailing list > > seam-dev(a)lists.jboss.org > > https://lists.jboss.org/mailman/listinfo/seam-dev > > > > > > > > -- > > Lincoln Baxter, III > > http://ocpsoft.com > > http://scrumshark.com > > "Keep it Simple" > > -- Lincoln Baxter, III http://ocpsoft.com http://scrumshark.com "Keep it Simple" _______________________________________________ seam-dev mailing list seam-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/seam-dev

On Fri, Apr 16, 2010 at 2:00 PM, Lincoln Baxter, III < lincolnbaxter(a)gmail.com&gt; wrote: > Does JBoss tools have this same XML formatting problem? If so, maybe we > could get them to invest a little time in enhancing it for us if we can > enumerate the deficiencies? > What's funny is that what we want really isn't that complex. We want a tree structure, indented with 3 spaces. However, certain tags should be classified as "inline" tags and should not introduce a level of nesting. Pretty much just grab any of our docbook files, stare at it for a couple minutes, see how we are consistently formating it, and you get an idea of what we need. There is one other subtle requirement. Rarely are there two text editors

Stuart (et al), To follow up on your question from IRC, we don't have to use vim for formatting the reference docs source (docbook). What I want to avoid is reflows of the XML because that makes it virtually impossible to track changes. So far, vim gives me the maximum control over that. Eclipse loves to reformat the whole document in ways i don't agree with. I've tried other docbook editors, and they seem to have their own way of formatting too. If we can find a way to avoid reflows and use something better than vim, I'm all ears. Vim isn't the greatest at editing XML anyway. ...however, the modelines I suggested [1] to set a target for the formatting that we want. -Dan [1] http://seamframework.org/Documentation/ReferenceDocumentationStyleGuide -- Dan Allen Senior Software Engineer, Red Hat | Author of Seam in Action Registered Linux User #231597 http://mojavelinux.com http://mojavelinux.com/seaminaction http://www.google.com/profiles/dan.j.allen _______________________________________________ seam-dev mailing list seam-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/seam-dev