nicolabs/ciform
1
0
Fork 0
mirror of https://github.com/nicolabs/ciform.git synced 2025-09-07 01:27:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

+ project name in title

Browse source 
+ copyright notices that will be preserved in final artifacts
+ copyright for documentation
This commit is contained in:
cbonar 2012-02-10 12:46:44 +01:00
parent 24aaab641f
commit 785d9052d7
15 changed files with 60 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ciform/build.properties
View file

@ -31,6 +31,3 @@ tools.dir=${basedir}/../tools
# Global properties file
common.properties=${tools.dir}/build/common.properties
# Short license text to add to some sources and docs
project.license=Copyright (C) 2012 Nicolas BONARDELLE <http://nicobo.net/contact>

7
ciform/build.xml
View file

@ -16,7 +16,7 @@
<property name="src.php.dir" value="${src.dir}/php" />
<target name="phpdoc" description="Generates PHP API docs">
<target name="phpdoc" extensionOf="package" depends="validate" description="Generates PHP API docs">
<mkdir dir="${target.dir}/doc/api/php" />
<exec command="${phpdoc.exe}" failonerror="true">
<arg value="--directory" />
@ -72,15 +72,14 @@
<target name="install-all" depends="resolve-dependencies" description="Builds all dependent projects and installs their artifacts into the local Ivy repo.">
<!-- executes the build script on each dependent module -->
<subant buildpathref="build.lib.ants">
<target name="package" />
<target name="install" />
</subant>
</target>
<target name="deploy-all" depends="resolve-dependencies, clean-site, install-all" description="Deploys all dependent projects.">
<target name="site-all" depends="resolve-dependencies" description="Builds all sites.">
<!-- executes the build script on each dependent module -->
<subant buildpathref="build.lib.ants">
<target name="deploy" />
<target name="site" />
</subant>
</target>

2
ciform/ivy.xml
View file

@ -1,5 +1,5 @@
<ivy-module version="2.0">
<info organisation="nicobo" module="ciform" revision="1.0-SNAPSHOT" status="integration">
<info organisation="plugnauth" module="ciform" revision="1.0-SNAPSHOT" status="integration">
<license name="LGPL" url="http://plugnauth.sf.net/ciform/license"/>
<ivyauthor name="Nicolas BONARDELLE" url="http://nicobo.net/contact?subject=ciform+ivy"/>
<description homepage="http://plugnauth.sourceforge.net/ciform">

4
crypto/base64/src/main/js/base64.js
View file

@ -1,3 +1,7 @@
/*!
Version 1.0, Copyright 2005 Herbert Hanewinkel, www.haneWIN.de
About this package : http://ciform.google.com
*/
//
// NOTE : The original code is wrapped so that the defined functions don't collide with existing ones.
// See http://michaux.ca/articles/javascript-namespacing.

1
crypto/hex/ivy.xml
View file

@ -1,5 +1,6 @@
<ivy-module version="2.0">
<info organisation="nicommons.crypto" module="hex" revision="1.0-SNAPSHOT" status="integration">
<license name="Copyright Herbert Hanewinkel" url="www.haneWIN.de"/>
<ivyauthor name="Nicolas BONARDELLE" url="http://nicobo.net/contact?subject=crypto+hex+ivy"/>
<description homepage="http://ciform.googlecode.com">
This library provides conversion functions from/to hexadecimal format.

4
crypto/hex/src/main/js/hex.js
View file

@ -1,3 +1,7 @@
/*!
Copyright Herbert Hanewinkel, www.haneWIN.de
About this package : http://ciform.google.com
*/
//
// NOTE : The original code is wrapped so that the defined functions don't collide with existing ones.
// See http://michaux.ca/articles/javascript-namespacing.

4
crypto/rsa/src/main/js/rsa.js
View file

@ -1,3 +1,7 @@
/*!
Copyright 2004 by Herbert Hanewinkel, www.haneWIN.de
About this package : http://ciform.google.com
*/
//
// NOTE : The original code is wrapped so that the defined functions don't collide with existing ones.
// See http://michaux.ca/articles/javascript-namespacing.

4
crypto/sha1/src/main/js/sha1.js
View file

