Jump to: navigation, search

Difference between revisions of "Contributing Examples (BIRT)"

 
(Introduction)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{Backlink|Examples (BIRT)}}
  
== Introduction ==
+
== Introduction ==  
Contributing
+
The BIRT Community appreciates your willingness to contribute examples.  Please consider adding or revising entries to assist other BIRT developers.
  
'''This can be done by copying the following to the beginning of your example wiki page.'''<br>
+
To contribute an example to the BIRT wiki follow the guidelines below.
<nowiki>
+
== BIRT Version ==
+
</nowiki>
+
<br>BIRT 2.1.1<br>
+
  
'''And copying the following to the bottom of your example.<br>'''
+
*'''New Wiki Page''' - Create a wiki page with the title of your example.  The title should be formatted like “title (BIRT)”.  The reason for this convention is to optimize wiki usage and prevent name clashes with existing wiki pages.  The wiki is shared among many Eclipse projects.  Copy the wiki syntax listed under '''Sample Wiki Page Syntax''' and paste to your new page.
 +
 
 +
*'''Example Files''' - Any code that is given to the BIRT project needs to be submitted through Bugzilla.  If your example contains source code or an example report, create a bugzilla entry and upload the content as an attachment. 
 +
**TIP: The component field for a Wiki entry should be set to 'wiki'.  This will allow a committer to review your submission.
 +
**TIP: Summary field format is “Example – name of your wiki page" 
 +
***e.g. “Example - Stored Procedure (BIRT)”. 
 +
**TIP: In the Severity field, tag the bug as an Enhancement.
 +
**TIP: It is better if you compress the attachment and link to the attachment from the wiki entry\\ 
 +
***e.g. <nowiki>[https://bugs.eclipse.org/bugs/attachment.cgi?id=57814 Example Report Zipped]</nowiki> place under Example Files Header
 +
 
 +
*'''Link your new page''' – Navigate to the most logical place within the wiki example structure and edit the page.  Place a link to your new page.  If you need help as to where the link to your example should be, please note in the Bugzilla entry and a committer will help you locate the link.
 +
 
 +
== Sample Wiki Page Syntax ==
 +
<tt><blockquote>
 +
<nowiki>{{Backlink|Report Developer Examples (BIRT)}}</nowiki>
 +
<br>
 +
<nowiki>This example is
 +
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=XXXXXX Bugzilla ID XXXXX].  If you would like to contribute an
 +
example see the example contribution guidelines.<br></nowiki><br>
 +
<nowiki>
 +
== Introduction ==
 +
</nowiki><br>
 +
Add your introduction here.<br>
 +
<nowiki>
 +
== BIRT Version Compatibility ==
 +
</nowiki><br>
 +
Enter the version of BIRT that was used to build the example.<br>
 +
<nowiki>
 +
== Example Files==
 +
</nowiki><br>
 +
Add a URL to your bugzilla attachment. eg.<br>
 +
<nowiki>
 +
[https://bugs.eclipse.org/bugs/attachment.cgi?id=YYYYYY Example Report Zipped]
 +
</nowiki><br>
 +
<nowiki>
 +
== Description==
 +
</nowiki><br>
 +
Give a detailed description of your example.<br>
 
<nowiki>
 
<nowiki>
 
== Comments ==
 
== Comments ==
</nowiki>
+
</nowiki><br>
 
+
 
Please enter comments below by selecting the edit icon to the right.<br>
 
Please enter comments below by selecting the edit icon to the right.<br>
You will need a Bugzilla account to add comments.
+
You will need a Bugzilla account to add comments.<br>
 +
<nowiki>----</nowiki><br>
 +
<nowiki>[[Category:BIRT]]</nowiki><br>
 +
<nowiki>[[Category:BIRT Example]]</nowiki><br>
 +
<nowiki>[[Category:BIRT Example Report]]</nowiki><br>
 +
<nowiki> or </nowiki><br>
 +
<nowiki>[[Category:BIRT]]</nowiki><br>
 +
<nowiki>[[Category:BIRT Example]]</nowiki><br>
 +
<nowiki>[[Category:BIRT Example Integration]]</nowiki><br>
 +
<nowiki> or </nowiki><br>
 +
<nowiki>[[Category:BIRT]]</nowiki><br>
 +
<nowiki>[[Category:BIRT Example]]</nowiki><br>
 +
<nowiki>[[Category:BIRT Example Extension]]</nowiki><br>
 +
</blockquote></tt>
  
<nowiki>
+
[[Category:BIRT]]
----
+
[[Category:BIRT Example]]
</nowiki>
+

Latest revision as of 13:53, 22 June 2007

< To: Examples (BIRT)

Introduction

The BIRT Community appreciates your willingness to contribute examples. Please consider adding or revising entries to assist other BIRT developers.

To contribute an example to the BIRT wiki follow the guidelines below.

  • New Wiki Page - Create a wiki page with the title of your example. The title should be formatted like “title (BIRT)”. The reason for this convention is to optimize wiki usage and prevent name clashes with existing wiki pages. The wiki is shared among many Eclipse projects. Copy the wiki syntax listed under Sample Wiki Page Syntax and paste to your new page.
  • Example Files - Any code that is given to the BIRT project needs to be submitted through Bugzilla. If your example contains source code or an example report, create a bugzilla entry and upload the content as an attachment.
    • TIP: The component field for a Wiki entry should be set to 'wiki'. This will allow a committer to review your submission.
    • TIP: Summary field format is “Example – name of your wiki page"
      • e.g. “Example - Stored Procedure (BIRT)”.
    • TIP: In the Severity field, tag the bug as an Enhancement.
    • TIP: It is better if you compress the attachment and link to the attachment from the wiki entry\\
      • e.g. [https://bugs.eclipse.org/bugs/attachment.cgi?id=57814 Example Report Zipped] place under Example Files Header
  • Link your new page – Navigate to the most logical place within the wiki example structure and edit the page. Place a link to your new page. If you need help as to where the link to your example should be, please note in the Bugzilla entry and a committer will help you locate the link.

Sample Wiki Page Syntax

{{Backlink|Report Developer Examples (BIRT)}}
This example is [https://bugs.eclipse.org/bugs/show_bug.cgi?id=XXXXXX Bugzilla ID XXXXX]. If you would like to contribute an example see the example contribution guidelines.<br>
== Introduction ==
Add your introduction here.
== BIRT Version Compatibility ==
Enter the version of BIRT that was used to build the example.
== Example Files==
Add a URL to your bugzilla attachment. eg.
[https://bugs.eclipse.org/bugs/attachment.cgi?id=YYYYYY Example Report Zipped]
== Description==
Give a detailed description of your example.
== Comments ==
Please enter comments below by selecting the edit icon to the right.
You will need a Bugzilla account to add comments.
----
[[Category:BIRT]]
[[Category:BIRT Example]]
[[Category:BIRT Example Report]]
or
[[Category:BIRT]]
[[Category:BIRT Example]]
[[Category:BIRT Example Integration]]
or
[[Category:BIRT]]
[[Category:BIRT Example]]
[[Category:BIRT Example Extension]]