site/guidelines.html - comdev-projects - Git at Google

 <!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">
    <!-- these are needed for the menu bar -->
    <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>
    <title>General DOAP Guidelines</title>
 </head>
 <body>

 <!-- Page Title -->

 <div id="logo"><h1><div style="padding-top: 30px;">General DOAP Guidelines</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>

 <!-- CONTENT -->


 <h2>General DOAP Guidelines</h2>
 <div>
 <div class="section">
 <h3>Formatting</h3>

 <ul>
 <li>rdf:resource should be used when listing URLs.
   <pre>i.e. &lt;doap:homepage rdf:resource="http://foo.apache.org/" /&gt;</pre> is the correct form to use.</li>
 <li>the doap:Project element may be embedded in other styles of feed, e.g. within an Atom feed. When included in such a way it should still follow all guidelines, even if this means duplicating information.</li>
 <li>Dates should be formatted as 'YYYY-MM-DD'. Numbers should be padded with '0' to match the formatting.
 <pre>e.g. Jan 1st 2001 should be written as '2001-01-01'</pre>
 </li>
 <li>all URLs should be fully qualified, including the protocol.
   <pre>i.e. http://foo.bar.com/file.html</pre>
 </li>
 </ul>

       </div>
 <div class="section">
 <h3>Naming</h3>

 <ul><li>projects should include the 'Apache' prefix when listing their project name.
   <pre>i.e. 'Apache HTTPD' instead of 'HTTPD'.</pre>
 </li></ul>

       </div>
 <div class="section">
 <h3>Categorisation</h3>

 <ul>
 <li>programming languages should be given as capitals unless their well known name is mixed case.
   <pre>e.g. Java, SVG, Tcl, Perl, etc</pre>
 <br>
 A full list of programming langauges we accept is available <a href="languages.html">here</a>
 </li>
 <li>all releases should have a "product" name (added using a doap:name element) included in the doap:Version element.<pre>
   i.e.
     "&lt;doap:Version&gt;
       &lt;doap:name&gt;Blah&lt;/doap:name&gt;..."
 </pre>
 </li>
 <li>The categories that a project should be recorded as being within are recorded as rdf:resource using the following format<pre>
  http://projects.apache.org/category/&lt;category&gt;
   e.g. &lt;doap:category rdf:resource="http://projects.apache.org/category/mail" /&gt;</pre>
 <br>A list of the categories is available <a href="categories.html">here</a>
 </li>
 <li>the shortdesc element is used for providing a brief description on index pages and should be included.</li>
 </ul>
       </div>
 <div class="section">
 <h3>PMC descriptors</h3>

 <ul>
 <li>PMC descriptor files must always have the extension '.rdf', and must be listed in the file <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>
 </li>
 <li>PMCs can be referenced as an rdf:resource that points at http://&lt;pmc&gt;.apache.org/.  e.g. <br>
 <code>&lt;asfext:pmc rdf:resource="http://httpd.apache.org/" /&gt;</code>. <br>
   In this case, the PMC descriptor file must be called <code>&lt;pmc&gt;.rdf</code> and must be
   stored in the directory: <br>
   <code>https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/committees/</code>
   </li>
 <li>PMCs descriptors can also be stored anywhere else (e.g. on the TLP website or in SVN), in which case they
 must be referenced using the full URL, for example  <br>
 <code>&lt;asfext:pmc rdf:resource="http://tlp.apache.org/pmc/tlp.rdf" /&gt;</code>
 </li>
 </ul>
       </div>
 </div>

 <!-- Footer -->

 <div id="footer">
    Managed by the <a href="http://community.apache.org">Apache Community Development Project</a>.<br/>
    Copyright&copy; 2019, 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>
	<!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">
	<!-- these are needed for the menu bar -->
	<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>
	<title>General DOAP Guidelines</title>
	</head>
	<body>

	<!-- Page Title -->

	<div id="logo"><h1><div style="padding-top: 30px;">General DOAP Guidelines</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>

	<!-- CONTENT -->


	<h2>General DOAP Guidelines</h2>
	<div>
	<div class="section">
	<h3>Formatting</h3>

	<ul>
	<li>rdf:resource should be used when listing URLs.
	<pre>i.e. <doap:homepage rdf:resource="http://foo.apache.org/" /></pre> is the correct form to use.</li>
	<li>the doap:Project element may be embedded in other styles of feed, e.g. within an Atom feed. When included in such a way it should still follow all guidelines, even if this means duplicating information.</li>
	<li>Dates should be formatted as 'YYYY-MM-DD'. Numbers should be padded with '0' to match the formatting.
	<pre>e.g. Jan 1st 2001 should be written as '2001-01-01'</pre>
	</li>
	<li>all URLs should be fully qualified, including the protocol.
	<pre>i.e. http://foo.bar.com/file.html</pre>
	</li>
	</ul>

	</div>
	<div class="section">
	<h3>Naming</h3>

	<ul><li>projects should include the 'Apache' prefix when listing their project name.
	<pre>i.e. 'Apache HTTPD' instead of 'HTTPD'.</pre>
	</li></ul>

	</div>
	<div class="section">
	<h3>Categorisation</h3>

	<ul>
	<li>programming languages should be given as capitals unless their well known name is mixed case.
	<pre>e.g. Java, SVG, Tcl, Perl, etc</pre>
	<br>
	A full list of programming langauges we accept is available <a href="languages.html">here</a>
	</li>
	<li>all releases should have a "product" name (added using a doap:name element) included in the doap:Version element.<pre>
	i.e.
	"<doap:Version>
	<doap:name>Blah</doap:name>..."
	</pre>
	</li>
	<li>The categories that a project should be recorded as being within are recorded as rdf:resource using the following format<pre>
	http://projects.apache.org/category/<category>
	e.g. <doap:category rdf:resource="http://projects.apache.org/category/mail" /></pre>
	<br>A list of the categories is available <a href="categories.html">here</a>
	</li>
	<li>the shortdesc element is used for providing a brief description on index pages and should be included.</li>
	</ul>
	</div>
	<div class="section">
	<h3>PMC descriptors</h3>

	<ul>
	<li>PMC descriptor files must always have the extension '.rdf', and must be listed in the file <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>
	</li>
	<li>PMCs can be referenced as an rdf:resource that points at http://<pmc>.apache.org/. e.g. <br>
	<code><asfext:pmc rdf:resource="http://httpd.apache.org/" /></code>. <br>
	In this case, the PMC descriptor file must be called <code><pmc>.rdf</code> and must be
	stored in the directory: <br>
	<code>https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/committees/</code>
	</li>
	<li>PMCs descriptors can also be stored anywhere else (e.g. on the TLP website or in SVN), in which case they
	must be referenced using the full URL, for example <br>
	<code><asfext:pmc rdf:resource="http://tlp.apache.org/pmc/tlp.rdf" /></code>
	</li>
	</ul>
	</div>
	</div>

	<!-- Footer -->

	<div id="footer">
	Managed by the <a href="http://community.apache.org">Apache Community Development Project</a>.<br/>
	Copyright© 2019, 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® and the Apache feather logo are trademarks of The Apache Software Foundation.
	</div>
	</body>
	</html>