Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

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
39 componentbuild/docs/build.common.properties
... ... @@ -1,39 +0,0 @@
1   -##########################################################################
2   -# Common Build Properties
3   -#
4   -# This file contains the most common set of properties which you probably need to configure to get a build up and going
5   -# Use it along with build.common.xml as a starting point to customize your build process.
6   -#
7   -# See build.example.properties and build.example.xml for the complete list of configurable variables
8   -#
9   -##########################################################################
10   -
11   -component=foobarwidget
12   -component.module=${component}
13   -component.mainclass=YAHOO.widget.FooBar
14   -# 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.]
15   -# component.releasetype=beta
16   -
17   -component.basedir=${srcdir}/widget/${component}
18   -component.builddir=${component.basedir}/build
19   -component.srcdir=${component.basedir}/src
20   -
21   -component.jsfiles.base=${component.srcdir}/js
22   -component.jsfiles=FooBarWidget.js, FooBarUtils.js, renderer/FooBarWidgetRenderer.js
23   -
24   -# You can delete this line, if you have no assets to deploy (only used for pre 2.3.0 (non-skin) asset deployment)
25   -component.assetfiles=img/*, css/*
26   -
27   -# You can delete this line, if you have no skinning assets to deploy
28   -component.skins.base=${component.srcdir}/css
29   -
30   -# You can delete these 2 lines if you have no logger statements to strip
31   -# 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
32   -
33   -# IMPORTANT!!:
34   -# - Log statements need to end in semi-colons, otherwise the default regex will strip out code until the next semi-colon is hit.
35   -# - 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.
36   -component.logger.regex=^.*?(?:logger|YAHOO.log).*?(?:;|\\).*;|(?:\\r?\\n.*?)*?\\).*;).*;?.*?\\r?\\n
37   -component.logger.regex.byline=false
38   -
39   -buildfiles.eol=lf
21 componentbuild/docs/build.common.xml
... ... @@ -1,21 +0,0 @@
1   -<?xml version="1.0" encoding="UTF-8"?>
2   -<project name="YuiBuild" default="local">
3   -
4   - <description>Component Build File</description>
5   -
6   - <dirname property="buildfile.dir" file="${ant.file}" />
7   - <property environment="env" />
8   - <property name="srcdir" value="${env.YUI_SRC_DIR}" />
9   - <property name="builddir" value="${env.YUI_BUILD_DIR}" />
10   -
11   - <property file="${buildfile.dir}/build.properties" />
12   -
13   - <import file="${builddir}/buildproperties.xml" description="Shared Build Properties - tools, build paths etc." />
14   - <import file="${builddir}/targetlib.xml" description="Component Build Targets" />
15   -
16   - <target name="examples" description="Component Specific Over-ride">
17   - <echo>DOES NOT DO ANYTHING CURRENTLY</echo>
18   - </target>
19   -
20   -</project>
21   -
61 componentbuild/docs/build.example.properties
... ... @@ -1,61 +0,0 @@
1   -###############################################################################
2   -# Component specific build properties.
3   -#
4   -# The variable "srcdir" is available here and is the absolute path to the root
5   -# of the source tree. (e.g. /home/yuideveloper/cvsroot/yahoo/presentation/2.x )
6   -###############################################################################
7   -
8   -# Component name, lower-case. Used for build filenames (e.g. component.js, component-min.js).
9   -component=foobarwidget
10   -
11   -# Module name, mostly always the same as component.
12   -component.module=${component}
13   -
14   -# Main JS class representing the module. Version code will be added to this class.
15   -component.mainclass=YAHOO.widget.FooBarWidget
16   -
17   -# 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.]
18   -# component.releasetype=beta
19   -
20   -# Absolute paths to the component base directory, src directory and local build directory.
21   -component.basedir=${srcdir}/widget/${component}
22   -component.builddir=${component.basedir}/build
23   -component.srcdir=${component.basedir}/src
24   -
25   -# Base dir for component.jsfiles. For most components this is component.srcdir or component.srcdir/js
26   -component.jsfiles.base=${component.srcdir}/js
27   -
28   -# Comma seperated ordered list of source files to be concatenated, relative to component.jsfiles.base.
29   -# Wildcards are not supported here.
30   -component.jsfiles=FooBarWidget.js, FooBarUtils.js, renderer/FooBarWidgetRenderer.js
31   -
32   -# Comma seperated list of asset files, relative to component.srcdir
33   -# Wildcards are allowed here.
34   -component.assetfiles=img/*, css/*
35   -
36   -# Base directory for skinning assets. Can be removed if no skinning assets exist for the component.
37   -# If it does exist, needs to follow the directory structure defined in build.example.xml
38   -component.skins.base=${component.srcdir}/css
39   -
40   -# Regex used to strip logger statements from component.jsfiles.
41   -# The regex below strips "logger" and "Yahoo.log" lines, accounting for multi-line statements.
42   -#
43   -# - component.logger.regex = the search criteria for the regexp
44   -# - component.logger.regex.byline = false/true, determines if the regex is executed against the whole file, or a line at a time resepectively
45   -# - component.logger.regex.flags = the set of standard Perl5 regex flags which apply [ imgs ]
46   -# - component.logger.regex.replace = the replacement string to use. An empty property is used for empty string
47   -#
48   -# The lines can be removed if you donot need to stip logger statements
49   -#
50   -# NOTE: Backslashes need to be escaped for correct property parsing
51   -#
52   -# IMPORTANT!!:
53   -# - Log statements need to end in semi-colons, otherwise the default regex will strip out code until the next semi-colon is hit.
54   -# - 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.
55   -component.logger.regex=^.*?(?:logger|YAHOO.log).*?(?:;|\\).*;|(?:\\r?\\n.*?)*?\\).*;).*;?.*?\\r?\\n
56   -component.logger.regex.byline=false
57   -component.logger.regex.flags=mg
58   -component.logger.regex.replace=
59   -
60   -# EOL conversion to be performed on build files.Possible values are lf (convert to unix) and asis (don't convert)
61   -buildfiles.eol=lf
135 componentbuild/docs/build.example.xml
... ... @@ -1,135 +0,0 @@
1   -<?xml version="1.0" encoding="UTF-8"?>
2   -<project name="YuiBuild" default="local">
3   -<!--
4   - COMPONENT BUILD FILE
5   -
6   - Expects the following properties to be set from the command line or in
7   - enviroment variables YUI_SRC_DIR, YUI_BUILD_DIR respectively:
8   -
9   - srcdir Build Box's Path to source root directory
10   - (e.g. /home/yuideveloper/sandbox/yahoo/presentation/2.x)
11   -
12   - builddir Build Box's Path to base directory for build support files/lib
13   - (jsmin, jslint, rhino, versioncode)
14   --->
15   -
16   - <description>Component Build File</description>
17   -
18   - <!-- !!IMPORTTANT : NEXT 5 LINES NEED TO BE IN YOUR BUILD FILE -->
19   - <dirname property="buildfile.dir" file="${ant.file}" />
20   - <property environment="env" />
21   - <property name="srcdir" value="${env.YUI_SRC_DIR}" />
22   - <property name="builddir" value="${env.YUI_BUILD_DIR}" />
23   - <property file="${buildfile.dir}/build.properties" />
24   -
25   -<!--
26   - 1. PROPERTY DEFINITIONS
27   -
28   - The following properties can be defined in a build.properties file placed in the same
29   - directory as build.xml (see build.example.properties), or within build.xml itself as shown below
30   -
31   - If defined in multiple places, they are set to the value which is declared first (viz. the properties file,
32   - if it's included in the location above)
33   -
34   - # COMPONENT PROPERTIES (Probably need to change across components)
35   -
36   - component Component name, lower-case. Used for build filenames(e.g. component.js, component-min.js)
37   - component.module Module name, mostly always the same as component
38   - component.mainclass Main JS class representing the module. Version code will be added to this class
39   - 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
40   - Remove this entry for components with regular release types
41   -
42   - component.basedir Absolute path to the component base directory
43   - component.srcdir Absolute path to the component source directory
44   - component.builddir Absolute path to the component build directory
45   -
46   - component.jsfiles.base Base dir for component.jsfiles. For most components this is component.srcdir or component.srcdir/js
47   - component.jsfiles Comma seperated ordered list of source files to be concatenated, relative to component.jsfiles.base. No wildcards allowed
48   - component.assetfiles Comma seperated list of asset files, relative to component.srcdir (can be left undefined for components which don't have assets)
49   - component.skins.base Base directory for skin assets (component.assetfiles will eventually be deprecated).
50   - If this value is set, the build expects the following directory structure:
51   - <component.skins.base>
52   - - <component>-core.css
53   - - skins/sam/<component>-skin.css
54   - - skins/sam/[component specific skin images]
55   -
56   - component.logger.regex Regex used to strip logger statements
57   - component.logger.regex.byline If component.logger.regex.byline is false, regex will match against the
58   - entire file as opposed to line by line - required for multiline search.
59   - component.logger.regex.flags The set of standard Perl5 regex flags which apply.Defaults to mg if not provided[ imgs ]
60   - component.logger.regex.replace The replacement string to use. An empty property is used for empty string. Defaults to empty string
61   -
62   - # BUILDPATH PROPERTIES (defined in buildproperties.xml. Probably don't need to be over-ridden per component, except container_core)
63   -
64   - global.build.base Absolute path to global build directory ( e.g. /home/yuideveloper/cvsroot/yahoo/presentation/2.x/build )
65   - global.build.component Absolute path to global component build directory ( e.g. ${global.build.base}/calendar )
66   - global.build.component.assets Absolute path to global component assets directory
67   -
68   - global.src.base Absolute path to global src directory, from which docs are generated ( e.g. /home/yuideveloper/cvsroot/yahoo/presentation/2.x/src )
69   - global.src.component Absolute path to global component src directory ( e.g. ${global.src.base}/calendar )
70   -
71   - # BUILD BOX SPECIFIC PROPERTIES (defined in buildproperties.xml. Probably don't need to be over-ridden per component)
72   -
73   - jsmin.jar Path to jsmin.jar on the build box
74   - rhino.jar Path to Rhino's js.jar on the build box
75   - jslintsrc.js Path to fulljslint.js file on the build box
76   - jslintconsole.js Path to jslintconsole.js on the build box
77   - versioncode.txt Path to file containing version registration code on the build box
78   -
79   - # MISC PROPERTIES
80   -
81   - workingdir Location for temporary files created during build process
82   - buildfiles.eol EOL char to use for build files. Valid values are 'lf' or 'asis'
83   - never.clean Set to true, to stop build from ever deleting your local build directory
84   -
85   - 2. TARGET DEFINITIONS
86   -
87   - targetlib.xml defines the following main targets which can be invoked via the ant command line
88   - e.g. ant <target>. 'local' is the default target, which builds all 3 component files and runs jslint on them
89   -
90   - init Creates the component's local build dir
91   - clean Deletes the local build dir
92   -
93   - corebuild Creates component.js in the LBD
94   - debugbuild Creates component-debug.js in the LBD
95   -
96   - core Runs corebuild and creates component-min.js
97   - debug Runs debugbuild
98   -
99   - deploy Copies built code, source, assets, examples and readme to global build directory (e.g. 2.x/build, 2.x/src)
100   - deploysrc Copies built src files to global source directory (e.g. 2.x/src), used to generate documentation. Invoked by deploy
101   - all Complete build and deploy. Effectively, runs clean, init, core, debug, jslint, deploy
102   -
103   - local [default] Runs core, debug and jslint to create and test component.js, component-min.js, component-debug.js in the LBD
104   -
105   - 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
106   - -->
107   -
108   - <!-- Component Properties. Any variables not defined in build.properties will get their values below -->
109   -
110   - <property name="component" value="foobarwidget" />
111   - <property name="component.module" value="${component}" />
112   - <property name="component.mainclass" value="YAHOO.widget.FooBarWidgetMgr" />
113   -
114   - <property name="component.basedir" location="${srcdir}/widget/${component}" />
115   - <property name="component.builddir" location="${component.basedir}/build" />
116   - <property name="component.srcdir" location="${component.basedir}/src" />
117   -
118   - <property name="component.jsfiles.base" value="${component.srcdir}/js" />
119   - <property name="component.jsfiles" value="FooBarWidget.js, FooBarUtils.js, renderer/FooBarWidgetRenderer.js" />
120   - <property name="component.assetfiles" value="img/*, css/*" />
121   -
122   - <property name="component.logger.regex" value="^.*?(?:logger|YAHOO.log).*?(?:;|\).*;|(?:\r?\n.*?)*?\).*;).*;?.*?\r?\n" />
123   - <property name="component.logger.regex.byline" value="false" />
124   - <property name="buildfiles.eol" value="lf" />
125   -
126   - <!-- !!IMPORTANT : The Next 2 Lines need to be in your build.xml -->
127   - <import file="${builddir}/buildproperties.xml" description="Shared Build Properties - tools, build paths etc." />
128   - <import file="${builddir}/targetlib.xml" description="Component Build Targets" />
129   -
130   - <target name="examples" description="Component Specific Over-ride">
131   - <echo>CURRENTLY NOT DOING ANYTHING</echo>
132   - </target>
133   -
134   -</project>
135   -
34 componentbuild/docs/docs.css
... ... @@ -1,26 +1,48 @@
1 1 html, body {
2   - background-color:#F8F5EA
  2 + background-color:#F8F5EA;
3 3 }
4 4
5   -table {
  5 +table.desc {
6 6 margin:1em;
7 7 }
8 8
9   -caption {
  9 +table.desc caption {
  10 + color:#472210;
10 11 text-align:left;
11 12 font-weight:bold;
  13 + font-size:116%;
12 14 }
13 15
14   -caption p {
  16 +table.desc caption p {
15 17 margin:2px;
16 18 }
17 19
18   -caption .filepath {
  20 +table.desc caption .filepath {
19 21 margin-top:0;
20 22 font-family:monospace;
21 23 color:#006600;
22 24 }
23 25
24   -th, td.term {
  26 +table.desc th {
  27 + background-color:#CDC8AA;
  28 +}
  29 +
  30 +table.desc td.term {
  31 + font-family:monospace;
25 32 background-color:#DFDBC3;
26 33 }
  34 +
  35 +table.desc td.default {
  36 + white-space:nowrap;
  37 + font-size:93%;
  38 + font-family:monospace;
  39 +}
  40 +
  41 +table.desc td.default p {
  42 + margin-top:2px;
  43 + margin-bottom:2px;
  44 +}
  45 +
  46 +table.desc td.breakable {
  47 + white-space:normal;
  48 +}
126 componentbuild/docs/properties.html
@@ -12,7 +12,7 @@
12 12 </head>
13 13
14 14 <body>
15   - <table>
  15 + <table class="desc">
16 16 <caption>
17 17 <p>BOOTSTRAP PROPERTIES</p>
18 18 </caption>
@@ -20,25 +20,28 @@
20 20 <tr>
21 21 <th>Property</th>
22 22 <th>Description</th>
  23 + <th>Default</th>
23 24 </tr>
24 25 </thead>
25 26 <tbody>
26 27 <tr>
27 28 <td class="term">builddir</td>
28 29 <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>
  30 + <td class="default">../../../builder/componentbuild</td>
29 31 </tr>
30 32 <tr>
31 33 <td class="term">srcdir</td>
32 34 <td>The path to top of the project source directory (e.g. yui2/, yui3/) from the component build file.</td>
  35 + <td class="default">../..</td>
33 36 </tr>
34 37 <tr>
35   - <td class="term">yui.version</td>
36   - <td>The version of YUI, 2 or 3.</td>
  38 + <td class="term">buildfile.dir</td>
  39 + <td>The directory containing the component build file.</td>
  40 + <td class="default">${ant.file}</td>
37 41 </tr>
38 42 </tbody>
39 43 </table>
40   -
41   - <table>
  44 + <table class="desc">
42 45 <caption>
43 46 <p>BUILD FILE PATHS</p>
44 47 </caption>
@@ -46,28 +49,28 @@
46 49 <tr>
47 50 <th>Property</th>
48 51 <th>Description</th>
  52 + <th>Default</th>
49 53 </tr>
50 54 </thead>
51 55 <tbody>
52 56 <tr>
53 57 <td class="term">global.build.base</td>
54 58 <td>The path to the top level build directory</td>
55   - </tr>
56   - <tr>
57   - <td class="term">global.build.component</td>
58   - <td>The path to the top level build directory for the component being built (e.g. yui2/build)</td>
  59 + <td class="default">${srcdir}/build</td>
59 60 </tr>
60 61 <tr>
61 62 <td class="term">global.build.component</td>
62 63 <td>The path to the top level build directory for the component being built (e.g. yui2/build/autocomplete)</td>
  64 + <td class="default">${global.build.base}/${component}</td>
63 65 </tr>
64 66 <tr>
65 67 <td class="term">global.build.component.assets</td>
66 68 <td>The path to the top level assets directory for the component being built (e.g. yui2/build/autocomplete/assets)</td>
  69 + <td class="default">${global.build.component}/${assets}</td>
67 70 </tr>
68 71 </tbody>
69 72 </table>
70   - <table>
  73 + <table class="desc">
71 74 <caption>
72 75 <p>COMPONENT CONFIGURATION</p>
73 76 </caption>
@@ -75,52 +78,64 @@
75 78 <tr>
76 79 <th>Property</th>
77 80 <th>Description</th>
  81 + <th>Default</th>
78 82 </tr>
79 83 </thead>
80 84 <tbody>
81 85 <tr>
82 86 <td class="term">component</td>
83 87 <td>Component name, lower-case. Used for build filenames(e.g. component.js, component-min.js)</td>
  88 + <td class="default"><p>No Default Value.</p><p>Required in build.properties.</p></td>
84 89 </tr>
85 90 <tr>
86 91 <td class="term">component.module</td>
87 92 <td>Module name, mostly always the same as component</td>
  93 + <td class="default">${component}</td>
  94 + </tr>
  95 + <tr>
  96 + <td class="term">component.mainclass</td>
  97 + <td>Main JS class representing the module. Version code will be added to this class. [YUI2 Only]</td>
  98 + <td class="default"><p>No Default Value.</p><p>Required in build.properties.</p></td>
88 99 </tr>
89 100 <tr>
90 101 <td class="term">component.rollup</td>
91 102 <td>Whether or not the component is a rollup. [YUI3 Only]</td>
  103 + <td class="default">false</td>
92 104 </tr>
93 105 <tr>
94 106 <td class="term">component.rollup.modules.buildfiles</td>
95 107 <td>The build files for the sub-modules making up the rollup. [YUI3 Only]</td>
  108 + <td class="default breakable"><p>No Default Value.</p><p>Required in build.properties, if component.rollup is set to true.</p></td>
96 109 </tr>
97 110 <tr>
98 111 <td class="term">component.rollup.target</td>
99 112 <td>The default target to run on sub-module builds, initiated by the rollup build. [YUI3 Only]</td>
  113 + <td class="default">all</td>
100 114 </tr>
101 115 <tr>
102 116 <td class="term">component.use</td>
103 117 <td>Comma separated list of modules which the built module should "use". Used in generating the boilerplate registration code [YUI3 Only].</td>
  118 + <td class="default">No Default Value</td>
104 119 </tr>
105 120 <tr>
106 121 <td class="term">component.supersedes</td>
107 122 <td>Comma separated list of modules which the built module "supercedes". Used in generating the boilerplate registration code [YUI3 Only].</td>
  123 + <td class="default">No Default Value</td>
108 124 </tr>
109 125 <tr>
110 126 <td class="term">component.requires</td>
111 127 <td>Comma separated list of modules which the built module "requires". Used in generating the boilerplate registration code [YUI3 Only].</td>
  128 + <td class="default">No Default Value</td>
112 129 </tr>
113 130 <tr>
114 131 <td class="term">component.optional</td>
115 132 <td>Comma separated list of "optional" modules for the built module. Used in generating the boilerplate registration code [YUI3 Only].</td>
  133 + <td class="default">No Default Value</td>
116 134 </tr>
117 135 <tr>
118 136 <td class="term">component.skinnable</td>
119 137 <td>Whether or not the component is "skinnable". Used in generating the boilerplate registration code [YUI3 Only].</td>
120   - </tr>
121   - <tr>
122   - <td class="term">component.mainclass</td>
123   - <td>Main JS class representing the module. Version code will be added to this class. [YUI2 Only]</td>
  138 + <td class="default">No Default Value</td>
124 139 </tr>
125 140 <tr>
126 141 <td class="term">component.logger.regex</td>
@@ -132,26 +147,31 @@
132 147 <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>
133 148 </ul>
134 149 </td>
  150 + <td class="default breakable">^.*?(?:logger|YAHOO.log).*?(?:;|\).*;|(?:\r?\n.*?)*?\).*;).*;?.*?\r?\n</td>
135 151 </tr>
136 152 <tr>
137 153 <td class="term">component.logger.regex.byline</td>
138 154 <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>
  155 + <td class="default">false</td>
139 156 </tr>
140 157 <tr>
141 158 <td class="term">component.logger.regex.flags</td>
142   - <td>The set of standard Perl5 regex flags which apply. Defaults to "mg" if not provided.</td>
  159 + <td>The set of standard Perl5 regex flags which apply.</td>
  160 + <td class="default">mg</td>
143 161 </tr>
144 162 <tr>
145 163 <td class="term">component.logger.regex.replace</td>
146   - <td>The replacement string to use. Defaults to empty string.</td>
  164 + <td>The replacement string to use.</td>
  165 + <td class="default">""</td>
147 166 </tr>
148 167 <tr>
149 168 <td class="term">component.logger.regex.skip</td>
150 169 <td>Can be set to true, to skip the logger regex replacement step.</td>
  170 + <td class="default">false</td>
151 171 </tr>
152 172 </tbody>
153 173 </table>
154   - <table>
  174 + <table class="desc">
155 175 <caption>
156 176 <p>COMPONENT FILE PATHS</p>
157 177 </caption>
@@ -159,150 +179,178 @@
159 179 <tr>
160 180 <th>Property</th>
161 181 <th>Description</th>
  182 + <th>Default</th>
162 183 </tr>
163 184 </thead>
164 185 <tbody>
165 186 <tr>
166 187 <td class="term">component.basedir</td>
167 188 <td>Absolute path to the component's base directory (e.g. yui2/src/autocomplete)</td>
168   - </tr>
169   - <tr>
170   - <td class="term">component.srcdir</td>
171   - <td>Absolute path to the component's base directory (e.g. yui2/src/autocomplete)</td>
  189 + <td class="default">${buildfile.dir}</td>
172 190 </tr>
173 191 <tr>
174 192 <td class="term">component.builddir</td>
175 193 <td>Absolute path to the component's local build directory (e.g. yui2/src/autocomplete/build_tmp)</td>
  194 + <td class="default"><p>${component.basedir}/build_tmp (non-rollups)</p><p>${component.basedir}/build_rollup_tmp (rollups)</p></td>
176 195 </tr>
177 196 <tr>
178 197 <td class="term">component.jsfiles</td>
179   - <td>Comma seperated ordered list of JS source files to be concatenated, relative to component.basedir/js</td>
  198 + <td>Comma seperated ordered list of JS source files to be concatenated, relative to ${component.basedir}/js</td>
  199 + <td class="default"><p>No Default Value.</p><p>Required in build.properties (for JS modules).</p></td>
180 200 </tr>
181 201 <tr>
182 202 <td class="term">component.cssfiles</td>
183   - <td>Comma seperated ordered list of CSS source files to be concatenated (for CSS modules), relative to component.basedir/css</td>
  203 + <td>Comma seperated ordered list of CSS source files to be concatenated (for CSS modules), relative to ${component.basedir}/css</td>
  204 + <td class="default"><p>No Default Value.</p><p>Required in build.properties (for CSS modules).</p></td>
184 205 </tr>
185 206 <tr>
186 207 <td class="term">component.prependfiles</td>
187 208 <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>
  209 + <td class="default">No Default Value</td>
188 210 </tr>
189 211 <tr>
190 212 <td class="term">component.appendfiles</td>
191 213 <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>
  214 + <td class="default">No Default Value</td>
192 215 </tr>
193 216 <tr>
194 217 <td class="term">component.assets.skins.base</td>
195 218 <td>
196 219 <p>Base directory for the component's skinning assets (e.g. yui2/src/autocomplete/assets/skins).</p>
197   -
198   - <p>If this value is set, the build expects the following directory structure, underneath the skins directory:</p>
  220 + <p>If this value is set, the build expects the following directory structure, in the component's assets directory:</p>
199 221
200 222 <pre>
201   - &lt;component.assets.skins.base&gt;
  223 + &lt;component.assets.base&gt;
202 224 - &lt;component&gt;-core.css
203 225 - skins/sam/&lt;component&gt;-skin.css
204 226 - skins/sam/*.gif, *.png, *.jpg
205 227 </pre>
  228 +
206 229 </td>
  230 + <td class="default">${component.assets.base}/skins</td>
207 231 </tr>
208 232 <tr>
209 233 <td class="term">component.assets.skins.files</td>
210   - <td>Set of skinning assets to deploy (defaults to **/*).</td>
  234 + <td>Set of skinning assets to deploy.</td>
  235 + <td class="default">**/*</td>
211 236 </tr>
212 237 <tr>
213 238 <td class="term">component.assets.base</td>
214 239 <td>Base directory for the component's non-skinning related assets. e.g. SWFs and non-skinned images.</td>
  240 + <td class="default">${component.basedir}/assets</td>
215 241 </tr>
216 242 <tr>
217 243 <td class="term">component.assets.files</td>
218   - <td>Set of asset files to deploy (defaults to **/*).</td>
  244 + <td>Set of asset files to deploy.</td>
  245 + <td class="default">**/*</td>
219 246 </tr>
220 247 <tr>
221 248 <td class="term">component.assets.flatten</td>
222 249 <td>Whether or not to flatten the asset directory structure when deploying to build.</td>
  250 + <td class="default">true</td>
223 251 </tr>
224 252 </tbody>
225 253 </table>
226   - <table>
  254 + <table class="desc">
227 255 <caption>
228   - <p>External Tools</p>
  256 + <p>EXTERNAL TOOLS</p>
229 257 </caption>
230 258 <thead>
231 259 <tr>
232 260 <th>Property</th>
233 261 <th>Description</th>
  262 + <th>Default</th>
234 263 </tr>
235 264 </thead>
236 265 <tbody>
237 266 <tr>
238 267 <td class="term">rhino.jar</td>
239 268 <td>Path to rhino.jar, used to run jslint.</td>
  269 + <td class="default">${builddir}/lib/rhino/js.jar</td>
240 270 </tr>
241 271 <tr>
242 272 <td class="term">jslintconsole.js</td>
243 273 <td>Path to the console script used to run jslint.</td>
  274 + <td class="default">${builddir}/lib/jslint/jslint-console.js</td>
244 275 </tr>
245 276 <tr>
246 277 <td class="term">jslintsrc.js</td>
247 278 <td>Path to the jslint implementation.</td>
  279 + <td class="default">${builddir}/lib/jslint/fulljslint.js</td>
248 280 </tr>
249 281 <tr>
250 282 <td class="term">yuicompressor.jar</td>
251 283 <td>Path to the YUI Compressor jar, used for minification.</td>
  284 + <td class="default breakable">${builddir}/lib/yuicompressor/yuicompressor-2.4.jar</td>
252 285 </tr>
253 286 <tr>
254 287 <td class="term">yuicompressor.css.args</td>
255   - <td>YUICompressor args for CSS compression.</td>
  288 + <td>YUI Compressor args for CSS compression.</td>
  289 + <td class="default">--type css --line-break 6000</td>
256 290 </tr>
257 291 <tr>
258 292 <td class="term">yuicompressor.js.args</td>
259   - <td>YUICompressor args for JS compression.</td>
  293 + <td>YUI Compressor args for JS compression.</td>
  294 + <td class="default breakable">--disable-optimizations --preserve-semi --line-break 6000</td>
260 295 </tr>
261 296 <tr>
262 297 <td class="term">yuicompressor.js.verbose</td>
263   - <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>
  298 + <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>
  299 + <td class="default">true</td>
264 300 </tr>
265 301 <tr>
266 302 <td class="term">yuicompressor.css.verbose</td>
267   - <td>Whether or not YUICompressor should run with verbose output enabled for CSS compession.</td>
  303 + <td>Whether or not YUI Compressor should run with verbose output enabled for CSS compession.</td>
  304 + <td class="default">true</td>
268 305 </tr>
269 306 </tbody>
270 307 </table>
271   -
272   - <table>
  308 + <table class="desc">
273 309 <caption>
274   - <p>Miscenalleous Properties</p>
  310 + <p>MISCELLANEOUS</p>
275 311 </caption>
276 312 <thead>
277 313 <tr>
278 314 <th>Property</th>
279 315 <th>Description</th>
  316 + <th>Default</th>
280 317 </tr>
281 318 </thead>
282 319 <tbody>
283 320 <tr>
284 321 <td class="term">buildfiles.eol</td>
285   - <td>The EOL character to use for built files. Defaults to "lf".</td>
  322 + <td>The EOL character to use for built files.</td>
  323 + <td class="default">lf</td>
286 324 </tr>
287 325 <tr>
288 326 <td class="term">workingdir</td>
289 327 <td>The temporary directory which ant should use during the build. This directory will be deleted at the end of the build.</td>
  328 + <td class="default">${component.builddir}/ant</td>
  329 + </tr>
  330 + <tr>
  331 + <td class="term">yui.version</td>
  332 + <td>The version of YUI component being built.</td>
  333 + <td class="default breakable">2 for YUI 2, 3 for YUI 3</td>
290 334 </tr>
291 335 <tr>
292 336 <td class="term">yui.variable</td>
293   - <td>The YUI instance variable name to use when generating the YUI.add(function(YUIInstanceVariable) {}) wrapper. Defaults to "Y". [YUI3 Only]</td>
  337 + <td>The YUI instance variable name to use when generating the YUI.add(function(YUIInstanceVariable) {}) wrapper. [YUI3 Only]</td>
  338 + <td class="default">Y</td>
294 339 </tr>
295 340 <tr>
296 341 <td class="term">lint.skip</td>
297 342 <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>
  343 + <td class="default">false</td>
298 344 </tr>
299 345 <tr>
300 346 <td class="term">register.skip</td>
301 347 <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>
  348 + <td class="default">false</td>
302 349 </tr>
303 350 <tr>
304 351 <td class="term">clean.skip</td>
305 352 <td>Set to true to skip the build step which deletes the local build directory (build_tmp) before each build.</td>
  353 + <td class="default">false</td>
306 354 </tr>
307 355 </tbody>
308 356 </table>
8 componentbuild/docs/targets.html
@@ -11,7 +11,7 @@
11 11 <link rel="stylesheet" type="text/css" href="docs.css">
12 12 </head>
13 13 <body>
14   - <table>
  14 + <table class="desc">
15 15 <caption>
16 16 <p>CORE TARGET DEFINITIONS</p><p class="filepath">(componentbuild/shared/targets.xml)</p>
17 17 </caption>
@@ -97,7 +97,7 @@
97 97 </tbody>
98 98 </table>
99 99
100   - <table>
  100 + <table class="desc">
101 101 <caption>
102 102 <p>YUI 2, YUI 3 MODULE BUILD</p>
103 103 <p class="filepath">(componentbuild/2.x/module.xml, componentbuild/3.x/module.xml)</p>
@@ -132,7 +132,7 @@
132 132 </tr>
133 133 </tbody>
134 134 </table>
135   - <table>
  135 + <table class="desc">
136 136 <caption>
137 137 <p>YUI 3 ROLLUP BUILD</p><p class="filepath">(componentbuild/3.x/rollup.xml)</p>
138 138 </caption>
@@ -158,7 +158,7 @@
158 158 </tr>
159 159 </tbody>
160 160 </table>
161   - <table>
  161 + <table class="desc">
162 162 <caption>
163 163 <p>CSS MODULE BUILD</p><p class="filepath">(componentbuild/shared/cssmodule.xml)</p>
164 164 </caption>
5 componentbuild/shared/properties.xml
@@ -51,11 +51,10 @@
51 51 <!-- Component Properties -->
52 52 <property name="component.module" value="${component}" />
53 53 <property name="component.basedir" location="${buildfile.dir}" />
54   - <property name="component.srcdir" value="${component.basedir}" />
55   - <property name="component.jsfiles.base" value="${component.srcdir}/js" />
  54 + <property name="component.jsfiles.base" value="${component.basedir}/js" />
56 55
57 56 <property name="component.assets.flatten" value="true" />
58   - <property name="component.assets.base" value="${component.srcdir}/assets" />
  57 + <property name="component.assets.base" value="${component.basedir}/assets" />
59 58 <property name="component.assets.files" value="**/*" />
60 59
61 60 <property name="component.assets.legacy.flatten" value="true" />
1  componentbuild/shared/targets.xml
@@ -15,7 +15,6 @@
15 15 <echo level="info"> component : ${component}</echo>
16 16 <echo level="info"> component.basefilename : ${component.basefilename}</echo>
17 17 <echo level="info"> component.basedir : ${component.basedir}</echo>
18   - <echo level="info"> component.srcdir : ${component.srcdir}</echo>
19 18 <echo level="info"> component.builddir : ${component.builddir}</echo>
20 19 <echo level="info">Global Build Properties</echo>
21 20 <echo level="info"> global.build.base : ${global.build.base}</echo>

0 comments on commit b43ac54

Please sign in to comment.
Something went wrong with that request. Please try again.