Skip to content

Commit

Permalink
Properties Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sdesai
sdesai committed Feb 27, 2009
1 parent 3df81a9 commit a1d063c
Show file tree
Hide file tree
Showing 4 changed files with 363 additions and 88 deletions.
26 changes: 26 additions & 0 deletions componentbuild/docs/docs.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
html, body {
background-color:#F8F5EA
}

table {
margin:1em;
}

caption {
text-align:left;
font-weight:bold;
}

caption p {
margin:2px;
}

caption .filepath {
margin-top:0;
font-family:monospace;
color:#006600;
}

th, td.term {
background-color:#DFDBC3;
}
310 changes: 310 additions & 0 deletions componentbuild/docs/properties.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,310 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">

<title>YUI ANT Property Definitions</title>
<link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.7.0/build/reset/reset-min.css">
<link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.7.0/build/fonts/fonts-min.css">
<link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.7.0/build/base/base-min.css">
<link rel="stylesheet" type="text/css" href="docs.css">
</head>

<body>
<table>
<caption>
<p>BOOTSTRAP PROPERTIES</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">builddir</td>
<td>The path to the builder/componentbuild directory from the component build file. If the builder directory sits next to the yui2/yui3 source code directory then this does not need to be changed from the default value.</td>
</tr>
<tr>
<td class="term">srcdir</td>
<td>The path to top of the project source directory (e.g. yui2/, yui3/) from the component build file.</td>
</tr>
<tr>
<td class="term">yui.version</td>
<td>The version of YUI, 2 or 3.</td>
</tr>
</tbody>
</table>

<table>
<caption>
<p>BUILD FILE PATHS</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">global.build.base</td>
<td>The path to the top level build directory</td>
</tr>
<tr>
<td class="term">global.build.component</td>
<td>The path to the top level build directory for the component being built (e.g. yui2/build)</td>
</tr>
<tr>
<td class="term">global.build.component</td>
<td>The path to the top level build directory for the component being built (e.g. yui2/build/autocomplete)</td>
</tr>
<tr>
<td class="term">global.build.component.assets</td>
<td>The path to the top level assets directory for the component being built (e.g. yui2/build/autocomplete/assets)</td>
</tr>
</tbody>
</table>
<table>
<caption>
<p>COMPONENT CONFIGURATION</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">component</td>
<td>Component name, lower-case. Used for build filenames(e.g. component.js, component-min.js)</td>
</tr>
<tr>
<td class="term">component.module</td>
<td>Module name, mostly always the same as component</td>
</tr>
<tr>
<td class="term">component.rollup</td>
<td>Whether or not the component is a rollup. [YUI3 Only]</td>
</tr>
<tr>
<td class="term">component.rollup.modules.buildfiles</td>
<td>The build files for the sub-modules making up the rollup. [YUI3 Only]</td>
</tr>
<tr>
<td class="term">component.rollup.target</td>
<td>The default target to run on sub-module builds, initiated by the rollup build. [YUI3 Only]</td>
</tr>
<tr>
<td class="term">component.use</td>
<td>Comma separated list of modules which the built module should "use". Used in generating the boilerplate registration code [YUI3 Only].</td>
</tr>
<tr>
<td class="term">component.supersedes</td>
<td>Comma separated list of modules which the built module "supercedes". Used in generating the boilerplate registration code [YUI3 Only].</td>
</tr>
<tr>
<td class="term">component.requires</td>
<td>Comma separated list of modules which the built module "requires". Used in generating the boilerplate registration code [YUI3 Only].</td>
</tr>
<tr>
<td class="term">component.optional</td>
<td>Comma separated list of "optional" modules for the built module. Used in generating the boilerplate registration code [YUI3 Only].</td>
</tr>
<tr>
<td class="term">component.skinnable</td>
<td>Whether or not the component is "skinnable". Used in generating the boilerplate registration code [YUI3 Only].</td>
</tr>
<tr>
<td class="term">component.mainclass</td>
<td>Main JS class representing the module. Version code will be added to this class. [YUI2 Only]</td>
</tr>
<tr>
<td class="term">component.logger.regex</td>
<td>
<p>Regex used to strip logger statements</p>
<p><strong>IMPORTANT :</strong></p>
<ul>
<li>Log statements need to end in semi-colons, otherwise the default regex will strip out code until the next semi-colon is hit.</li>
<li>Any code on the same line as the start or end of a Log statement will be stripped. Hence Log statments should be on their own lines.</li>
</ul>
</td>
</tr>
<tr>
<td class="term">component.logger.regex.byline</td>
<td>If component.logger.regex.byline is false, regex will match against the entire file as opposed to line by line - required for multiline search.</td>
</tr>
<tr>
<td class="term">component.logger.regex.flags</td>
<td>The set of standard Perl5 regex flags which apply. Defaults to "mg" if not provided.</td>
</tr>
<tr>
<td class="term">component.logger.regex.replace</td>
<td>The replacement string to use. Defaults to empty string.</td>
</tr>
<tr>
<td class="term">component.logger.regex.skip</td>
<td>Can be set to true, to skip the logger regex replacement step.</td>
</tr>
</tbody>
</table>
<table>
<caption>
<p>COMPONENT FILE PATHS</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">component.basedir</td>
<td>Absolute path to the component's base directory (e.g. yui2/src/autocomplete)</td>
</tr>
<tr>
<td class="term">component.srcdir</td>
<td>Absolute path to the component's base directory (e.g. yui2/src/autocomplete)</td>
</tr>
<tr>
<td class="term">component.builddir</td>
<td>Absolute path to the component's local build directory (e.g. yui2/src/autocomplete/build_tmp)</td>
</tr>
<tr>
<td class="term">component.jsfiles</td>
<td>Comma seperated ordered list of JS source files to be concatenated, relative to component.basedir/js</td>
</tr>
<tr>
<td class="term">component.cssfiles</td>
<td>Comma seperated ordered list of CSS source files to be concatenated (for CSS modules), relative to component.basedir/css</td>
</tr>
<tr>
<td class="term">component.prependfiles</td>
<td>Comma separated list of files to prepend to the built files (in the case of YUI 3, this content would reside outside the registration boilerplate code). Filepaths are relative to component.basedir.</td>
</tr>
<tr>
<td class="term">component.appendfiles</td>
<td>Comma separated list of files to append to the built files (in the case of YUI 3, this content would reside outside the registration boilerplate code). Filepaths are relative to component.basedir.</td>
</tr>
<tr>
<td class="term">component.assets.skins.base</td>
<td>
<p>Base directory for the component's skinning assets (e.g. yui2/src/autocomplete/assets/skins).</p>

