Difference between revisions of "Template:Project Info"

From OWASP
Jump to: navigation, search
Line 50: Line 50:
 
* Contact the [[:Category:Global Projects Committee|GPC]] to report a problem or concern about this project or to update information.
 
* Contact the [[:Category:Global Projects Committee|GPC]] to report a problem or concern about this project or to update information.
 
|}</includeonly><noinclude>
 
|}</includeonly><noinclude>
 +
= About =
 
This template displays key OWASP Project Info, including the project name, leader, mailing list, and health. All parameters are optional. There can be up to 10 for each of the following parameters: leaders, maintainers, contributors, and links.
 
This template displays key OWASP Project Info, including the project name, leader, mailing list, and health. All parameters are optional. There can be up to 10 for each of the following parameters: leaders, maintainers, contributors, and links.
  
Line 69: Line 70:
 
* project_health_status = ''null'' (Not Reviewed)
 
* project_health_status = ''null'' (Not Reviewed)
  
=== Usage ===
+
= Usage =
 
<pre>
 
<pre>
 
{{Template:Project Info
 
{{Template:Project Info
Line 91: Line 92:
 
</pre>
 
</pre>
  
=== Example ===
+
= Example =
 
<pre>
 
<pre>
 
{{Template:Project Info
 
{{Template:Project Info
Line 110: Line 111:
 
}}
 
}}
 
</pre>
 
</pre>
 +
== Output ==
 
{{Template:Project Info
 
{{Template:Project Info
 
| project_name = Example Project
 
| project_name = Example Project

Revision as of 22:49, 5 February 2010

Contents

About

This template displays key OWASP Project Info, including the project name, leader, mailing list, and health. All parameters are optional. There can be up to 10 for each of the following parameters: leaders, maintainers, contributors, and links.

Any name/email/username tuple utilizes the Template:Contact template. For example, leader_name, leader_email and leader_username form the leader Contact tuple. Likewise with maintainer_* and contributor_*[1-10].

By default:

  • project_name = N/A
  • project_homepage = not displayed
  • project_description = N/A
  • project_license = N/A
  • leader_*[1-10] = not displayed
  • contributor_*[1-10] = not displayed
  • pamphlet_link = N/A
  • presentation_link = N/A
  • mailing_list = N/A
  • links_url[1-10] = not displayed
  • links_name[1-10] = not displayed
  • project_road_map = N/A
  • project_health_status = null (Not Reviewed)

Usage

{{Template:Project Info
| project_name =
| project_home_page = 
| project_description =
| project_license =
| leader_name[1-10] =
| leader_email[1-10] =
| leader_username[1-10] = 
| contributor_name[1-10] = 
| contributor_email[1-10] = 
| contributor_username[1-10] = 
| pamphlet_link = 
| presentation_link =
| mailing_list = 
| project_road_map = 
| links_url[1-10] = 
| links_name[1-10] = 
}}

Example

{{Template:Project Info
| project_name = Example Project
| project_home_page = Category: GPC Templates
| project_description = An example OWASP project
| project_license = Creative Commons Attribution-Share Alike 3.0
| leader_username1 = Jason Li
| leader_name1 = Jason Li
| leader_name2 = Brad Causey
| contributor_username1 = mtesauro
| contributor_name1 = Matt Tesauro
| presentation_link = https://www.owasp.org/images/2/23/Owasp-gpc-slides_June_2009.ppt
| mailing_list_name = global-projects-committee
| project_road_map = Global_Projects_Committee
| links_url1 = http://www.owasp.org/index.php/Global_Projects_Committee
| links_name1 = Global Projects Committee
}}

Output

what is this project?
Name: Example Project (home page)
Purpose: An example OWASP project
License: Creative Commons Attribution-Share Alike 3.0
who is working on this project?
Project Leader(s):
Project Contributor(s):
how can you learn more?
Project Pamphlet: Not Yet Created
Project Presentation: View
Mailing list: [global-projects-committee Mailing List Archives]
Project Roadmap: [Global_Projects_Committee View]
Main links:
Key Contacts
  • Contact Jason Li to contribute to this project
  • Contact Jason Li to review or sponsor this project
  • Contact the GPC to report a problem or concern about this project or to update information.