Difference between revisions of "Template:Project Info"

From OWASP
Jump to: navigation, search
(Undo revision 149169 by Samantha Groves (talk))
(23 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
! style="background:#ffffff;" align="left" colspan="1" | <small>''is this project?''</small>
 
! style="background:#ffffff;" align="left" colspan="1" | <small>''is this project?''</small>
 
|-
 
|-
| colspan="2" | '''''Name:''''' {{#if: {{{project_name|}}} | {{{project_name}}}  {{#if: {{{project_home_page|}}} | ([[:{{{project_home_page}}} {{Template:!}} home page]]) |}} | N/A }}
+
| colspan="2" | '''''Name:''''' {{#if: {{{project_name|}}} | {{{project_name}}}  {{#if: {{{project_home_page|}}} | ([[:{{{project_home_page}}}{{Template:!}}home page]]) |}} | N/A }}
 
|-
 
|-
 
| colspan="2" | ''''' Purpose: ''''' {{#if: {{{project_description|}}} | {{{project_description}}} | N/A }}
 
| colspan="2" | ''''' Purpose: ''''' {{#if: {{{project_description|}}} | {{{project_description}}} | N/A }}
Line 17: Line 17:
 
{{Template:!}}-
 
{{Template:!}}-
 
{{Template:!}} colspan="2" {{Template:!}} '''''Project Maintainer(s):'''''  
 
{{Template:!}} colspan="2" {{Template:!}} '''''Project Maintainer(s):'''''  
* {{Template:Contact | name= {{#if: {{{maintainer_name1|}}} | {{{maintainer_name1}}} | }} | email = {{#if: {{{maintainer_email1|}}} | {{{maintainer_email1}}} | }} | username = {{#if: {{{maintainer_username1|}}} | {{{maintainer_username1}}} | }} }} | }} {{#if: {{{maintainer_name2|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name2|}}} | {{{maintainer_name2}}} | }} | email = {{#if: {{{maintainer_email2|}}} | {{{maintainer_email2}}} | }} | username = {{#if: {{{maintainer_username2|}}} | {{{maintainer_username2}}} | }} }} | }} {{#if: {{{maintainer_name3|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name3|}}} | {{{maintainer_name3}}} | }} | email = {{#if: {{{maintainer_email3|}}} | {{{maintainer_email3}}} | }} | username = {{#if: {{{maintainer_username3|}}} | {{{maintainer_username3}}} | }} }} | }} {{#if: {{{maintainer_name4|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name4|}}} | {{{maintainer_name4}}} | }} | email = {{#if: {{{maintainer_email4|}}} | {{{maintainer_email4}}} | }} | username = {{#if: {{{maintainer_username4|}}} | {{{maintainer_username4}}} | }} }} | }} {{#if: {{{maintainer_name5|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name5|}}} | {{{maintainer_name5}}} | }} | email = {{#if: {{{maintainer_email5|}}} | {{{maintainer_email5}}} | }} | username = {{#if: {{{maintainer_username5|}}} | {{{maintainer_username5}}} | }} }} | }} {{#if: {{{maintainer_name6|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name6|}}} | {{{maintainer_name6}}} | }} | email = {{#if: {{{maintainer_email6|}}} | {{{maintainer_email6}}} | }} | username = {{#if: {{{maintainer_username6|}}} | {{{maintainer_username6}}} | }} }} | }} {{#if: {{{maintainer_name7|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name7|}}} | {{{maintainer_name7}}} | }} | email = {{#if: {{{maintainer_email7|}}} | {{{maintainer_email7}}} | }} | username = {{#if: {{{maintainer_username7|}}} | {{{maintainer_username7}}} | }} }} | }} {{#if: {{{maintainer_name8|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name8|}}} | {{{maintainer_name8}}} | }} | email = {{#if: {{{maintainer_email8|}}} | {{{maintainer_email8}}} | }} | username = {{#if: {{{maintainer_username8|}}} | {{{maintainer_username8}}} | }} }} | }} {{#if: {{{maintainer_name9|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name9|}}} | {{{maintainer_name9}}} | }} | email = {{#if: {{{maintainer_email9|}}} | {{{maintainer_email9}}} | }} | username = {{#if: {{{maintainer_username9|}}} | {{{maintainer_username9}}} | }} }} | }} {{#if: {{{maintainer_name10|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name10|}}} | {{{maintainer_name10}}} | }} | email = {{#if: {{{maintainer_email10|}}} | {{{maintainer_email10}}} | }} | username = {{#if: {{{maintainer_username10|}}} | {{{maintainer_username10}}} | }} }} | }}
+
* {{Template:Contact | name= {{#if: {{{maintainer_name1|}}} | {{{maintainer_name1}}} | }} | email = {{#if: {{{maintainer_email1|}}} | {{{maintainer_email1}}} | }} | username = {{#if: {{{maintainer_username1|}}} | {{{maintainer_username1}}} | }} }} | }} {{#if: {{{maintainer_name2|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name2|}}} | {{{maintainer_name2}}} | }} | email = {{#if: {{{maintainer_email2|}}} | {{{maintainer_email2}}} | }} | username = {{#if: {{{maintainer_username2|}}} | {{{maintainer_username2}}} | }} }} | }} {{#if: {{{maintainer_name3|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name3|}}} | {{{maintainer_name3}}} | }} | email = {{#if: {{{maintainer_email3|}}} | {{{maintainer_email3}}} | }} | username = {{#if: {{{maintainer_username3|}}} | {{{maintainer_username3}}} | }} }} | }} {{#if: {{{maintainer_name4|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name4|}}} | {{{maintainer_name4}}} | }} | email = {{#if: {{{maintainer_email4|}}} | {{{maintainer_email4}}} | }} | username = {{#if: {{{maintainer_username4|}}} | {{{maintainer_username4}}} | }} }} | }} {{#if: {{{maintainer_name5|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name5|}}} | {{{maintainer_name5}}} | }} | email = {{#if: {{{maintainer_email5|}}} | {{{maintainer_email5}}} | }} | username = {{#if: {{{maintainer_username5|}}} | {{{maintainer_username5}}} | }} }} | }} {{#if: {{{maintainer_name6|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name6|}}} | {{{maintainer_name6}}} | }} | email = {{#if: {{{maintainer_email6|}}} | {{{maintainer_email6}}} | }} | username = {{#if: {{{maintainer_username6|}}} | {{{maintainer_username6}}} | }} }} | }} {{#if: {{{maintainer_name7|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name7|}}} | {{{maintainer_name7}}} | }} | email = {{#if: {{{maintainer_email7|}}} | {{{maintainer_email7}}} | }} | username = {{#if: {{{maintainer_username7|}}} | {{{maintainer_username7}}} | }} }} | }} {{#if: {{{maintainer_name8|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name8|}}} | {{{maintainer_name8}}} | }} | email = {{#if: {{{maintainer_email8|}}} | {{{maintainer_email8}}} | }} | username = {{#if: {{{maintainer_username8|}}} | {{{maintainer_username8}}} | }} }} | }} {{#if: {{{maintainer_name9|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name9|}}} | {{{maintainer_name9}}} | }} | email = {{#if: {{{maintainer_email9|}}} | {{{maintainer_email9}}} | }} | username = {{#if: {{{maintainer_username9|}}} | {{{maintainer_username9}}} | }} }} | }} {{#if: {{{maintainer_name10|}}} | * {{Template:Contact | name= {{#if: {{{maintainer_name10|}}} | {{{maintainer_name10}}} | }} | email = {{#if: {{{maintainer_email10|}}} | {{{maintainer_email10}}} | }} | username = {{#if: {{{maintainer_username10|}}} | {{{maintainer_username10}}} | }} }} | }}{{#if: {{{contributor_name1|}}} |  
{{#if: {{{contributor_name1|}}} |  
+
 
{{Template:!}}-
 
{{Template:!}}-
 
{{Template:!}} colspan="2" {{Template:!}} '''''Project Contributor(s):'''''  
 
{{Template:!}} colspan="2" {{Template:!}} '''''Project Contributor(s):'''''  
Line 30: Line 29:
 
| colspan="2" | '''''Project Presentation:''''' {{#if: {{{presentation_link|}}} | [{{{presentation_link}}} View ] | Not Yet Created }}
 
| colspan="2" | '''''Project Presentation:''''' {{#if: {{{presentation_link|}}} | [{{{presentation_link}}} View ] | Not Yet Created }}
 
|-
 
|-
| colspan="2" | '''''Mailing list:''''' {{#if: {{{mailing_list_name|}}} | [https://lists.owasp.org/mailman/listinfo/{{{mailing_list_name}}} Mailing List Archives] | N/A }}
+
| colspan="2" | '''''Mailing list:''''' {{#if: {{{mailing_list_name|}}} | [{{{mailing_list_name}}} Mailing List Archives] | N/A }}
 +
|-
 +
| colspan="2" | '''''Project Roadmap:''''' {{#if: {{{project_road_map|}}} | [{{{project_road_map}}} View] | Not Yet Created }}
 
|-
 
|-
| colspan="2" | '''''Project Roadmap:''''' {{#if: {{{project_road_map|}}} | [[:{{{project_road_map}}} {{Template:!}} View]] | Not Yet Created }}
 
 
{{#if: {{{links_url1|}}} |  
 
{{#if: {{{links_url1|}}} |  
 
{{Template:!}}-
 
{{Template:!}}-
 
{{Template:!}} colspan="2" {{Template:!}} '''''Main links:'''''
 
{{Template:!}} colspan="2" {{Template:!}} '''''Main links:'''''
 
* [{{{links_url1}}} {{#if: {{{links_name1|}}} | {{{links_name1}}} | }}] | }}{{#if: {{{links_url2|}}} | * [{{{links_url2}}} {{#if: {{{links_name2|}}} | {{{links_name2}}} | }}] | }}{{#if: {{{links_url3|}}} | * [{{{links_url3}}} {{#if: {{{links_name3|}}} | {{{links_name3}}} | }}] | }}{{#if: {{{links_url4|}}} | * [{{{links_url4}}} {{#if: {{{links_name4|}}} | {{{links_name4}}} | }}] | }}{{#if: {{{links_url5|}}} | * [{{{links_url5}}} {{#if: {{{links_name5|}}} | {{{links_name5}}} | }}] | }}{{#if: {{{links_url6|}}} | * [{{{links_url6}}} {{#if: {{{links_name6|}}} | {{{links_name6}}} | }}] | }}{{#if: {{{links_url7|}}} | * [{{{links_url7}}} {{#if: {{{links_name7|}}} | {{{links_name7}}} | }}] | }}{{#if: {{{links_url8|}}} | * [{{{links_url8}}} {{#if: {{{links_name8|}}} | {{{links_name8}}} | }}] | }}{{#if: {{{links_url9|}}} | * [{{{links_url9}}} {{#if: {{{links_name9|}}} | {{{links_name9}}} | }}] | }}{{#if: {{{links_url10|}}} | * [{{{links_url10}}} {{#if: {{{links_name10|}}} | {{{links_name10}}} | }}] | }}
 
* [{{{links_url1}}} {{#if: {{{links_name1|}}} | {{{links_name1}}} | }}] | }}{{#if: {{{links_url2|}}} | * [{{{links_url2}}} {{#if: {{{links_name2|}}} | {{{links_name2}}} | }}] | }}{{#if: {{{links_url3|}}} | * [{{{links_url3}}} {{#if: {{{links_name3|}}} | {{{links_name3}}} | }}] | }}{{#if: {{{links_url4|}}} | * [{{{links_url4}}} {{#if: {{{links_name4|}}} | {{{links_name4}}} | }}] | }}{{#if: {{{links_url5|}}} | * [{{{links_url5}}} {{#if: {{{links_name5|}}} | {{{links_name5}}} | }}] | }}{{#if: {{{links_url6|}}} | * [{{{links_url6}}} {{#if: {{{links_name6|}}} | {{{links_name6}}} | }}] | }}{{#if: {{{links_url7|}}} | * [{{{links_url7}}} {{#if: {{{links_name7|}}} | {{{links_name7}}} | }}] | }}{{#if: {{{links_url8|}}} | * [{{{links_url8}}} {{#if: {{{links_name8|}}} | {{{links_name8}}} | }}] | }}{{#if: {{{links_url9|}}} | * [{{{links_url9}}} {{#if: {{{links_name9|}}} | {{{links_name9}}} | }}] | }}{{#if: {{{links_url10|}}} | * [{{{links_url10}}} {{#if: {{{links_name10|}}} | {{{links_name10}}} | }}] | }}
 +
<!--
 
|-
 
|-
| colspan="2" | '''''Project Health:''''' {{:Projects/{{{project_name}}}/Project Assessment | Project Health Status}}
+
| colspan="2" | '''''Project Health:''''' {{#ifexist: Projects/{{{project_name}}}/GPC Project Health | {{:Projects/{{{project_name}}}/GPC Project Health | Project Health Status}} | {{Template: Not Reviewed}}
 +
}}-->
 
|-
 
|-
 
! style="background:#ccccff;" |'''Key Contacts'''
 
! style="background:#ccccff;" |'''Key Contacts'''
Line 50: Line 52:
 
* 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 56: Line 59:
 
By default:
 
By default:
 
* project_name = N/A
 
* project_name = N/A
 +
* project_homepage = ''not displayed''
 
* project_description = N/A
 
* project_description = N/A
 
* project_license = N/A
 
* project_license = N/A
 
* leader_*[1-10] = ''not displayed''
 
* leader_*[1-10] = ''not displayed''
* maintainer_*[1-10] = ''not displayed''
 
 
* contributor_*[1-10] = ''not displayed''
 
* contributor_*[1-10] = ''not displayed''
 
* pamphlet_link = N/A
 
* pamphlet_link = N/A
Line 69: Line 72:
 
* project_health_status = ''null'' (Not Reviewed)
 
* project_health_status = ''null'' (Not Reviewed)
  
=== Usage ===
+
= Usage =
 
<pre>
 
<pre>
 
{{Template:Project Info
 
{{Template:Project Info
 
| project_name =
 
| project_name =
 +
| project_home_page =
 
| project_description =
 
| project_description =
 
| project_license =
 
| project_license =
Line 78: Line 82:
 
| leader_email[1-10] =
 
| leader_email[1-10] =
 
| leader_username[1-10] =  
 
| leader_username[1-10] =  
| maintainer_name[1-10] =
 
| maintainer_email[1-10] =
 
| maintainer_username[1-10] =
 
 
| contributor_name[1-10] =  
 
| contributor_name[1-10] =  
 
| contributor_email[1-10] =  
 
| contributor_email[1-10] =  
Line 87: Line 88:
 
| presentation_link =
 
| presentation_link =
 
| mailing_list =  
 
| mailing_list =  
 +
| project_road_map =
 
| links_url[1-10] =  
 
| links_url[1-10] =  
 
| links_name[1-10] =  
 
| links_name[1-10] =  
| project_road_map =
 
| project_health_status =
 
 
}}
 
}}
 
</pre>
 
</pre>
  
=== Example ===
+
= Example =
 
<pre>
 
<pre>
 
{{Template:Project Info
 
{{Template:Project Info
 
| project_name = Example Project
 
| project_name = Example Project
 +
| project_home_page = Category: GPC Templates
 
| project_description = An example OWASP project
 
| project_description = An example OWASP project
 
| project_license = Creative Commons Attribution-Share Alike 3.0
 
| project_license = Creative Commons Attribution-Share Alike 3.0
 
| leader_username1 = Jason Li
 
| leader_username1 = Jason Li
 
| leader_name1 = Jason Li
 
| leader_name1 = Jason Li
| leader_name2 = Dinis Cruz
+
| leader_name2 = Brad Causey
| maintainer_name = Paulo Coimbra
+
| maintainer_email = paulo.coimbra@owasp.org
+
 
| contributor_username1 = mtesauro
 
| contributor_username1 = mtesauro
 
| contributor_name1 = Matt Tesauro
 
| contributor_name1 = Matt Tesauro
 
| presentation_link = https://www.owasp.org/images/2/23/Owasp-gpc-slides_June_2009.ppt
 
| presentation_link = https://www.owasp.org/images/2/23/Owasp-gpc-slides_June_2009.ppt
| mailing_list_name = global-projects-committee
+
| mailing_list_name = https://lists.owasp.org/mailman/listinfo/owasp-live-cd-2008-project
| project_road_map = Global_Projects_Committee
+
| project_road_map = http://www.owasp.org/index.php/Category:OWASP_Project_Frame_Experience_7_Roadmap
| project_health_status = 3
+
 
| links_url1 = http://www.owasp.org/index.php/Global_Projects_Committee
 
| links_url1 = http://www.owasp.org/index.php/Global_Projects_Committee
 
| links_name1 = Global Projects Committee
 
| links_name1 = Global Projects Committee
 
}}
 
}}
 
</pre>
 
</pre>
 +
== Output ==
 
{{Template:Project Info
 
{{Template:Project Info
 
| project_name = Example Project
 
| project_name = Example Project
 +
| project_home_page = Category: GPC Templates
 
| project_description = An example OWASP project
 
| project_description = An example OWASP project
 
| project_license = Creative Commons Attribution-Share Alike 3.0
 
| project_license = Creative Commons Attribution-Share Alike 3.0
 
| leader_username1 = Jason Li
 
| leader_username1 = Jason Li
 
| leader_name1 = Jason Li
 
| leader_name1 = Jason Li
| leader_name2 = Dinis Cruz
+
| leader_name2 = Brad Causey
| maintainer_name1 = Paulo Coimbra
+
| maintainer_email1 = paulo.coimbra@owasp.org
+
 
| contributor_username1 = mtesauro
 
| contributor_username1 = mtesauro
 
| contributor_name1 = Matt Tesauro
 
| contributor_name1 = Matt Tesauro
 
| presentation_link = https://www.owasp.org/images/2/23/Owasp-gpc-slides_June_2009.ppt
 
| presentation_link = https://www.owasp.org/images/2/23/Owasp-gpc-slides_June_2009.ppt
| mailing_list_name = global-projects-committee
+
| mailing_list_name = https://lists.owasp.org/mailman/listinfo/owasp-live-cd-2008-project
| project_road_map = Global_Projects_Committee
+
| project_road_map = http://www.owasp.org/index.php/Category:OWASP_Project_Frame_Experience_7_Roadmap
| project_health_status = 3
+
 
| links_url1 = http://www.owasp.org/index.php/Global_Projects_Committee
 
| links_url1 = http://www.owasp.org/index.php/Global_Projects_Committee
 
| links_name1 = Global Projects Committee
 
| links_name1 = Global Projects Committee
| links_url2 = http://www.owasp.org/index.php/Category:OWASP_Project
 
| links_name2 = OWASP Projects
 
 
}}
 
}}
 
</noinclude>
 
</noinclude>
 
<noinclude>[[Category: GPC Templates]]</noinclude>
 
<noinclude>[[Category: GPC Templates]]</noinclude>

Revision as of 11:37, 4 April 2013

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 = https://lists.owasp.org/mailman/listinfo/owasp-live-cd-2008-project
| project_road_map = http://www.owasp.org/index.php/Category:OWASP_Project_Frame_Experience_7_Roadmap
| 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: Mailing List Archives
Project Roadmap: 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.