<p>If this value is set, the build expects the following directory structure, underneath the skins directory:</p>

<pre>
&lt;component.assets.skins.base&gt;
- &lt;component&gt;-core.css
- skins/sam/&lt;component&gt;-skin.css
- skins/sam/*.gif, *.png, *.jpg
</pre>
</td>
</tr>
<tr>
<td class="term">component.assets.skins.files</td>
<td>Set of skinning assets to deploy (defaults to **/*).</td>
</tr>
<tr>
<td class="term">component.assets.base</td>
<td>Base directory for the component's non-skinning related assets. e.g. SWFs and non-skinned images.</td>
</tr>
<tr>
<td class="term">component.assets.files</td>
<td>Set of asset files to deploy (defaults to **/*).</td>
</tr>
<tr>
<td class="term">component.assets.flatten</td>
<td>Whether or not to flatten the asset directory structure when deploying to build.</td>
</tr>
</tbody>
</table>
<table>
<caption>
<p>External Tools</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">rhino.jar</td>
<td>Path to rhino.jar, used to run jslint.</td>
</tr>
<tr>
<td class="term">jslintconsole.js</td>
<td>Path to the console script used to run jslint.</td>
</tr>
<tr>
<td class="term">jslintsrc.js</td>
<td>Path to the jslint implementation.</td>
</tr>
<tr>
<td class="term">yuicompressor.jar</td>
<td>Path to the YUI Compressor jar, used for minification.</td>
</tr>
<tr>
<td class="term">yuicompressor.css.args</td>
<td>YUICompressor args for CSS compression.</td>
</tr>
<tr>
<td class="term">yuicompressor.js.args</td>
<td>YUICompressor args for JS compression.</td>
</tr>
<tr>
<td class="term">yuicompressor.js.verbose</td>
<td>Whether or not YUICompressor should run with verbose output enabled for JS compression. If enabled, YUICompressor will show code related warnings/suggestions during compression. NOTE: Checked in build files should have been compressed with this flag set to true.</td>
</tr>
<tr>
<td class="term">yuicompressor.css.verbose</td>
<td>Whether or not YUICompressor should run with verbose output enabled for CSS compession.</td>
</tr>
</tbody>
</table>

<table>
<caption>
<p>Miscenalleous Properties</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">buildfiles.eol</td>
<td>The EOL character to use for built files. Defaults to "lf".</td>
</tr>
<tr>
<td class="term">workingdir</td>
<td>The temporary directory which ant should use during the build. This directory will be deleted at the end of the build.</td>
</tr>
<tr>
<td class="term">yui.variable</td>
<td>The YUI instance variable name to use when generating the YUI.add(function(YUIInstanceVariable) {}) wrapper. Defaults to "Y". [YUI3 Only]</td>
</tr>
<tr>
<td class="term">lint.skip</td>
<td>Set to true to skip the lint step, during a build. NOTE: Checked in build files should not have this flag set to true. Checked in component code needs to have gone through lint.</td>
</tr>
<tr>
<td class="term">register.skip</td>
<td>Set to true to skip the build step which adds the boiler plate registration code. This can be used if your code has the registration code added manually, however this is not recommended.</td>
</tr>
<tr>
<td class="term">clean.skip</td>
<td>Set to true to skip the build step which deletes the local build directory (build_tmp) before each build.</td>
</tr>
</tbody>
</table>
</body>
</html>
Loading

0 comments on commit a1d063c

Please sign in to comment.