@ -1,3 +1,7 @@
/*!
Version 2.2 Copyright Paul Johnston 2000 - 2009.
About this package : http://ciform.google.com
*/
//
// NOTE : The original code is wrapped so that the defined functions don't collide with existing ones.
// See http://michaux.ca/articles/javascript-namespacing.

26
tools/build/ant-js.xml
View file

@ -41,34 +41,39 @@
<extension-point name="test" depends="compile" description="Tests the compiled source code using a suitable unit testing framework. These tests should not require the code be packaged or deployed." />
<extension-point name="package" depends="test" description="Takes the compiled code and package it in its distributable format, such as a JAR." />
<extension-point name="package" depends="-check-package, test" unless="package.exists" description="Takes the compiled code and package it in its distributable format, such as a JAR." />
<extension-point name="integration-test" depends="package" description="Processes and deploys the package if necessary into an environment where integration tests can be run." />
<extension-point name="verify" depends="integration-test" description="Runs any checks to verify the package is valid and meets quality criteria." />
<extension-point name="install" description="Installs the package into the local repository, for use as a dependency in other projects locally." />
<extension-point name="install" depends="verify" description="Installs the package into the local repository, for use as a dependency in other projects locally." />
<extension-point name="deploy" depends="verify" description="Done in an integration or release environment, copies the final package to the remote repository for sharing with other developers and projects." />
<extension-point name="clean" description="Restores the initial state of the project, deleting any generated file." />
<extension-point name="site" depends="verify" description="Generates site documentation for this project. This also includes snapshot releases in Ivy repository style." />
<extension-point name="site" depends="package" description="Generates site documentation for this project. This also includes snapshot releases in Ivy repository style." />
<extension-point name="clean" description="Restores the initial state of the project, deleting any generated file." />
<!--
Targets that implement "phases" (extension points)
-->
<target name="make-validate" extensionOf="validate" description="Validates the project is correct and all necessary information is available.">
<target name="init-build" extensionOf="validate" description="Builds initial directories and makes sure all dependencies are there.">
<!-- Retrieves dependencies with ivy : required to initialize the cache and to get informations about the module being built -->
<!-- We use the default pattern, but put the resolved artifacts in a directory of ours so we can delete it afterwards -->
<ivy:retrieve pattern="${build.dir}/ivy/[conf]/[artifact].[ext]" sync="true" />
<!-- Creates required directories -->
<mkdir dir="${target.dir}" />
<!-- TODO check tools dependencies -->
</target>
<target name="ivy-install" extensionOf="install" depends="validate" description="Builds and installs the artifacts into the local Ivy repository.">
<target name="-check-package" description="Checks that artifacts have been generated ; if not triggers the target 'integration-test'." >
<available property="package.exists" file="${target.lib.dir}/${ivy.module}.js" />
</target>
<target name="ivy-install" extensionOf="install" depends="verify" description="Builds and installs the artifacts into the local Ivy repository.">
<!-- 'local' resolver is a default one bundled with Ivy ; it resides in the user's home directory -->
<!-- 'artifactspattern' must match the name of the files this script builds -->
<!-- Note : We use all options to force overwriting of existing (and possibly deprecated, during development) files -->
@ -81,7 +86,7 @@
<delete dir="${target.dir}" deleteonexit="true" failonerror="false" />
</target>
<target name="doc" depends="validate" extensionOf="site" description="Generates API documentation for this project.">
<target name="doc" extensionOf="package" depends="validate" description="Generates API documentation for this project and other technical reports.">
<!-- Generates a report of dependencies -->
<ivy:report todir="${target.dir}/doc/ivy"/>
@ -92,13 +97,14 @@
<arg file="${src.dir}"/>
<arg prefix="--template=" file="${jsdoc.template.dir}" />
<arg prefix="--define=" value="projectName:${ant.project.name}" />
<arg prefix="--define=" value="license:${project.license}" />
<arg prefix="--define=" value="projectLicense:${project.license}" />
<arg value="--allfunctions" />
<arg value="--private" />
<arg prefix="--directory=" file="${target.dir}/doc/api/js"/>
<arg value="--recurse"/>
<arg value="--verbose" />
</java>
<!-- TODO check return code (it may fail) -->
<echo message="Done generating site." />
@ -169,7 +175,7 @@
</ivy:makepom>
</target>
<target name="hg-site" extensionOf="deploy" depends="site" description="Builds a local directory that will reflect the structure of the final site with Ivy and Maven repositories as well as online API docs" >
<target name="hg-site" extensionOf="site" depends="verify" description="Builds a local directory that will reflect the structure of the final site with Ivy and Maven repositories as well as online API docs" >
<!-- First, creates an Ivy repo -->
<ivy:settings id="ivy.repo.site" file="${ivy.settings.path}" />
<!-- Note : transitive=false so we need to 'deploy' each project -->
@ -237,7 +243,7 @@
TODO fix and integrate the following targets
-->
<target name="googlecode-upload" extensionOf="deploy" description="Uploads versionned artifacts to googlecode" >
<target name="googlecode-upload" extensionOf="deploy" depends="verify" description="Uploads versionned artifacts to googlecode" >
<!-- TODO -->
</target>

