233245 - Update documentation of formats to include ctypes as well

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Dave Miller [:justdave]]

RDF is not a format, it's a ctype.

ctypes don't seem to be mentioned here, they probably should be.

Also, $contenttypes is no longer in localconfig, it's now in Bugzilla/Constants.pm

Comment 1

[Niels Reedijk]

Attachment: Proposed documentation change

This patch describes types and formats, and how to use these.

I'm only uncertain about the note I added, is it necessary? (the note covering
upgrading)

Comment 2

[Vlad Dascalu]

Comment on attachment 145626 [details] [diff] [review]
Proposed documentation change

Looks good. I'd rephase the note a little, but that's a nit.

Comment 3

[Vlad Dascalu]

Attachment: v2: Improve documentation for formats/ctypes (improve wording of note)

Comment 4

[Vlad Dascalu]

Tested, compiles cleanly.

Should be applied to the 2.17 branch only (the 2.16 still stores the variable in
localconfig and stuff).

Comment 5

[Vlad Dascalu]

Checking in docs/xml/customization.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/customization.xml,v  <-- 
customization.xml
new revision: 1.10; previous revision: 1.9
done

Comment 6

[Dave Miller [:justdave]]

Comment on attachment 145630 [details] [diff] [review]
v2: Improve documentation for formats/ctypes (improve wording of note)

>+        served as. The content types are defined in the
>+        <filename>Bugzilla/Constants.pm</filename> file in the 
>         <filename>$contenttypes</filename>
>         variable. If your content type is not there, add it. Remember

<nit>
There is no $contenttypes variable in Bugzilla/Constants.pm

The content types are defined in the Bugzilla/Constants.pm file
in the contenttypes constant.
</nit>

minor thing, not worth reopening, just commit the fix :)

Comment 7

[Vlad Dascalu]

Attachment: Fix for the "variable" --> "constant" conversion

Comment 8

[Vlad Dascalu]

Checking in customization.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/customization.xml,v  <--  
customization.xml
new revision: 1.11; previous revision: 1.10
done