draft notice text

[Karsten Wade]

On Wed, 2004-09-15 at 15:19, Paul W. Frields wrote:
> On Wed, 2004-09-15 at 17:38, Mark Johnson wrote:
> > Brock Organ wrote:
> > > On Wed, 2004-09-15 at 16:52 -0400, Tammy Fox wrote:
> > > 
> > >>I was about to add the common draft notice file from bug #132415, but I
> > >>wanted to discuss the wording of the notice a bit more. (This was
> > >>discussed on the Hardening Doc Preview thread, but I am starting a new
> > >>one with a more appropriate subject.)
> > >>
> > >>Thoughts?
> > > 
> > > 
> > > sounds good to me ...
> > 
> > Me, too. A nice improvement:)
> 
> I also like this!

+1 for a complete consensus :)

> The URL <http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=######>
> always works in my experience (for non-restricted bugs of course). If
> the writer uses too long a URL, the editor can fix it without a problem.
> 
> Or for that matter, I suppose we could have a common entity:
> 
> <!ENTITY SYSTEM BZ-Q
> "http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=">
> 
> And in the writer's doc:
> 
> <!ENTITY SYSTEM BUG-URL "&BZ-Q;######">

Strike SYSTEM from that usage.

> 
> But maybe that's just too much work? Not sure.

Seems simpler to go with a locally defined entity that is the bug #.

FWIW, this works:  http://bugzilla.redhat.com/XXXXXX

I think Mark is thinking of a pre-filled bug report such as the one that
I use for the SELinux FAQ.  For getting proper feedback, it is
invaluable -- it prefills the product, version, and component, sets the
blocker bug and assigned to, suggests a useful title-style, should have
the latest version number embedded already, and has specific suggestions
for filling out a bug report unique to this project.  However, it looks
like this:

https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&op_sys=Linux&version=fc3test2&component=fedora-docs&component_text=&rep_platform=All&priority=normal&bug_severity=normal&bug_status=NEW&assigned_to=kwade%40redhat.com&cc=&estimated_time=0.0&bug_file_loc=http%3A%2F%2Fpeople.redhat.com%2Fkwade%2Ffedora-docs%2Fselinux-faq-en%2F&short_desc=SELinux%20FAQ%20-%20%5Bsummarize%20FAQ%20change%20or%20addition%5D&comment=Description%20of%20change%2FFAQ%20addition.%20%20If%20a%20change%2C%20include%20the%20original%0D%0Atext%20first%2C%20then%20the%20changed%20text%3A%0D%0A%0D%0A%0D%0A%0D%0AVersion-Release%20of%20FAQ%20%28found%20on%0D%0Ahttp%3A%2F%2Fpeople.redhat.com%2Fkwade%2Ffedora-docs%2Fselinux-faq-en%2Fln-legalnotice.html%29%3A%0D%0A%0D%0A%20for%20example%3A%20selinux-faq-1.3%20%282004-09-15-T04%3A20-0800%29%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A%0D%0A&keywords=&dependson=&blocked=118757%20%20&maketemplate=Remember%20values%20as%20bookmarkable%20templ!
ate&form_name=enter_bug

I use a <ulink/> with descriptive link text. :)

How about:

1. If it is just a link to the bug report, then:

<!ENTITY BUG-URL "http://bugzilla.redhat.com/XXXXXX">

  usage:

<ulink url="&BUG-URL;"/>

2. If it is a Really Long URL, then following the same solution to
define the entity, but usage is:

<ulink url="BUG-URL;">pre-filled bug report</ulink>

NOTE - if you use a long URL that includes '&' characters, you _must_
change them to &amp; in the XML so that they process into the correct
characters when rendered.

- Karsten
-- 
Karsten Wade, RHCE, Tech Writer
a lemon is just a melon in disguise
http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115  5F1B D992 0E06 AD0E 0C41