Questions regarding documentation for new releases

[kc...@360commerce.com]

I haven't seen much information about writing user documentation, but I don't
really know where to look.  I've added a couple of minor features, and I'd like
to tell the user community about them somehow.

There are a number of XML files in the build tree under the usermanual
directory.  I tried looking at them and thought to myself, "Eeeee, I don't know
how to write that.  I'm not sure I want to learn."  Is there a relatively
painless way to add stuff to the user manual?

Also, I'm curious about how the XML is transformed into HTML.  In particular,
I'm wondering why the HTML in most of the manual rearranges itself nicely when I
resize my browser, but the component_reference section requires my browser to be
near its maximum width of 1152 pixels.



---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org

Re: Questions regarding documentation for new releases

[Mike Stover <ms...@apache.org>]

XML documents are transformed by velocity - so you can read up on velocity if 
you like.  

As far as just doing something quick and dirty - you can basically copy and paste 
stuff that's already there and modify the words for what you need.  You can also 
write straight HTML (in an XML compatible way) and it will get transformed ok.

The component reference page has lots of big, wide images that make resizing to 
a smaller size not work well.

-Mike

On 31 Jan 2003 at 11:30, kcassell@360commerce.com wrote:

> 
> 
> I haven't seen much information about writing user documentation, but I don't
> really know where to look.  I've added a couple of minor features, and I'd like
> to tell the user community about them somehow.
> 
> There are a number of XML files in the build tree under the usermanual
> directory.  I tried looking at them and thought to myself, "Eeeee, I don't know
> how to write that.  I'm not sure I want to learn."  Is there a relatively
> painless way to add stuff to the user manual?
> 
> Also, I'm curious about how the XML is transformed into HTML.  In particular,
> I'm wondering why the HTML in most of the manual rearranges itself nicely when I
> resize my browser, but the component_reference section requires my browser to be
> near its maximum width of 1152 pixels.
> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org
> 



--
Michael Stover
mstover1@apache.org
Yahoo IM: mstover_ya
ICQ: 152975688
AIM: mstover777

---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org