Permalink
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...
sdesai committed Feb 27, 2009
1 parent a1d063c commit b43ac545c191f6276e432fd5895ded9cb34cf21d
@@ -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
@@ -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>
-
@@ -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
@@ -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>
-
@@ -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;
+}
Oops, something went wrong.

0 comments on commit b43ac54

Please sign in to comment.