From 4bbb07e8048ef859cfc29c6b9d221840f2c6aed1 Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Fri, 16 Jan 2004 06:34:12 +0000 Subject: Phase 1 of a big documentation update before 2.17.6. --- docs/html/hintsandtips.html | 47 ++++++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 20 deletions(-) (limited to 'docs/html/hintsandtips.html') diff --git a/docs/html/hintsandtips.html b/docs/html/hintsandtips.html index c3b2ed8e4..ee796c9cf 100644 --- a/docs/html/hintsandtips.html +++ b/docs/html/hintsandtips.html @@ -4,16 +4,18 @@ >Hints and TipsThe Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5 + Development ReleasePrev3.2. Hints and Tips3.7. Hints and Tips

This section distills some Bugzilla tips and best practices that have been developed.

3.2.1. Autolinkification

3.7.1. Autolinkification

Bugzilla comments are plain text - so posting HTML will result - in literal HTML tags rather than being interpreted by a browser. +>Bugzilla comments are plain text - so typing <U> will + produce less-than, U, greater-than rather than underlined text. However, Bugzilla will automatically make hyperlinks out of certain sorts of text in comments. For example, the text - http://www.bugzilla.org will be turned into + "http://www.bugzilla.org" will be turned into a link: comment 7bug 23456, comment 533.2.2. Quicksearch3.7.2. Quicksearch

Quicksearch is a single-text-box query tool which uses metacharacters to indicate what is to be searched. For example, typing @@ -183,7 +190,7 @@ CLASS="section" >3.2.3. Comments3.7.3. Comments

If you are changing the fields on a bug, only comment if either you have something pertinent to say, or Bugzilla requires it. @@ -196,7 +203,7 @@ NAME="commenting"

Don't use sigs in comments. Signing your name ("Bill") is acceptable, - particularly if you do it out of habit, but full mail/news-style + if you do it out of habit, but full mail/news-style four line ASCII art creations are not.

3.2.4. Attachments3.7.4. Attachments

Use attachments, rather than comments, for large chunks of ASCII data, such as trace, debugging output files, or log files. That way, it doesn't @@ -231,9 +238,9 @@ CLASS="section" >

3.2.5. Filing Bugs

3.7.5. Filing Bugs

Try to make sure that everything said in the summary is also said in the first comment. Summaries are often updated and this will @@ -268,7 +275,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" >PrevHow do I use Bugzilla?Patch Viewer