blob: a0551dc323a3878596696a53e5bdd1b8f86d9747 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="keywords" content="SMILA/Style Guide,SMILA,SMILA/Glossary" />
<link rel="shortcut icon" href="http://wiki.eclipse.org/SMILA/favicon.ico" />
<link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (English)" />
<link rel="alternate" type="application/rss+xml" title="Eclipsepedia RSS Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&amp;feed=rss" />
<link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&amp;feed=atom" />
<title>SMILA/Style Guide - Eclipsepedia</title>
<style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "/skins/eclipsenova/novaWide.css?116"; /*]]>*/</style>
<link rel="stylesheet" type="text/css" media="print" href="http://wiki.eclipse.org/skins/eclipsenova/eclipsenovaPrint.css?116" />
<link rel="stylesheet" type="text/css" media="handheld" href="http://wiki.eclipse.org/skins/eclipsenova/handheld.css?116" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/header.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/tabs.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/visual.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/layout.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/footer.css" media="screen" />
<!--[if IE]><link rel="stylesheet" type="text/css" href="/skins/eclipsenova/IEpngfix.css" media="screen" /><![endif]-->
<!--[if lt IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE50Fixes.css?116";</style> <![endif]-->
<!--[if IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE55Fixes.css?116";</style><![endif]-->
<!--[if IE 6]><style type="text/css">@import "/skins/eclipsenova/IE60Fixes.css?116";</style><![endif]-->
<!--[if IE 7]><style type="text/css">@import "/skins/eclipsenova/IE70Fixes.css?116";</style><![endif]-->
<!--[if lt IE 7]><script type="text/javascript" src="/skins/common/IEFixes.js?116"></script>
<meta http-equiv="imagetoolbar" content="no" /><![endif]-->
<script type= "text/javascript">/*<![CDATA[*/
var skin = "eclipsenova";
var stylepath = "/skins";
var wgArticlePath = "/$1";
var wgScriptPath = "";
var wgScript = "/index.php";
var wgServer = "http://wiki.eclipse.org";
var wgCanonicalNamespace = "";
var wgCanonicalSpecialPageName = false;
var wgNamespaceNumber = 0;
var wgPageName = "SMILA/Style_Guide";
var wgTitle = "SMILA/Style Guide";
var wgAction = "view";
var wgRestrictionEdit = [];
var wgRestrictionMove = [];
var wgArticleId = "16094";
var wgIsArticle = true;
var wgUserName = null;
var wgUserGroups = null;
var wgUserLanguage = "en";
var wgContentLanguage = "en";
var wgBreakFrames = false;
var wgCurRevisionId = "124148";
var wgVersion = "1.12.0";
var wgEnableAPI = true;
var wgEnableWriteAPI = false;
/*]]>*/</script>
<script type="text/javascript" src="http://wiki.eclipse.org/skins/common/wikibits.js?116"><!-- wikibits js --></script>
<!-- Performance mods similar to those for bug 166401 -->
<script type="text/javascript" src="http://wiki.eclipse.org/index.php?title=-&amp;action=raw&amp;gen=js&amp;useskin=eclipsenova"><!-- site js --></script>
<!-- Head Scripts -->
<script type="text/javascript" src="http://wiki.eclipse.org/skins/common/ajax.js?116"></script>
<style type="text/css">/*<![CDATA[*/
.source-xml {line-height: normal; font-size: medium;}
.source-xml li {line-height: normal;}
/**
* GeSHi Dynamically Generated Stylesheet
* --------------------------------------
* Dynamically generated stylesheet for xml
* CSS class: source-xml, CSS id:
* GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
*/
.source-xml .de1, .source-xml .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
.source-xml {}
.source-xml .head {}
.source-xml .foot {}
.source-xml .imp {font-weight: bold; color: red;}
.source-xml .ln-xtra {color: #cc0; background-color: #ffc;}
.source-xml li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
.source-xml li.li2 {font-weight: bold;}
.source-xml .coMULTI {color: #808080; font-style: italic;}
.source-xml .es0 {color: #000099; font-weight: bold;}
.source-xml .br0 {color: #66cc66;}
.source-xml .st0 {color: #ff0000;}
.source-xml .nu0 {color: #cc66cc;}
.source-xml .sc0 {color: #00bbdd;}
.source-xml .sc1 {color: #ddbb00;}
.source-xml .sc2 {color: #339933;}
.source-xml .sc3 {color: #009900;}
.source-xml .re0 {color: #000066;}
.source-xml .re1 {font-weight: bold; color: black;}
.source-xml .re2 {font-weight: bold; color: black;}
/*]]>*/
</style>
<style type="text/css">/*<![CDATA[*/
@import "/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000";
/*]]>*/
</style><link rel="stylesheet" type="text/css" href="Style_Guide.html" /> </head>
<body class="mediawiki ns-0 ltr page-SMILA_Style_Guide">
<div id="globalWrapper">
<div id="column-one">
<!-- Eclipse Additions for the Top Nav start here M. Ward-->
<div id="header">
<div id="header-graphic">
<img src="http://wiki.eclipse.org/skins/eclipsenova/eclipse.png" alt="Eclipse Wiki">
</div>
<!-- Pulled 101409 Mward -->
<div class="portlet" id="p-personal">
<div class="pBody">
<ul>
<li id="pt-login"><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&amp;returnto=SMILA/Style_Guide">Log in</a></li>
</ul>
</div>
</div>
<div id="header-icons">
<div id="sites">
<ul id="sitesUL">
<li><a href="http://www.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/eclipseIcon.png" width="28" height="28" alt="Eclipse Foundation" title="Eclipse Foundation" /><div>Eclipse Foundation</div></a></li>
<li><a href="http://marketplace.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/marketplace.png" width="28" height="28" alt="Eclipse Marketplace" title="Eclipse Marketplace" /><div>Eclipse Marketplace</div></a></li>
<li><a href="https://bugs.eclipse.org/bugs"><img src="http://dev.eclipse.org/custom_icons/system-search-bw.png" width="28" height="28" alt="Bugzilla" title="Bugzilla" /><div>Bugzilla</div></a></li>
<li><a href="http://live.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/audio-input-microphone-bw.png" width="28" height="28" alt="Live" title="Live" /><div>Eclipse Live</div></a></li>
<li><a href="http://planeteclipse.org"><img src="http://dev.eclipse.org/large_icons/devices/audio-card.png" width="28" height="28" alt="PlanetEclipse" title="Planet" /><div>Planet Eclipse</div></a></li>
<li><a href="http://portal.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/preferences-system-network-proxy-bw.png" width="28" height="28" alt="Portal" title="Portal" /><div>My Foundation Portal</div></a></li>
</ul>
</div>
</div>
</div>
<!-- NEW HEADER STUFF HERE -->
<div id="header-menu">
<div id="header-nav">
<ul> <li><a class="first_one" href="http://wiki.eclipse.org/" target="_self">Home</a></li> <li><a href="http://www.eclipse.org/downloads/" target="_self">Downloads</a></li>
<li><a href="http://www.eclipse.org/users/" target="_self">Users</a></li>
<li><a href="http://www.eclipse.org/membership/" target="_self">Members</a></li>
<li><a href="http://wiki.eclipse.org/index.php/Development_Resources" target="_self">Committers</a></li>
<li><a href="http://www.eclipse.org/resources/" target="_self">Resources</a></li>
<li><a href="http://www.eclipse.org/projects/" target="_self">Projects</a></li>
<li><a href="http://www.eclipse.org/org/" target="_self">About Us</a></li>
</ul>
</div>
<div id="header-utils">
<!-- moved the search window here -->
<form action="http://wiki.eclipse.org/Special:Search" >
<input class="input" name="search" type="text" accesskey="f" value="" />
<input type='submit' onclick="this.submit();" name="go" id="searchGoButton" class="button" title="Go to a page with this exact name if one exists" value="Go" />&nbsp;
<input type='submit' onclick="this.submit();" name="fulltext" class="button" id="mw-searchButton" title="Search Eclipsepedia for this text" value="Search" />
</form>
</div>
</div>
<!-- Eclipse Additions for the Header stop here -->
<!-- Additions and mods for leftside nav Start here -->
<!--Started nav rip here-->
<!-- these are the nav controls main page, changes etc -->
<div id="novaContent" class="faux">
<div id="leftcol">
<ul id="leftnav">
<!-- these are the page controls, edit history etc -->
<li class="separator"><a class="separator">Navigation &#160;&#160;</li>
<li id="n-mainpage"><a href="http://wiki.eclipse.org/Main_Page">Main Page</a></li>
<li id="n-portal"><a href="http://wiki.eclipse.org/Eclipsepedia:Community_Portal">Community portal</a></li>
<li id="n-currentevents"><a href="http://wiki.eclipse.org/Eclipsepedia:Current_events">Current events</a></li>
<li id="n-recentchanges"><a href="http://wiki.eclipse.org/Special:Recentchanges">Recent changes</a></li>
<li id="n-randompage"><a href="http://wiki.eclipse.org/Special:Random">Random page</a></li>
<li id="n-help"><a href="http://wiki.eclipse.org/Help:Contents">Help</a></li>
<li class="separator"><a class="separator">Toolbox &#160;&#160;</a></li>
<li id="t-whatlinkshere"><a href="http://wiki.eclipse.org/Special:Whatlinkshere/SMILA/Style_Guide">What links here</a></li>
<li id="t-recentchangeslinked"><a href="http://wiki.eclipse.org/Special:Recentchangeslinked/SMILA/Style_Guide">Related changes</a></li>
<!-- This is the toolbox section -->
<li id="t-upload"><a href="http://wiki.eclipse.org/Special:Upload">Upload file</a></li>
<li id="t-specialpages"><a href="http://wiki.eclipse.org/Special:Specialpages">Special pages</a></li>
<li id="t-print"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Style_Guide&amp;printable=yes">Printable version</a></li> <li id="t-permalink"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Style_Guide&amp;oldid=124148">Permanent link</a></li> </ul>
</div>
<!-- Additions and mods for leftside nav End here -->
<div id="column-content">
<div id="content">
<a name="top" id="top"></a>
<div id="tabs">
<ul class="primary">
<li class="active"><a href="Style_Guide.html"><span class="tab">Page</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Style_Guide&amp;action=edit"><span class="tab">Discussion</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Style_Guide&amp;action=edit"><span class="tab">View source</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Style_Guide&amp;action=history"><span class="tab">History</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&amp;returnto=SMILA/Style%20Guide"><span class="tab">Edit</span></a></li>
</ul>
</div>
<script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script>
<h1 class="firstHeading">SMILA/Style Guide</h1>
<div id="bodyContent">
<h3 id="siteSub">From Eclipsepedia</h3>
<div id="contentSub"><span class="subpages">&lt; <a href="../SMILA.html" title="SMILA">SMILA</a></span></div>
<div id="jump-to-nav">Jump to: <a href="Style_Guide.html#column-one">navigation</a>, <a href="Style_Guide.html#searchInput">search</a></div> <!-- start content -->
<p>This document gives the style conventions to be used in the <a href="../SMILA.html" title="SMILA">SMILA</a> Wiki. Please follow these guidelines on all SMILA Wiki pages to guarantee similar styles and conventions.
</p>
<table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1"><a href="Style_Guide.html#Language"><span class="tocnumber">1</span> <span class="toctext">Language</span></a></li>
<li class="toclevel-1"><a href="Style_Guide.html#Pages"><span class="tocnumber">2</span> <span class="toctext">Pages</span></a></li>
<li class="toclevel-1"><a href="Style_Guide.html#Headings"><span class="tocnumber">3</span> <span class="toctext">Headings</span></a></li>
<li class="toclevel-1"><a href="Style_Guide.html#Terminology"><span class="tocnumber">4</span> <span class="toctext">Terminology</span></a></li>
<li class="toclevel-1"><a href="Style_Guide.html#Examples"><span class="tocnumber">5</span> <span class="toctext">Examples</span></a></li>
<li class="toclevel-1"><a href="Style_Guide.html#Images"><span class="tocnumber">6</span> <span class="toctext">Images</span></a></li>
<li class="toclevel-1"><a href="Style_Guide.html#Conventions_of_formats"><span class="tocnumber">7</span> <span class="toctext">Conventions of formats</span></a></li>
</ul>
</td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script>
<a name="Language"></a><h2> <span class="mw-headline"> Language </span></h2>
<p>Use American English.
</p>
<a name="Pages"></a><h2> <span class="mw-headline"> Pages </span></h2>
<p>Guidelines for the page name:
</p>
<ul><li> Use a self-explanatory page name.
</li><li> Separate words in the page name by underscores, e.g. "Development_Guidelines".
</li><li> Do not use articles (the, a, an) or prepositions (to, for, from) in page names unless they are essential for understanding the context. Example: "Integrate_Components" is a better page name than "Integrate_a_Component_in_SMILA" in case your page is a general description of this topic but "How_to_Integrate_Components" is OK to indicate that your page contains a how-to tutorial.
</li><li> Use title capitalization for page names.
</li></ul>
<p><br />
Other guidelines referring to the page:
</p>
<ul><li> Provide a short description after the page heading that describes the contents of your page. Help the reader to quickly find out the main topic of your page.
</li><li> Provide a table of contents where it is reasonable. This should be applied automatically to your page.
</li><li> Tag your page with the SMILA category: <code>[[Category:SMILA]]</code>
</li></ul>
<a name="Headings"></a><h2> <span class="mw-headline"> Headings </span></h2>
<p>Guidelines for headings:
</p>
<ul><li> Do not omit a heading level. As the page header is already at first-level, always start with second-level headings. Only use third-level headings if you have used second-level headings before.
</li><li> Do not use title capitalization for headings, i.e. use uppercase letters for the first letter of the first word in a heading only. Subsequent words are only capitalized if they refer to a proper name.
</li><li> Do not repeat the page name as a heading.
</li></ul>
<a name="Terminology"></a><h2> <span class="mw-headline"> Terminology </span></h2>
<p>Use the spelling and capitalization of SMILA terms as shown on the <a href="Glossary.html" title="SMILA/Glossary">SMILA glossary</a>. If your term appears not on this page, add it to the glossary, and provide a description (if reasonable). Provide a link to the glossary entry on your page.
</p>
<a name="Examples"></a><h2> <span class="mw-headline"> Examples </span></h2>
<p>Always provide a short description of your code example. Depending on the example one or two sentences might already be enough. However, the code example alone without a description might not be very helpful.
</p>
<a name="Images"></a><h2> <span class="mw-headline"> Images </span></h2>
<p>The same as with examples (see above). Make sure to provide a short description.
</p>
<a name="Conventions_of_formats"></a><h2> <span class="mw-headline"> Conventions of formats </span></h2>
<p>The following table describes how different text elements should be formatted. Please follow the conventions given.
</p>
<table border="1">
<tr>
<th style="width:20%"> Element
</th><th style="width:40%"> Description
</th><th style="width:40%"> Example
</th></tr>
<tr>
<td> Properties
</td><td> Use italics for properties, attributes, and parameters.
</td><td> It converts the document's content defined by the <i>AttachmentContent</i> attribute and stores the plain text results in the <i>AttachmentText</i> attribute.
</td></tr>
<tr>
<td> XML elements
</td><td> Use monospace font for XML elements.
</td><td> The <tt>Property</tt> element is used to define ...
</td></tr>
<tr>
<td> Filenames
</td><td> Use monospace font for filenames. If you refer to an environment variable use <tt>$varname</tt> as a reference to the variable. If you refer to the default installation directory, a user's home folder, or another typical folder use a notation in angle brackets to refer to this location in a file name. You will have to use the corresponding HTML entities to escape the angle brackets. Always use the "/" character in paths (not "\" as in Windows).
</td><td> <tt>$SMILA_HOME/configuration/xyz</tt>
<p><tt>&lt;your-home-directory&gt;/dev/src/xyz</tt>
</p>
</td></tr>
<tr>
<td> Packages, classes, interfaces, ...
</td><td> Use monospace font for packages, bundles, classes, interfaces and other code elements.
</td><td> <tt>org.eclipse.smila.processing.pipelets.aperture</tt>
</td></tr>
<tr>
<td> Source code
</td><td> Use <a href="http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi" class="external text" title="http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi" rel="nofollow">syntax highlighting</a> where possible.
</td><td> <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1">&lt;PipeletConfiguration</span> <span class="re0">xmlns</span>=<span class="st0">&quot;http://www.eclipse.org/eilf/processor&quot;</span><span class="re2">&gt;</span></span>
<span class="sc3"><span class="re1">&lt;Property</span> <span class="re0">name</span>=<span class="st0">&quot;AttachmentContent&quot;</span><span class="re2">&gt;</span></span>
<span class="sc3"><span class="re1">&lt;Value<span class="re2">&gt;</span></span></span>Content<span class="sc3"><span class="re1">&lt;/Value<span class="re2">&gt;</span></span></span>
<span class="sc3"><span class="re1">&lt;/Property<span class="re2">&gt;</span></span></span>
<span class="sc3"><span class="re1">&lt;Property</span> <span class="re0">name</span>=<span class="st0">&quot;AttachmentText&quot;</span><span class="re2">&gt;</span></span>
<span class="sc3"><span class="re1">&lt;Value<span class="re2">&gt;</span></span></span>Text<span class="sc3"><span class="re1">&lt;/Value<span class="re2">&gt;</span></span></span>
<span class="sc3"><span class="re1">&lt;/Property<span class="re2">&gt;</span></span></span>
<span class="sc3"><span class="re1">&lt;Property</span> <span class="re0">name</span>=<span class="st0">&quot;AttachmentMimeType&quot;</span><span class="re2">&gt;</span></span>
<span class="sc3"><span class="re1">&lt;Value<span class="re2">&gt;</span></span></span>MimeType<span class="sc3"><span class="re1">&lt;/Value<span class="re2">&gt;</span></span></span>
<span class="sc3"><span class="re1">&lt;/Property<span class="re2">&gt;</span></span></span>
<span class="sc3"><span class="re1">&lt;/PipeletConfiguration<span class="re2">&gt;</span></span></span></pre></div>
</td></tr>
<tr>
<td> Labels and UI names
</td><td> Use italics for captions, labels, and the names of buttons, windows, options, and other UI elements.
</td><td> Select the <i>Checkstyle</i> preference page and click the <i>New</i> button.
</td></tr></table>
<!--
NewPP limit report
Preprocessor node count: 20/1000000
Post-expand include size: 0/2097152 bytes
Template argument size: 0/2097152 bytes
#ifexist count: 0/100
-->
<!-- Saved in parser cache with key wikidb:pcache:idhash:16094-0!1!0!!en!2!edit=0 and timestamp 20120202171425 -->
<div class="printfooter">
Retrieved from "<a href="Style_Guide.html">http://wiki.eclipse.org/SMILA/Style_Guide</a>"</div>
<div id="catlinks"><p class='catlinks'><a href="http://wiki.eclipse.org/Special:Categories" title="Special:Categories">Category</a>: <span dir='ltr'><a href="http://wiki.eclipse.org/Category:SMILA" title="Category:SMILA">SMILA</a></span></p></div> <!-- end content -->
<div class="visualClear"></div>
</div>
</div>
</div>
<!-- Yoink of toolbox for phoenix moved up -->
</div>
</div>
<div id="clearFooter"/>
<div id="footer" >
<ul id="footernav">
<li class="first"><a href="http://www.eclipse.org/">Home</a></li>
<li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
<li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
<li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
<li><a href="http://www.eclipse.org/org/foundation/contact.php">Contact</a></li>
<li><a href="http://wiki.eclipse.org/Eclipsepedia:About" title="Eclipsepedia:About">About Eclipsepedia</a></li>
</ul>
<span id="copyright">Copyright &copy; 2012 The Eclipse Foundation. All Rights Reserved</span>
<p id="footercredit">This page was last modified 10:17, 17 October 2008 by <a href="http://wiki.eclipse.org/User:T.menzel.brox.de" title="User:T.menzel.brox.de">thomas menzel</a>. Based on work by <a href="http://wiki.eclipse.org/User:Daniel.stucky.empolis.com" title="User:Daniel.stucky.empolis.com">Daniel Stucky</a>.</p>
<p id="footerviews">This page has been accessed 4,381 times.</p>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-910670-4");
pageTracker._trackPageview();
</script>
<!-- <div class="visualClear"></div> -->
<script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script>
</div>
<!-- Served in 0.066 secs. --></body></html>