blob: 2f880f2d35edd38966954c38c355829ebe85d548 [file] [log] [blame]
<!doctype html>
<html lang=''>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="styles.css">
<script src="js/jquery.js" type="text/javascript"></script>
<script type="text/javascript" src="https://www.google.com/jsapi"></script>
<script src="script.js"></script>
<script src="js/projects.js"></script>
<title>DOAP Extensions: PMC Data</title>
</head>
<body>
<div id="logo"><h1><div style="padding-top: 30px;">DOAP Extensions: PMC Data</div></h1></div>
<div id='cssmenu'>
<ul>
<li><a href='.'><span>Home</span></a></li>
<li><a href='committees.html'><span>Committees</span></a></li>
<li><a href='projects.html'><span>Projects</span></a></li>
<li><a href='releases.html'><span>Releases</span></a></li>
<li class='last'><a href='timelines.html'><span>Timelines</span></a></li>
<li style="background: none !important"><input type="text" style="margin-top: 20px;" onkeypress="checkKeyPress(event, this);" placeholder="Search..."/></li>
<li style="float: right;" class='active'><a href='about.html'><span>About</span></a></li>
<!--li style="background: none; float: right;"><a href="edit/"><img title="Edit project data" style="vertical-align: middle; margin-top: -5px; height: 24px; width: 24px;" src="images/edit.png"/></a></li-->
</ul>
</div>
<h2>ASF DOAP Extensions: PMC Data</h2>
<div>
<p>
This page represents the latest version of the asfext:pmc data format.
</p>
<p>Please note that the files do not have the same syntax as the project DOAP file(s).</p>
<p>The file is RDF and uses the following namespaces:</p>
<ul>
<li>xmlns="<a href="http://usefulinc.com/ns/doap">http://usefulinc.com/ns/doap</a>#"</li>
<li>xmlns:rdf="<a href="http://www.w3.org/1999/02/22-rdf-syntax-ns">http://www.w3.org/1999/02/22-rdf-syntax-ns</a>#"</li>
<li>xmlns:asfext="<a href="http://projects.apache.org/ns/asfext">http://projects.apache.org/ns/asfext</a>#"</li>
<li>xmlns:foaf="<a href="http://xmlns.com/foaf/0.1/">http://xmlns.com/foaf/0.1/</a>"</li>
</ul>
<table align="center" border="1" width="90%">
<tbody><tr>
<th>Element</th>
<th>Status</th>
<th>Description</th>
</tr>
<tr>
<td>asfext:pmc</td>
<td>Required</td>
<td>The top level element within a file.<br>
This should have an attribute 'rdf:about' that should be set to the <em>internal name</em> of the PMC.</td>
</tr>
<tr>
<td>asfext:name</td>
<td>Required</td>
<td>The name of the PMC, including the 'Apache ', e.g. 'Apache Forrest'<br>NB. There is no need to include 'PMC'.</td>
</tr>
<tr>
<td>foaf:homepage</td>
<td>Optional</td>
<td>If the PMC maintains a webpage providing more details of its activities then this can be included here. NB The link should be added if it provides additional information about the PMC, not if it simply points to a project. As this should point at at a resource link it should be encapsulated within an rdf:resource attribute, i.e. <pre>&lt;foaf:homepage rdf:resource="http://foo.apache.org/whoweare.html"&gt;</pre>
</td>
</tr>
<tr>
<td>asfext:charter</td>
<td>Required</td>
<td>Every PMC is created by a board resolution with a specific charter. That charter should be listed here as it gives the focus and scope of the PMC.</td>
</tr>
<tr>
<td>asfext:chair</td>
<td>Optional</td>
<td>This should contain the name of the current PMC chairperson, encapsulated as a foaf name, e.g.<br><pre>&lt;asfext:chair&gt;
&lt;foaf:Person&gt;
&lt;foaf:name&gt;Jo Bloggs&lt;/foaf:name&gt;
&lt;/foaf:Person&gt;
&lt;/asfext:chair&gt;</pre>
Normally just the name is given, but any additional FOAF elements can be included.
</td>
</tr>
<tr>
<td>asfext:member</td>
<td>Optional</td>
<td>A PMC may provide a list of all its members by adding a number of these elements - one per member. The members name (and optionally other information) is provided as a foaf:Person object. Normally just the persons name is given. e.g.<br>
<pre>&lt;asfext:member&gt;
&lt;foaf:Person&gt;
&lt;foaf:name&gt;Jo Bloggs&lt;/foaf:name&gt;
&lt;/foaf:Person&gt;
&lt;/asfext:member&gt;</pre>
</td>
</tr>
</tbody></table>
<p>
The PMC descriptor files are listed in <br>
<code><a href="https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/committees.xml">https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/committees.xml</a></code>.
</p>
<p>
The PMC descriptor file can either be stored in the data/committees/ folder
- i.e. <code>https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/committees/</code> -
or it can be stored elsewhere, e.g. in the PMC SVN area or on the PMC website area.
In this case, all project DOAP files must refer to the full URL of the PMC descriptor, for example
</p><pre>&lt;asfext:pmc rdf:resource="http://{tlp}.apache.org/pmc/{tlp}.rdf" /&gt;
or
&lt;asfext:pmc rdf:resource="http://svn.apache.org/repos/asf/{tlp}/trunk/{tlp}.rdf" /&gt;
</pre>
In all cases, the file must have the extension '.rdf'.
Also, the file must be listed in the file committees.xml
- i.e. <code>https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/committees.xml</code> -
so that the correct indexes can be generated.
<p></p>
<div class="section">
<h3>Example</h3>
<pre>&lt;?xml version="1.0"?&gt;
&lt;rdf:RDF xml:lang="en"
xmlns="http://usefulinc.com/ns/doap#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:asfext="http://projects.apache.org/ns/asfext#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"&gt;
&lt;asfext:pmc rdf:about="apr"&gt;
&lt;asfext:name&gt;Apache Portable Runtime&lt;/asfext:name&gt;
&lt;foaf:homepage rdf:resource="http://apr.apache.org/"/&gt;
&lt;asfext:charter&gt;The mission of the Apache Portable Runtime (APR) project is
to create and maintain software libraries that provide a predictable and
consistent interface to underlying platform-specific implementations. The
primary goal is to provide an API to which software developers may code
and be assured of predictable if not identical behaviour regardless of the
platform on which their software is built, relieving them of the need to
code special-case conditions to work around or take advantage of
platform-specific deficiencies or features.
&lt;/asfext:charter&gt;
&lt;asfext:chair&gt;
&lt;foaf:Person&gt;
&lt;foaf:name&gt;Garrett Rooney&lt;/foaf:name&gt;
&lt;/foaf:Person&gt;
&lt;/asfext:chair&gt;
&lt;asfext:member&gt;
&lt;foaf:Person&gt;
&lt;foaf:name&gt;Greg Ames&lt;/foaf:name&gt;
&lt;/foaf:Person&gt;
&lt;/asfext:member&gt;
&lt;asfext:member&gt;
&lt;foaf:Person&gt;
&lt;foaf:name&gt;Aaron Bannert&lt;/foaf:name&gt;
&lt;/foaf:Person&gt;
&lt;/asfext:member&gt;
...
&lt;/asfext:pmc&gt;
&lt;/rdf:RDF&gt;
</pre>
</div>
</div>
<div id="footer">
Managed by the <a href="http://community.apache.org">Apache Community Development Project</a>.<br/>
Copyright&copy; 2017, the Apache Software Foundation. Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a><br/>
Apache&reg; and the Apache feather logo are trademarks of The Apache Software Foundation.
</div>
</body>
</html>