Skip to content
Browse files

General cleanup for release per OSWG recommendations

  • Loading branch information...
1 parent 3567ce6 commit 7bf94e81d769e558acf73813a5b005996eaad61f @webdevUser webdevUser committed Jun 29, 2009
View
5 CHANGES
@@ -0,0 +1,5 @@
+ChangeLog
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1.0.0b1
+ * Initial release
View
37 INSTALL
@@ -0,0 +1,37 @@
+Basic YUI PHP Loader Setup
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Verify that the environment you intend to install YUI PHP Loader on
+ has a working webserver, (e.g.) Apache, with support for PHP.
+
+2. Extract the YUI PHP Loader archive to a location within the
+ server's webroot (e.g.) htdocs/phploader.
+
+3. Refer to usage documents and examples:
+ http://developer.yahoo.com/yui/phploader
+
+
+Local Combo Handler Setup
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This feature will allow YUI PHP Loader to combine files without relying
+on a remote combo-service. The key use case here would be someone
+writing their own website/application in PHP.
+
+1. The main endpoint for combo requests in this case is combo.php. Place
+ this file in the same location as loader.php.
+
+ Note: If the phploader directory does not live in the webserver's root
+ folder then modify the $pathToYUILoader variable in combo.php accordingly
+
+2. Download and extract each version of YUI you intend to support into
+ the phploader directory. We recommend you organize them in a
+ subfolder named "releases".
+
+ A valid setup would look something like:
+ htdocs/phploader/releases/2.7.0/build
+ htdocs/phploader/releases/2.6.0/build
+ etc...
+
+3. Refer to usage documents and examples:
+ http://developer.yahoo.com/yui/phploader
View
65 README
@@ -0,0 +1,65 @@
+yuidoc README
+
+yuidoc is a set of tools to generate the API documentation for the JavaScript
+in the YUI library. The docs are derived completely from JavaDoc style
+comment blocks; no attempt is made to understand the javascript itself.
+
+yuidoc requires Python 2.3+ with the following extensions:
+ simplejson - for reading and writing json
+ cheetah - for generating the html docs
+ pygments - for colorizing the source
+
+The code for yuidoc is provided under a BSD license:
+ http://developer.yahoo.net/yui/license.html
+
+Project home page:
+ http://developer.yahoo.com/yui/yuidoc/
+
+Source code:
+ http://github.com/yui/yuidoc
+
+Issue tracker:
+ http://yuilibrary.com/projects/yuidoc
+
+Files:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+README
+ This file
+
+CHANGES
+ The change log
+
+INSTALL
+ Installation instructions
+
+TAGS
+ Supported tags
+
+license.txt
+ Open source license details.
+
+bin/yuidoc_parse.py
+ The comment block parser. Parses all javascript files in the the specified
+ directories and outputs a single file containing a json structure of the
+ parsed documentation.
+
+bin/yuidoc_highlight.py
+ Colorizes the script source
+
+bin/yuidoc_generate.py
+ Reads the json output from parser.py and generates HTML docs.
+
+bin/yuidoc.py
+ Wrapper for yuidoc_parse, yuidoc_highlight, and yuidoc_generate
+
+bin/example.sh
+ An example shell script to run both the parser and generator on a src tree
+
+bin/example.bat
+ An example batch for for DOS/Windows
+
+ext
+ External required packages, provided for convenience
+
+
View
31 license.txt
@@ -0,0 +1,31 @@
+Copyright (c) 2009, Yahoo! Inc. All rights reserved.
+Code licensed under the BSD License:
+
+Redistribution and use of this software in source and binary forms, with or
+without modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+* Neither the name of Yahoo! Inc. nor the names of its contributors may be used
+ to endorse or promote products derived from this software without specific
+ prior written permission of Yahoo! Inc.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+http://developer.yahoo.net/yui/license.html
View
25 phploader/README.manual_install
@@ -1,25 +0,0 @@
-
-These instructions are only needed if your machine does not have yinst (e.g., Macs)
-
-----------------------------------------------------------
-New install
-----------------------------------------------------------
-
-1) If not already created, create the /home/y directory structure:
-
- sudo mkdir -p /home/y/share/pear/Yahoo/YUI
-
-2) Copy/link loader.php, config.php, to that directory
-
- sudo cp ~/src/phploader/phploader/*.php /home/y/share/pear/Yahoo/YUI
- sudo cp ~/src/phploader/yui_module_info/*.php /home/y/share/pear/Yahoo/YUI
-
-3) Restart Apache
-
-----------------------------------------------------------
-Updating
-----------------------------------------------------------
-
-Update cvs and repeat steps 2 and 3. If you link to the cvsroot files rather than copy them,
-this becomes unnecessary.
-
View
62 phploader/README.yui_loader
@@ -1,62 +0,0 @@
-Yahoo UI Library Loader
-
-Provides a PHP include file that will allow you to specify package
-javascript and css module requirements. It maintains a dependency
-tree for these modules so when a module is requested, all of the
-other modules it depends on are included as well. By default, the
-YUI Library is configured, and other modules and their dependencies
-can be added via PHP.
-
-ChangeLog
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Version 2.0.4 (08/06/08, adamoore)
- - Fixed incorrect canEmbed() function referece that prevented raw output.
-
-Version 2.0.3 (05/06/08, adamoore)
- - APC ttl is now off by default
-
-Version 2.0.2 (02/26/08, adamoore)
- - CSS files that depend on skinnable components will load after the corresponding skin.
-
-Version 2.0.1 (12/04/07, adamoore)
- - YUI 2.4.0 release
- - Config has moved into yui_module_info
-
-Version 2.0.0 (11/30/07, adamoore)
-
- - The 2.0 release of loader offers improved performance, and it is a
- recommended upgrade for all current users. There will be one more
- release of the 1.x version of loader, which will be released when
- YUI 2.4.0 is released. Future YUI releases will require an upgrade
- to the 2.x version of the loader.
-
- Migrating from 1.x:
-
- Most common usages of the utility will work with no change. Your
- implementation will need to change if:
-
- - You pass in a list of required modules to the constructor:
-
- $loader = new YAHOO_util_Loader("dragdrop", "tabview");
-
- This is no longer supported. You must use the load method:
-
- $loader = new YAHOO_util_Loader();
- $loader->("dragdrop", "tabview");
-
- - You use the target property to switch between debug/raw/production
- sources:
-
- $loader->target = $yui_load_manager->DEBUG;
-
- This is configured in a different manner now:
-
- $loader->base = "/yui/" // Use this base path instead of http://yui.yahooapis.com/2.4.0/build/
- $loader->filter = YUI_DEBUG; // use -debug files instead of -min. YUI_RAW is a valid option too.
-
- - If you add your own dependencies, or do anything that used or modified
- $yui_config:
-
- The configuration mechanism has completely changed. See the documentation
- for information about custom configurations.
-
View
31 phploader/combo.php
@@ -3,22 +3,35 @@
* Copyright (c) 2009, Yahoo! Inc. All rights reserved.
* Code licensed under the BSD License:
* http://developer.yahoo.net/yui/license.html
- * version: 1.0 beta
+ * version: 1.0.0b1
*/
/*
-* This script servers as a local replacement for the remote YUI combo handler
-* Each version of YUI you intend to support must be setup in the phploader directory
-* A valid setup will look something like phploader/2.7.0/build, phploader/2.6.0/build, etc.
-*
-* Additional Setup Note:
-* If your phploader directory does not live webservers root folder then modify $pathToYUILoader accordingly
+ This feature will allow YUI PHP Loader to combine files without relying
+ on a remote combo-service. The key use case here would be someone
+ writing their own website/application in PHP.
+
+ 1. The main endpoint for combo requests in this case is combo.php. Place
+ this file in the same location as loader.php.
+
+ Note: If the phploader directory does not live in the webserver's root
+ folder then modify the $pathToYUILoader variable in combo.php accordingly
+
+ 2. Download and extract each version of YUI you intend to support into
+ the phploader directory. We recommend you organize them in a
+ subfolder named "releases".
+
+ A valid setup would look something like:
+ htdocs/phploader/releases/2.7.0/build
+ htdocs/phploader/releases/2.6.0/build
+ etc...
+
*/
-include("/home/y/share/pear/Yahoo/YUI/loader.php");
+include("./loader.php");
$loader = new YAHOO_util_Loader();
-$pathToYUILoader = server() . "/phploader/"; //Web accessible path to the YUI loader directory (Override as needed)
+$pathToYUILoader = server() . "/phploader/releases/"; //Web accessible path to the YUI loader directory (Override as needed)
$base = $pathToYUILoader . $loader->comboDefaultVersion; //Defaults to current version
//server(): Computes the base URL of the current page (protocol, server, path)
View
2 phploader/compat.php
@@ -3,7 +3,7 @@
* Copyright (c) 2009, Yahoo! Inc. All rights reserved.
* Code licensed under the BSD License:
* http://developer.yahoo.net/yui/license.html
- * version: 1.0 beta
+ * version: 1.0.0b1
*/
/**
View
2 phploader/loader.php
@@ -3,7 +3,7 @@
* Copyright (c) 2009, Yahoo! Inc. All rights reserved.
* Code licensed under the BSD License:
* http://developer.yahoo.net/yui/license.html
- * version: 1.0 beta
+ * version: 1.0.0b1
*/
/**
View
0 phploader/test/Yahoo/keep
No changes.
View
6 phploader/test/phpinfo.php
@@ -1,6 +0,0 @@
-<?php
-// echo $_ENV["YUI_EVENT"];
-// echo getenv("YUI_EVENT");
-phpinfo();
-
-?>
View
17 phploader/yui_loader.conf
@@ -1,17 +0,0 @@
-<IfModule mod_alias.c>
-
-<Directory "/home/y/share/pear/Yahoo/YUI/test">
- order allow,deny
- allow from all
-</Directory>
-
-Alias /yui/test-loader /home/y/share/pear/Yahoo/YUI/test/test-loader.php
-Alias /yui/loader-inc /home/y/share/pear/Yahoo/YUI/test/loader-inc.php
-
-<Location /yui/test-loader>
- order deny,allow
- deny from all
- allow from .yahoo.com .geocities.com .broadcast.com .launch.com .hotjobs.com
-</Location>
-
-</IfModule>
View
55 phploader/yui_loader.yicf
@@ -1,55 +0,0 @@
-#!/usr/bin/env python
-import os
-
-def main():
-
- name = ''
- ver = ''
- config = 'config.php'
-
- if 'PHP' in os.environ:
- ver = os.environ['PHP']
-
- if ver=='php4':
- name = 'yui_loader_php4'
- requires = 'yapache_libphp 4.3.0 5.9999.9999'
- # config = 'config.php4'
- else:
- name = 'yui_loader'
- requires = 'yphp'
- # config = 'config.php5'
-
- print """
-
-VERSION = `grep '^Version' ./README.yui_loader | head -1 | awk '{print $2;}'`
-
-PRODUCT_NAME = %s
-CUSTODIAN = yui-team@yahoo-inc.com http://twiki.corp.yahoo.com/view/Devel/YuiLoader
-
-SHORT_DESC = `head -1 README.yui_loader`
-LONG_DESC = `cat README.yui_loader`
-
-PACKAGE_OS_SPECIFIC = no
-
-YINST started-by yapache
-
-YINST requires pkg %s
-
-YINST requires pkg yui_module_info 2.0.0 2.9999.9999
-
-OWNER = root
-GROUP = wheel
-PERM = 0444
-
-f 0444 - - share/pear/Yahoo/YUI/loader.php loader.php
-f 0444 - - share/pear/Yahoo/YUI/test/test-loader.php test/test-loader.php
-f 0444 - - share/pear/Yahoo/YUI/test/loader-inc.php test/loader-inc.php
-
-f - - - conf/yapache/include/yui_loader.conf yui_loader.conf
-
-YINST post-install echo $YINST_INSTALLER successfully installed yui_loader
-
-""" %(name, requires)
-
-if __name__ == '__main__':
- main()
View
17 yui_module_info/yui_module_info.yicf
@@ -1,17 +0,0 @@
-VERSION = `grep '^Version' ./README.yui_module_info | head -1 | awk '{print $2;}'`
-
-PRODUCT_NAME = yui_module_info
-CUSTODIAN = yui-team@yahoo-inc.com http://twiki.corp.yahoo.com/view/Devel/PresentationPlatform
-
-SHORT_DESC = `head -1 README.yui_module_info`
-LONG_DESC = `cat README.yui_module_info`
-
-PACKAGE_OS_SPECIFIC = no
-
-YINST started-by yapache
-
-OWNER=root
-GROUP=wheel
-
-f 0444 - - share/pear/Yahoo/YUI/config.php config.php
-

0 comments on commit 7bf94e8

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