![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
[[en/Projects/wija]] #contents * Overview [#bb3d8452] wija and its plug-ins are written in Java language (J2SE; Java 2 Standard Edition)((Some part of plug-in modules may be written in a script language. In which case, either it should be the platform's standard language (such as AppleScript for Mac OS X) or users should be guided how to install the script language. Currently, helpgen, our help generator tool, uses a script written in Perl.)). You will need to install [[JDK (J2SE Development Kit):http://java.sun.com/]] to develop programs using J2SE (bundled with OS in case of Mac OS X). We assume that [[ant:http://ant.apache.org/]] tool is used for builds. The versions of all software (including wija and its plug-ins) and web sites developed and distributed by Media Art Online are managed using [[Perforce:http://www.perforce.com/]] software. It is a commercial software, but Perforce has agreed to grant free licenses for 40 users in Media Art Online only in the case where those licenses are used for development in open source projects. Also, since the client software for Perforce is free, anyone can obtain the latest source code using the software even if they do not intend to participate in development at Media Art Online. We have prepared the ''wija-devel-en'' mailing list (the English-only version of ''wija-devel'') to share those licenses and to discuss issues in the development of wija and its related software. For each member of wija-devel-en list, a writing-enabled Perforce user account is allocated. If you are interested in joining wija-devel-en, please let us know at the following &ref(http://www.media-art-online.org/png/mailto.png); * Nightly build [#o35d9a3f] The members of wija-devel-en can try out the latest software or documentation by receiving a review message by Perforce right after a modification is made to the development items in which they are interested. ** In case of software development [#b30ff3aa] However, what you can obtain from Perforce is source code, so that you will need to build the softare using the development tools in order to actually try them out. It could be too complex for people who do not normally develop software. Therefore, an internal release is made almost nightly, so that people who do not wish to use the development tools can still check changes when they are made. This internal release is made in the early morning (JST) of the next day following a new modification (the procedure will be automated in future, but for the time being, it is manually done, which may make the timing rather unpredictable). The following URL is reserved for the internal releases. - http://www2.media-art-online.org/nightly/ @ At the beginning., the internal releases themselves will be notified by review messages. An internal release is provided in the form of a compressed archive file whose name contains the latest Perforce change number. wija-change#.zip ** In case of documentation development [#g1089da5] Likewise, you will need to build help pages on your computer from their source code written in "OmniDocument" format. To do so, you will need to use one of our development tools (help page generator). However, Media Art Online staff (a software robot in future) will always build help pages on our second web server whenever a modification is made to the documentation. This will let you browse the updated pages on the following URL after sometime: - http://www2.media-art-online.org/wija/ If no one sees a problem in the updated documentation, the modification will be propagated to the published site at http://www.media-art-online.org/wija/ . * Development tools [#be2a1091] - JDK (http://java.sun.com/ ) -- Java 2 Standard Edition Development Kit -- Bundled with Mac OS X (please use Software Update) - Perforce (http://www.perforce.com/ ) -- A software configuration management tool -- This page describes how to use Perforce, using p4 (the command line client software) as an example -- Please refer to the Perforce documentation accessible from the above URL. - Ant (http://ant.apache.org/ ) -- A build tool - helpgen (developed at Media Art Online, included in our Perforce depot) -- A help generator * Perforce installation and configuration [#f9e87c83] ** Perforce overview [#w0382018] Perforce is a software to help people physically distributed in many distant locations, using different computers, to develop the same software and/or documentation using the Internet. Perforce lets you manage versions of each file of which a software or a documentation consist. :Depot|Perforce places a depot, or the version management database, on the Perforce server prepared for a site. This database contains all source code and their revision histories of the software or documentations developed on the site. In the depot, information of files are organized in the form of layered directories just like they are in your computer. :Client|A Perforce user defines a client, or a mapping, for each development category with which they are concerned. The mapping defines which part of the depot corresponds to which directory in the local disk of the user's computer. :Workspace|The directory in the local disk onto which a part of the depot is mapped is called a workspace. A Perforce user downloads the latest versions of the files from the depot, adds files to the workspace, modifies existing files, and submits the changes to the depot. :Review message|A Perforce user can have the Perforce server send them e-mail messages to notify any changes to the development items with which they are concerned. This notification message is called a review message. Why Perforce: There are a lot of versioning software available in the market other than Perforce. CVS (Concurrent Versions System) is perhaps the most well-known example of such software, being free, and is used broadly for development of free software. The reasons why Media Art Online uses Perforce include 1) it is faster, 2) it is well-designed, 3) it provides more minute control over accessing the files. ** Environment variables for Perforce [#g85668bd] The following environment variables may have to be set. How to do so depends on the platform you are using. |LEFT:|LEFT:|LEFT:|c |Name|Meaning|Setting|h |~P4CLIENT|Client name|Used to identify the workspace the user uses| |~P4EDITOR|Editor|The editor software the user usually uses| |~P4PASSWD|Password|The password notified to you| |~P4PORT|Server name:port|perforce.media-art-online.org:1666| |~P4USER|User name|The user name notified to you| The following is the way we use for naming the clients. computerName_scm <- client name to identify a software development space computerName_wcm <- client name to identify a document development space Because p4 software always lets you specify the client name by -c option, you do not need to set P4CLIENT, especially if you intend to use multiple clients all the time. ** Typically used Perforce commands [#xc4ce255] ** MAO WSCM Depot configuration [#u85d2290] |Path|Description|h |//depot/wcm/...|Media Art Online Web site (including wija help pages)| |//depot/scm/...|Media Art Online software (including wija)| |//depot/docs/...|Media Art Online publications (papers and presentation materials)| wija-devel(-en) mailing list members are configured to review //depot/wcm/... and //depot/scm/... by default (meaning that they will receive e-mail messages when changes are made; the configuration can be changed by the members themselves). Those wija-devel(-en) members who are also members of Murai Lab. are configured to review //depot/docs/... by default as well. ** Directory structure for software development [#ta58b73a] ** Directory structure for documentation development [#w520432a] ** Directory structure for publications [#z5d1ce83] ** Perforce tutorial [#na36536d] *** Setting user profiles [#re794426] *** Creating a client [#n370b9ca] *** Setting up/updating a workspace [#q8e90eac] *** Building software [#e876c543] *** Building documentation [#xbb3ce5e] *** Upon receiving a review message [#l2684ac8] *** Adding files [#xd8dd07f] *** Editing files [#z50b0b14] *** Submitting files to depot [#c29b3a43]