4
tools/build/ivysettings.xml
View file

@ -8,8 +8,8 @@
</filesystem>
<!-- Used to publish artifacts to a local repository exportable to the web -->
<filesystem name="site">
<ivy pattern="${pub.dir}/[organisation]/[module]/[revision]/ivy.xml"/>
<artifact pattern="${pub.dir}/[organisation]/[module]/[revision]/[artifact].[ext]"/>
<ivy pattern="${pub.dir}/[organisation]/[module]/ivy.xml"/>
<artifact pattern="${pub.dir}/[organisation]/[module]/[artifact].[ext]"/>
</filesystem>
</resolvers>
</ivysettings>

3
tools/build/jsdoc-template/allfiles.tmpl
View file

@ -4,7 +4,7 @@
<head>
<meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
{! Link.base = ""; /* all generated links will be relative to this */ !}
<title>JsDoc Reference - File Index</title>
<title>{+JSDOC.opt.D.projectName+} JsDoc Reference - File Index</title>
<meta name="generator" content="JsDoc Toolkit" />
<style type="text/css">
@ -49,6 +49,7 @@
</div>
<div class="fineprint" style="clear:both">
Copyright &copy; 2012 <a href="http://nicobo.net/contact">Nicolas BONARDELLE</a><br />
<if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
</div>

3
tools/build/jsdoc-template/class.tmpl
View file

@ -5,7 +5,7 @@
<meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
<meta name="generator" content="JsDoc Toolkit" />
{! Link.base = "../"; /* all generated links will be relative to this */ !}
<title>JsDoc Reference - {+data.alias+}</title>
<title>{+JSDOC.opt.D.projectName+} JsDoc Reference - {+data.alias+}</title>
<style type="text/css">
{+include("static/default.css")+}
@ -642,6 +642,7 @@
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Copyright &copy; 2012 <a href="http://nicobo.net/contact">Nicolas BONARDELLE</a><br />
<if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
</div>

3
tools/build/jsdoc-template/index.tmpl
View file

@ -4,7 +4,7 @@
<head>
<meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
<title>JsDoc Reference - Index</title>
<title>{+JSDOC.opt.D.projectName+} JsDoc Reference - Index</title>
<meta name="generator" content="JsDoc Toolkit" />
<style type="text/css">
@ -32,6 +32,7 @@
</div>
<div class="fineprint" style="clear:both">
Copyright &copy; 2012 <a href="http://nicobo.net/contact">Nicolas BONARDELLE</a><br />
<if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
</div>

14
tools/build/jsdoc-template/static/default.css
View file

@ -159,4 +159,18 @@ ul.inheritsList
{
text-align: right;
font-size: 10px;
}
#header {
background-image: url('fnd_header.png');
background-repeat: repeat-x;
margin-left: auto;
margin-right: auto;
text-align: center;
}
#header img {
text-align: center;
}

2
tools/build/jsdoc-template/static/header.html
View file

@ -1,3 +1,3 @@
<div id="header">
HELLO TOTO
<!--img src="logo_ciform.png" alt="Project's logo"-->
</div>