Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Removed component.srcdir - no longer required, and not used in yui2/s…

…rc, yui3/src. Finished new target and property docs, removed old docs
  • Loading branch information...
commit b43ac545c191f6276e432fd5895ded9cb34cf21d 1 parent a1d063c
Satyen Desai authored
View
39 componentbuild/docs/build.common.properties
@@ -1,39 +0,0 @@
-##########################################################################
-# Common Build Properties
-#
-# This file contains the most common set of properties which you probably need to configure to get a build up and going
-# Use it along with build.common.xml as a starting point to customize your build process.
-#
-# See build.example.properties and build.example.xml for the complete list of configurable variables
-#
-##########################################################################
-
-component=foobarwidget
-component.module=${component}
-component.mainclass=YAHOO.widget.FooBar
-# Uncomment the following line if your component is in beta. The built files will be named accordingly [ component-beta.js, component-beta-min.js etc.]
-# component.releasetype=beta
-
-component.basedir=${srcdir}/widget/${component}
-component.builddir=${component.basedir}/build
-component.srcdir=${component.basedir}/src
-
-component.jsfiles.base=${component.srcdir}/js
-component.jsfiles=FooBarWidget.js, FooBarUtils.js, renderer/FooBarWidgetRenderer.js
-
-# You can delete this line, if you have no assets to deploy (only used for pre 2.3.0 (non-skin) asset deployment)
-component.assetfiles=img/*, css/*
-
-# You can delete this line, if you have no skinning assets to deploy
-component.skins.base=${component.srcdir}/css
-
-# You can delete these 2 lines if you have no logger statements to strip
-# Backslashes need to be escaped (using double-blackslash) in order to parse correctly as properties. If included in the XML, backslashes do not need escaping
-
-# IMPORTANT!!:
-# - Log statements need to end in semi-colons, otherwise the default regex will strip out code until the next semi-colon is hit.
-# - 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.
-component.logger.regex=^.*?(?:logger|YAHOO.log).*?(?:;|\\).*;|(?:\\r?\\n.*?)*?\\).*;).*;?.*?\\r?\\n
-component.logger.regex.byline=false
-
-buildfiles.eol=lf
View
21 componentbuild/docs/build.common.xml
@@ -1,21 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project name="YuiBuild" default="local">
-
- <description>Component Build File</description>
-
- <dirname property="buildfile.dir" file="${ant.file}" />
- <property environment="env" />
- <property name="srcdir" value="${env.YUI_SRC_DIR}" />
- <property name="builddir" value="${env.YUI_BUILD_DIR}" />
-
- <property file="${buildfile.dir}/build.properties" />
-
- <import file="${builddir}/buildproperties.xml" description="Shared Build Properties - tools, build paths etc." />
- <import file="${builddir}/targetlib.xml" description="Component Build Targets" />
-
- <target name="examples" description="Component Specific Over-ride">
- <echo>DOES NOT DO ANYTHING CURRENTLY</echo>
- </target>
-
-</project>
-
View
61 componentbuild/docs/build.example.properties
@@ -1,61 +0,0 @@
-###############################################################################
-# Component specific build properties.
-#
-# The variable "srcdir" is available here and is the absolute path to the root
-# of the source tree. (e.g. /home/yuideveloper/cvsroot/yahoo/presentation/2.x )
-###############################################################################
-
-# Component name, lower-case. Used for build filenames (e.g. component.js, component-min.js).
-component=foobarwidget
-
-# Module name, mostly always the same as component.
-component.module=${component}
-
-# Main JS class representing the module. Version code will be added to this class.
-component.mainclass=YAHOO.widget.FooBarWidget
-
-# Uncomment the following line if your component is in beta. The built files will be named accordingly [ component-beta.js, component-beta-min.js etc.]
-# component.releasetype=beta
-
-# Absolute paths to the component base directory, src directory and local build directory.
-component.basedir=${srcdir}/widget/${component}
-component.builddir=${component.basedir}/build
-component.srcdir=${component.basedir}/src
-
-# Base dir for component.jsfiles. For most components this is component.srcdir or component.srcdir/js
-component.jsfiles.base=${component.srcdir}/js
-
-# Comma seperated ordered list of source files to be concatenated, relative to component.jsfiles.base.
-# Wildcards are not supported here.
-component.jsfiles=FooBarWidget.js, FooBarUtils.js, renderer/FooBarWidgetRenderer.js
-
-# Comma seperated list of asset files, relative to component.srcdir
-# Wildcards are allowed here.
-component.assetfiles=img/*, css/*
-
-# Base directory for skinning assets. Can be removed if no skinning assets exist for the component.
-# If it does exist, needs to follow the directory structure defined in build.example.xml
-component.skins.base=${component.srcdir}/css
-
-# Regex used to strip logger statements from component.jsfiles.
-# The regex below strips "logger" and "Yahoo.log" lines, accounting for multi-line statements.
-#
-# - component.logger.regex = the search criteria for the regexp
-# - component.logger.regex.byline = false/true, determines if the regex is executed against the whole file, or a line at a time resepectively
-# - component.logger.regex.flags = the set of standard Perl5 regex flags which apply [ imgs ]
-# - component.logger.regex.replace = the replacement string to use. An empty property is used for empty string
-#
-# The lines can be removed if you donot need to stip logger statements
-#
-# NOTE: Backslashes need to be escaped for correct property parsing
-#
-# IMPORTANT!!:
-# - Log statements need to end in semi-colons, otherwise the default regex will strip out code until the next semi-colon is hit.
-# - 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.
-component.logger.regex=^.*?(?:logger|YAHOO.log).*?(?:;|\\).*;|(?:\\r?\\n.*?)*?\\).*;).*;?.*?\\r?\\n
-component.logger.regex.byline=false
-component.logger.regex.flags=mg
-component.logger.regex.replace=
-
-# EOL conversion to be performed on build files.Possible values are lf (convert to unix) and asis (don't convert)
-buildfiles.eol=lf
View
135 componentbuild/docs/build.example.xml
@@ -1,135 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project name="YuiBuild" default="local">
-<!--
- COMPONENT BUILD FILE
-
- Expects the following properties to be set from the command line or in
- enviroment variables YUI_SRC_DIR, YUI_BUILD_DIR respectively:
-
- srcdir Build Box's Path to source root directory
- (e.g. /home/yuideveloper/sandbox/yahoo/presentation/2.x)
-
- builddir Build Box's Path to base directory for build support files/lib
- (jsmin, jslint, rhino, versioncode)
--->
-
- <description>Component Build File</description>
-
- <!-- !!IMPORTTANT : NEXT 5 LINES NEED TO BE IN YOUR BUILD FILE -->
- <dirname property="buildfile.dir" file="${ant.file}" />
- <property environment="env" />
- <property name="srcdir" value="${env.YUI_SRC_DIR}" />
- <property name="builddir" value="${env.YUI_BUILD_DIR}" />
- <property file="${buildfile.dir}/build.properties" />
-
-<!--
- 1. PROPERTY DEFINITIONS
-
- The following properties can be defined in a build.properties file placed in the same
- directory as build.xml (see build.example.properties), or within build.xml itself as shown below
-
- If defined in multiple places, they are set to the value which is declared first (viz. the properties file,
- if it's included in the location above)
-
- # COMPONENT PROPERTIES (Probably need to change across components)
-
- component Component name, lower-case. Used for build filenames(e.g. component.js, component-min.js)
- component.module Module name, mostly always the same as component
- component.mainclass Main JS class representing the module. Version code will be added to this class
- component.releasetype The release type for the component (alpha, beta, experimental etc.). Used to name built files. e.g. component-beta.js, component-beta-min.js
- Remove this entry for components with regular release types
-
- component.basedir Absolute path to the component base directory
- component.srcdir Absolute path to the component source directory
- component.builddir Absolute path to the component build directory
-
- component.jsfiles.base Base dir for component.jsfiles. For most components this is component.srcdir or component.srcdir/js
- component.jsfiles Comma seperated ordered list of source files to be concatenated, relative to component.jsfiles.base. No wildcards allowed
- component.assetfiles Comma seperated list of asset files, relative to component.srcdir (can be left undefined for components which don't have assets)
- component.skins.base Base directory for skin assets (component.assetfiles will eventually be deprecated).
- If this value is set, the build expects the following directory structure:
- <component.skins.base>
- - <component>-core.css
- - skins/sam/<component>-skin.css
- - skins/sam/[component specific skin images]
-
- component.logger.regex Regex used to strip logger statements
- component.logger.regex.byline If component.logger.regex.byline is false, regex will match against the
- entire file as opposed to line by line - required for multiline search.
- component.logger.regex.flags The set of standard Perl5 regex flags which apply.Defaults to mg if not provided[ imgs ]
- component.logger.regex.replace The replacement string to use. An empty property is used for empty string. Defaults to empty string
-
- # BUILDPATH PROPERTIES (defined in buildproperties.xml. Probably don't need to be over-ridden per component, except container_core)
-
- global.build.base Absolute path to global build directory ( e.g. /home/yuideveloper/cvsroot/yahoo/presentation/2.x/build )
- global.build.component Absolute path to global component build directory ( e.g. ${global.build.base}/calendar )
- global.build.component.assets Absolute path to global component assets directory
-
- global.src.base Absolute path to global src directory, from which docs are generated ( e.g. /home/yuideveloper/cvsroot/yahoo/presentation/2.x/src )
- global.src.component Absolute path to global component src directory ( e.g. ${global.src.base}/calendar )
-
- # BUILD BOX SPECIFIC PROPERTIES (defined in buildproperties.xml. Probably don't need to be over-ridden per component)
-
- jsmin.jar Path to jsmin.jar on the build box
- rhino.jar Path to Rhino's js.jar on the build box
- jslintsrc.js Path to fulljslint.js file on the build box
- jslintconsole.js Path to jslintconsole.js on the build box
- versioncode.txt Path to file containing version registration code on the build box
-
- # MISC PROPERTIES
-
- workingdir Location for temporary files created during build process
- buildfiles.eol EOL char to use for build files. Valid values are 'lf' or 'asis'
- never.clean Set to true, to stop build from ever deleting your local build directory
-
- 2. TARGET DEFINITIONS
-
- targetlib.xml defines the following main targets which can be invoked via the ant command line
- e.g. ant <target>. 'local' is the default target, which builds all 3 component files and runs jslint on them
-
- init Creates the component's local build dir
- clean Deletes the local build dir
-
- corebuild Creates component.js in the LBD
- debugbuild Creates component-debug.js in the LBD
-
- core Runs corebuild and creates component-min.js
- debug Runs debugbuild
-
- deploy Copies built code, source, assets, examples and readme to global build directory (e.g. 2.x/build, 2.x/src)
- deploysrc Copies built src files to global source directory (e.g. 2.x/src), used to generate documentation. Invoked by deploy
- all Complete build and deploy. Effectively, runs clean, init, core, debug, jslint, deploy
-
- local [default] Runs core, debug and jslint to create and test component.js, component-min.js, component-debug.js in the LBD
-
- customlocal Stub. The default implementation does nothing, but can be used to add additional build steps to local, after core and debug, but before jslint
- -->
-
- <!-- Component Properties. Any variables not defined in build.properties will get their values below -->
-
- <property name="component" value="foobarwidget" />
- <property name="component.module" value="${component}" />
- <property name="component.mainclass" value="YAHOO.widget.FooBarWidgetMgr" />
-
- <property name="component.basedir" location="${srcdir}/widget/${component}" />
- <property name="component.builddir" location="${component.basedir}/build" />
- <property name="component.srcdir" location="${component.basedir}/src" />
-
- <property name="component.jsfiles.base" value="${component.srcdir}/js" />
- <property name="component.jsfiles" value="FooBarWidget.js, FooBarUtils.js, renderer/FooBarWidgetRenderer.js" />
- <property name="component.assetfiles" value="img/*, css/*" />
-
- <property name="component.logger.regex" value="^.*?(?:logger|YAHOO.log).*?(?:;|\).*;|(?:\r?\n.*?)*?\).*;).*;?.*?\r?\n" />
- <property name="component.logger.regex.byline" value="false" />
- <property name="buildfiles.eol" value="lf" />
-
- <!-- !!IMPORTANT : The Next 2 Lines need to be in your build.xml -->
- <import file="${builddir}/buildproperties.xml" description="Shared Build Properties - tools, build paths etc." />
- <import file="${builddir}/targetlib.xml" description="Component Build Targets" />
-
- <target name="examples" description="Component Specific Over-ride">
- <echo>CURRENTLY NOT DOING ANYTHING</echo>
- </target>
-
-</project>
-
View
34 componentbuild/docs/docs.css
@@ -1,26 +1,48 @@
html, body {
- background-color:#F8F5EA
+ background-color:#F8F5EA;
}
-table {
+table.desc {
margin:1em;
}
-caption {
+table.desc caption {
+ color:#472210;
text-align:left;
font-weight:bold;
+ font-size:116%;
}
-caption p {
+table.desc caption p {
margin:2px;
}
-caption .filepath {
+table.desc caption .filepath {
margin-top:0;
font-family:monospace;
color:#006600;
}
-th, td.term {
+table.desc th {
+ background-color:#CDC8AA;
+}
+
+table.desc td.term {
+ font-family:monospace;
background-color:#DFDBC3;
}
+
+table.desc td.default {
+ white-space:nowrap;
+ font-size:93%;
+ font-family:monospace;
+}
+
+table.desc td.default p {
+ margin-top:2px;
+ margin-bottom:2px;
+}
+
+table.desc td.breakable {
+ white-space:normal;
+}
View
126 componentbuild/docs/properties.html
@@ -12,7 +12,7 @@
</head>
<body>
- <table>
+ <table class="desc">
<caption>
<p>BOOTSTRAP PROPERTIES</p>
</caption>
@@ -20,25 +20,28 @@
<tr>
<th>Property</th>
<th>Description</th>
+ <th>Default</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>
+ <td class="default">../../../builder/componentbuild</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>
+ <td class="default">../..</td>
</tr>
<tr>
- <td class="term">yui.version</td>
- <td>The version of YUI, 2 or 3.</td>
+ <td class="term">buildfile.dir</td>
+ <td>The directory containing the component build file.</td>
+ <td class="default">${ant.file}</td>
</tr>
</tbody>
</table>
-
- <table>
+ <table class="desc">
<caption>
<p>BUILD FILE PATHS</p>
</caption>
@@ -46,28 +49,28 @@
<tr>
<th>Property</th>
<th>Description</th>
+ <th>Default</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>
+ <td class="default">${srcdir}/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>
+ <td class="default">${global.build.base}/${component}</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>
+ <td class="default">${global.build.component}/${assets}</td>
</tr>
</tbody>
</table>
- <table>
+ <table class="desc">
<caption>
<p>COMPONENT CONFIGURATION</p>
</caption>
@@ -75,52 +78,64 @@
<tr>
<th>Property</th>
<th>Description</th>
+ <th>Default</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>
+ <td class="default"><p>No Default Value.</p><p>Required in build.properties.</p></td>
</tr>
<tr>
<td class="term">component.module</td>
<td>Module name, mostly always the same as component</td>
+ <td class="default">${component}</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>
+ <td class="default"><p>No Default Value.</p><p>Required in build.properties.</p></td>
</tr>
<tr>
<td class="term">component.rollup</td>
<td>Whether or not the component is a rollup. [YUI3 Only]</td>
+ <td class="default">false</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>
+ <td class="default breakable"><p>No Default Value.</p><p>Required in build.properties, if component.rollup is set to true.</p></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>
+ <td class="default">all</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>
+ <td class="default">No Default Value</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>
+ <td class="default">No Default Value</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>
+ <td class="default">No Default Value</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>
+ <td class="default">No Default Value</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>
+ <td class="default">No Default Value</td>
</tr>
<tr>
<td class="term">component.logger.regex</td>
@@ -132,26 +147,31 @@
<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>
+ <td class="default breakable">^.*?(?:logger|YAHOO.log).*?(?:;|\).*;|(?:\r?\n.*?)*?\).*;).*;?.*?\r?\n</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>
+ <td class="default">false</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>
+ <td>The set of standard Perl5 regex flags which apply.</td>
+ <td class="default">mg</td>
</tr>
<tr>
<td class="term">component.logger.regex.replace</td>
- <td>The replacement string to use. Defaults to empty string.</td>
+ <td>The replacement string to use.</td>
+ <td class="default">""</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>
+ <td class="default">false</td>
</tr>
</tbody>
</table>
- <table>
+ <table class="desc">
<caption>
<p>COMPONENT FILE PATHS</p>
</caption>
@@ -159,150 +179,178 @@
<tr>
<th>Property</th>
<th>Description</th>
+ <th>Default</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>
+ <td class="default">${buildfile.dir}</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>
+ <td class="default"><p>${component.basedir}/build_tmp (non-rollups)</p><p>${component.basedir}/build_rollup_tmp (rollups)</p></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>
+ <td>Comma seperated ordered list of JS source files to be concatenated, relative to ${component.basedir}/js</td>
+ <td class="default"><p>No Default Value.</p><p>Required in build.properties (for JS modules).</p></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>
+ <td>Comma seperated ordered list of CSS source files to be concatenated (for CSS modules), relative to ${component.basedir}/css</td>
+ <td class="default"><p>No Default Value.</p><p>Required in build.properties (for CSS modules).</p></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>
+ <td class="default">No Default Value</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>
+ <td class="default">No Default Value</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>
+ <p>If this value is set, the build expects the following directory structure, in the component's assets directory:</p>
<pre>
- &lt;component.assets.skins.base&gt;
+ &lt;component.assets.base&gt;
- &lt;component&gt;-core.css
- skins/sam/&lt;component&gt;-skin.css
- skins/sam/*.gif, *.png, *.jpg
</pre>
+
</td>
+ <td class="default">${component.assets.base}/skins</td>
</tr>
<tr>
<td class="term">component.assets.skins.files</td>
- <td>Set of skinning assets to deploy (defaults to **/*).</td>
+ <td>Set of skinning assets to deploy.</td>
+ <td class="default">**/*</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>
+ <td class="default">${component.basedir}/assets</td>
</tr>
<tr>
<td class="term">component.assets.files</td>
- <td>Set of asset files to deploy (defaults to **/*).</td>
+ <td>Set of asset files to deploy.</td>
+ <td class="default">**/*</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>
+ <td class="default">true</td>
</tr>
</tbody>
</table>
- <table>
+ <table class="desc">
<caption>
- <p>External Tools</p>
+ <p>EXTERNAL TOOLS</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
+ <th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">rhino.jar</td>
<td>Path to rhino.jar, used to run jslint.</td>
+ <td class="default">${builddir}/lib/rhino/js.jar</td>
</tr>
<tr>
<td class="term">jslintconsole.js</td>
<td>Path to the console script used to run jslint.</td>
+ <td class="default">${builddir}/lib/jslint/jslint-console.js</td>
</tr>
<tr>
<td class="term">jslintsrc.js</td>
<td>Path to the jslint implementation.</td>
+ <td class="default">${builddir}/lib/jslint/fulljslint.js</td>
</tr>
<tr>
<td class="term">yuicompressor.jar</td>
<td>Path to the YUI Compressor jar, used for minification.</td>
+ <td class="default breakable">${builddir}/lib/yuicompressor/yuicompressor-2.4.jar</td>
</tr>
<tr>
<td class="term">yuicompressor.css.args</td>
- <td>YUICompressor args for CSS compression.</td>
+ <td>YUI Compressor args for CSS compression.</td>
+ <td class="default">--type css --line-break 6000</td>
</tr>
<tr>
<td class="term">yuicompressor.js.args</td>
- <td>YUICompressor args for JS compression.</td>
+ <td>YUI Compressor args for JS compression.</td>
+ <td class="default breakable">--disable-optimizations --preserve-semi --line-break 6000</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>
+ <td>Whether or not YUI Compressor should run with verbose output enabled for JS compression. If enabled, YUI Compressor will show code related warnings/suggestions during compression. NOTE: Checked in build files should have been compressed with this flag set to true.</td>
+ <td class="default">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>
+ <td>Whether or not YUI Compressor should run with verbose output enabled for CSS compession.</td>
+ <td class="default">true</td>
</tr>
</tbody>
</table>
-
- <table>
+ <table class="desc">
<caption>
- <p>Miscenalleous Properties</p>
+ <p>MISCELLANEOUS</p>
</caption>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
+ <th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="term">buildfiles.eol</td>
- <td>The EOL character to use for built files. Defaults to "lf".</td>
+ <td>The EOL character to use for built files.</td>
+ <td class="default">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>
+ <td class="default">${component.builddir}/ant</td>
+ </tr>
+ <tr>
+ <td class="term">yui.version</td>
+ <td>The version of YUI component being built.</td>
+ <td class="default breakable">2 for YUI 2, 3 for YUI 3</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>
+ <td>The YUI instance variable name to use when generating the YUI.add(function(YUIInstanceVariable) {}) wrapper. [YUI3 Only]</td>
+ <td class="default">Y</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>
+ <td class="default">false</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>
+ <td class="default">false</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>
+ <td class="default">false</td>
</tr>
</tbody>
</table>
View
8 componentbuild/docs/targets.html
@@ -11,7 +11,7 @@
<link rel="stylesheet" type="text/css" href="docs.css">
</head>
<body>
- <table>
+ <table class="desc">
<caption>
<p>CORE TARGET DEFINITIONS</p><p class="filepath">(componentbuild/shared/targets.xml)</p>
</caption>
@@ -97,7 +97,7 @@
</tbody>
</table>
- <table>
+ <table class="desc">
<caption>
<p>YUI 2, YUI 3 MODULE BUILD</p>
<p class="filepath">(componentbuild/2.x/module.xml, componentbuild/3.x/module.xml)</p>
@@ -132,7 +132,7 @@
</tr>
</tbody>
</table>
- <table>
+ <table class="desc">
<caption>
<p>YUI 3 ROLLUP BUILD</p><p class="filepath">(componentbuild/3.x/rollup.xml)</p>
</caption>
@@ -158,7 +158,7 @@
</tr>
</tbody>
</table>
- <table>
+ <table class="desc">
<caption>
<p>CSS MODULE BUILD</p><p class="filepath">(componentbuild/shared/cssmodule.xml)</p>
</caption>
View
5 componentbuild/shared/properties.xml
@@ -51,11 +51,10 @@
<!-- Component Properties -->
<property name="component.module" value="${component}" />
<property name="component.basedir" location="${buildfile.dir}" />
- <property name="component.srcdir" value="${component.basedir}" />
- <property name="component.jsfiles.base" value="${component.srcdir}/js" />
+ <property name="component.jsfiles.base" value="${component.basedir}/js" />
<property name="component.assets.flatten" value="true" />
- <property name="component.assets.base" value="${component.srcdir}/assets" />
+ <property name="component.assets.base" value="${component.basedir}/assets" />
<property name="component.assets.files" value="**/*" />
<property name="component.assets.legacy.flatten" value="true" />
View
1  componentbuild/shared/targets.xml
@@ -15,7 +15,6 @@
<echo level="info"> component : ${component}</echo>
<echo level="info"> component.basefilename : ${component.basefilename}</echo>
<echo level="info"> component.basedir : ${component.basedir}</echo>
- <echo level="info"> component.srcdir : ${component.srcdir}</echo>
<echo level="info"> component.builddir : ${component.builddir}</echo>
<echo level="info">Global Build Properties</echo>
<echo level="info"> global.build.base : ${global.build.base}</echo>
Please sign in to comment.
Something went wrong with that request. Please try again.