You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pa...@apache.org on 2012/09/28 14:24:30 UTC
svn commit: r1391424 - in /directory/site/trunk/content/studio:
building.mdtext developers-guide.mdtext source-repository.mdtext
users-guide.data/ users-guide.data/html.png users-guide.data/pdf.png
users-guide.mdtext working.mdtext
Author: pamarcelot
Date: Fri Sep 28 12:24:30 2012
New Revision: 1391424
URL: http://svn.apache.org/viewvc?rev=1391424&view=rev
Log:
Added new converted pages to Studio's site.
Added:
directory/site/trunk/content/studio/building.mdtext
directory/site/trunk/content/studio/developers-guide.mdtext
directory/site/trunk/content/studio/source-repository.mdtext
directory/site/trunk/content/studio/users-guide.data/
directory/site/trunk/content/studio/users-guide.data/html.png (with props)
directory/site/trunk/content/studio/users-guide.data/pdf.png (with props)
directory/site/trunk/content/studio/users-guide.mdtext
directory/site/trunk/content/studio/working.mdtext
Added: directory/site/trunk/content/studio/building.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/building.mdtext?rev=1391424&view=auto
==============================================================================
--- directory/site/trunk/content/studio/building.mdtext (added)
+++ directory/site/trunk/content/studio/building.mdtext Fri Sep 28 12:24:30 2012
@@ -0,0 +1,156 @@
+Title: Building Apache Directory Studio
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Building Apache Directory Studio
+
+All projects use Maven as default build tool, we use [Maven 3](http://maven.apache.org) on JDK 1.6.
+
+
+## Checkout Sources from SVN Repository
+
+First you have to download the source code from the repository. Subversion is used for version control, so you can use the subversion client to download up to date source code. Here are the steps to have a running Apache Directory Studio from scratch:
+
+To check out the active development branch of Apache Directory Studio and all co-projects run the following command (use https instead of http for committers):
+
+ svn co http://svn.apache.org/repos/asf/directory/studio/trunk studio
+
+
+## Build Apache Directory Studio
+
+Now, change to studio:
+
+ cd studio
+
+Run the following command to build all the Apache Directory Studio Eclipse plugins and RCP application:
+
+ mvn clean install
+
+> **Memory Settings:**
+>
+> If the build hangs or you get an out of memory exception please increase the heap space:
+>
+> * For Linux:
+>
+> MAVEN_OPTS="-Xmx256m" mvn clean install
+>
+> * For Windows:
+>
+> SET MAVEN_OPTS="-Xmx256m"
+> mvn clean install
+>
+> **Distribution settings:**
+>
+> By default a distribution for your current working OS is built. You can add additional distributions by adding the corresponding profile of it:
+>
+> | OS | os.family | os.arch | Profile to use |
+> |---|:-:|:-:|---|
+> | Mac OS X 32 Bit (Cocoa) | mac | i386 | -Pmacosx-x86 |
+> | Mac OS X 64 Bit (Cocoa) | mac | x86_64 | -Pmacosx-x86_64 |
+> | Windows 32 Bit | windows | x86 | -Pwin32-x86 |
+> | Windows 64 Bit | windows | x86_64 or amd64 | -Pwin32-x86_64 |
+> | Linux 32 Bit (GTK 2) | unix | i386 | -Plinux-x86 |
+> | Linux 64 Bit (GTK 2) | unix | x86_64 or amd64 | -Plinux-x86_64 |
+> | All | - | - | -Pinstallers |
+> | Updatesite | - | - | -Pupdatesite |
+>
+> After the command ends running successfully you'll have all the projects compiled and the distribution(s) of Apache Directory Studio application generated in the directory **applications/application-<your platform>/target**.
+>
+> To run the application, double-click on it or launch it from command line.
+
+
+## Run Integration Tests
+
+Before running integration test you need a local installation of Eclipse 3.5. It is recommended to use a _dedicated_ and _small_ distribution, e.g. the "Eclipse IDE for Java Developers" package. Further you need to declare a Maven property **eclipse-home** that points to the Eclipse installation. Create or edit the **<home>/.m2/settings.xml** file and add the following content, please adapt the path to your local eclipse installation:
+
+ <settings>
+ <profiles>
+ <profile>
+ <id>eclipse-home</id>
+ <properties>
+ <eclipse-home>/opt/eclipse-3.5-for-integration-test/eclipse</eclipse-home>
+ </properties>
+ </profile>
+ </profiles>
+ <activeProfiles>
+ <activeProfile>eclipse-home</activeProfile>
+ </activeProfiles>
+ </settings>
+
+Run the following command to execute the integration tests:
+
+ mvn -Pintegration-core,integration-ui test
+
+
+### Background Info for Integration Tests
+
+The integration tests start up a full eclipse environment.
+
+* The 'core' test only start up a headless eclipse, without GUI.
+* The 'ui' test starts up the eclipse GUI and plays some scenarios. We use [SWTBot](http://www.eclipse.org/swtbot).
+
+The complete eclipse distribution, the studio plugins and the SWTBot plugins are copied into a test sandbox under test-integration-\[core|ui]/target/test-sandbox.
+
+The test results are written to test-integration-\[core|ui]/target/test-sandbox/workspace/results.xml.
+
+If errors occur please check test-integration-\[core|ui]/target/test-sandbox/workspace/.log and test-integration-\[core|ui]/target/test-sandbox/configuration/*.log.
+
+
+## Build User Documentation
+
+To build the user documentation in HTML and PDF, run the following command:
+
+ mvn install -Puserguides
+
+> **Note:**
+> Generating PDF requires much memory. If you get an out of memory exception please increase the heap memory:
+>
+> * For Linux:
+>
+> MAVEN_OPTS="-Xmx256M" mvn install -Puserguides
+>
+> * For Windows:
+>
+> SET MAVEN_OPTS="-Xmx256M"
+> mvn install -Puserguides
+>
+> After the command ends running successfully you'll have all the user documentation generated in the directory **target/userguides**.
+
+
+## Cleanup
+
+To clean the project's directory, run the following command:
+
+ mvn clean
+
+
+## Misc
+
+If you have problems building the projects please try to clean your local maven2 repository:
+
+* For Linux:
+
+ rm -rf ~/.m2/repository
+
+* For Windows:
+
+ Delete the folder C:\Documents and Settings\<your username>\.m2\repository
+
+
+**Note:** Each sub-project can also be built separately. To do so, enter the project directory and run the **mvn install** command. This will compile and generate the plugin in the **target** directory
+
+**Note 2:** Apache Directory Studio can be built on Linux, Mac OS X and Windows. It has been run successfully on Linux Ubuntu, Gentoo Linux (i386/amd64), Mac OS X Tiger, Leopard, Snow Leopard, Lion & Mountain Lion and Windows XP, Vista & 7.
\ No newline at end of file
Added: directory/site/trunk/content/studio/developers-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/developers-guide.mdtext?rev=1391424&view=auto
==============================================================================
--- directory/site/trunk/content/studio/developers-guide.mdtext (added)
+++ directory/site/trunk/content/studio/developers-guide.mdtext Fri Sep 28 12:24:30 2012
@@ -0,0 +1,42 @@
+Title: Developer's Guide
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Developer's Guide
+
+This is a simple guide to various Apache Directory Studio features to help developers get going.
+
+| Topic | Description |
+|---|---|
+| [Source repository](source-repository.html) | Source Repository location |
+| [Building](building.html) | How to build Apache Directory Studio from the repository |
+| [Issue Tracking](issue-tracking.html) | Issue Tracking |
+| [Working](working.html) | How to set up your workspace to work on Apache Directory Studio |
+| [Internationalization](internationalization.html) | How to enable multi-language support in the GUI (I18n) |
+| [Developer Resources] | Developer Resources |
+| [Apache Directory Studio Architecture] | Apache Directory Studio Architecture |
+| [Releasing a new version] | Releasing a new version |
+| [Code documentation | http://directory.apache.org/studio/gen-docs/latest] | Maven generated documentation and reporting |
+
+Apache Directory Studio developers will require the maven-studio-plugin, which is a maven plugin
+to simplify developers life.
+
+| Topic | Description |
+|---|---|
+| [Source Repository | Studio Plugin Source Repository] | Source Repository location |
+| [Code documentation | http://directory.apache.org/studio-plugin/gen-docs/latest] | Maven generated documentation and reporting |
+
Added: directory/site/trunk/content/studio/source-repository.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/source-repository.mdtext?rev=1391424&view=auto
==============================================================================
--- directory/site/trunk/content/studio/source-repository.mdtext (added)
+++ directory/site/trunk/content/studio/source-repository.mdtext Fri Sep 28 12:24:30 2012
@@ -0,0 +1,114 @@
+Title: Source Repository
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Source Repository
+
+## Source Repository Address
+
+To get the source, you will need to have subversion installed. Just type the following command to get the latest development version:
+
+ svn co http://svn.apache.org/repos/asf/directory/studio/trunk studio
+
+If you are an authorized developer, just check out the code using *https* instead of *http*.
+
+## Browse the Sources
+
+You can view and explore online SVN at this address:
+
+> <http://svn.apache.org/viewvc/directory/studio/trunk/>
+
+## Source Repository Organization
+
+The repository is organized as follows :
+
+ |-- pom.xml The main pom
+ |-- application The packaged applications/installers for all supported platforms
+ | |-- application-eclipse-plugins
+ | |-- application-features
+ | |-- application-linux-x86
+ | |-- application-linux-x86_64
+ | |-- application-macosx
+ | |-- application-macosx-dmg
+ | |-- application-plugins
+ | |-- application-release
+ | |-- application-updatesite
+ | |-- application-win32
+ | |-- application-win32-exe
+ | |-- docs
+ | |-- settings-hudson.xml
+ |-- features The features
+ | |-- apacheds.configuration.feature
+ | |-- apacheds.feature
+ | |-- ldapbrowser.feature
+ | |-- ldifeditor.feature
+ | |-- rcp.feature
+ | |-- schemaeditor.feature
+ |-- helps The help plugins in Docbook format
+ | |-- apacheds.configuration.help
+ | |-- apacheds.help
+ | |-- help-plugin-pom.xml
+ | |-- ldapbrowser.help
+ | |-- ldifeditor.help
+ | |-- rcp.help
+ | |-- schemaeditor.help
+ |-- libraries 3rd party libraries, packaged as Eclipse plugins
+ | |-- org.antlr.antlr
+ | |-- org.apache.commons.codec
+ | |-- org.apache.commons.collections
+ | |-- org.apache.commons.io
+ | |-- org.apache.commons.lang
+ | |-- org.apache.commons.logging
+ | |-- org.apache.directory.shared.dsmlparser
+ | |-- org.apache.directory.shared.i18n
+ | |-- org.apache.directory.shared.ldap
+ | |-- org.apache.httpcomponents.httpclient
+ | |-- org.apache.httpcomponents.httpcore
+ | |-- org.apache.logging.log4j
+ | |-- org.apache.mina.core
+ | |-- org.bouncycastle.bcprovjdk15
+ | |-- org.slf4j.api
+ | |-- org.slf4j.log4j12
+ | |-- org.xpp3.xpp3
+ |-- plugins The real plugins, here is the code
+ | |-- aciitemeditor
+ | |-- apacheds
+ | |-- apacheds-launcher
+ | |-- apacheds.configuration
+ | |-- common.core
+ | |-- common.ui
+ | |-- connection.core
+ | |-- connection.ui
+ | |-- ldapbrowser.common
+ | |-- ldapbrowser.core
+ | |-- ldapbrowser.ui
+ | |-- ldapservers
+ | |-- ldapservers.apacheds.v153
+ | |-- ldapservers.apacheds.v154
+ | |-- ldapservers.apacheds.v155
+ | |-- ldapservers.apacheds.v156
+ | |-- ldapservers.apacheds.v157
+ | |-- ldifeditor
+ | |-- ldifparser
+ | |-- rcp
+ | |-- schemaeditor
+ | |-- valueeditors
+ |-- repository A local maven repository, contains the eclipse dependencies
+ |-- tests Integration Tests
+ | |-- test.integration.core
+ | |-- test.integration.ui
+ |-- tools
\ No newline at end of file
Added: directory/site/trunk/content/studio/users-guide.data/html.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/users-guide.data/html.png?rev=1391424&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/studio/users-guide.data/html.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/studio/users-guide.data/pdf.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/users-guide.data/pdf.png?rev=1391424&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/studio/users-guide.data/pdf.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/studio/users-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/users-guide.mdtext?rev=1391424&view=auto
==============================================================================
--- directory/site/trunk/content/studio/users-guide.mdtext (added)
+++ directory/site/trunk/content/studio/users-guide.mdtext Fri Sep 28 12:24:30 2012
@@ -0,0 +1,62 @@
+Title: User's Guide
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# User's Guide
+
+Here are the User's Guides available for Apache Directory Studio:
+
+
+## LDAP Browser User's Guide
+
+ [Click here to consult the LDAP Browser User's Guide](http://directory.apache.org/studio/static/users_guide/ldap_browser/)
+
+ [The LDAP Browser User's Guide is also available as PDF ](http://directory.apache.org/studio/static/users_guide/Apache_Directory_Studio_LDAP_Browser_User_Guide.pdf)
+
+
+## LDIF Editor User's Guide
+
+ [Click here to consult the LDIF Editor User's Guide](http://directory.apache.org/studio/static/users_guide/ldif_editor/)
+
+ [The LDIF Editor User's Guide is also available as PDF ](http://directory.apache.org/studio/static/users_guide/Apache_Directory_Studio_LDIF_Editor_User_Guide.pdf)
+
+
+## Schema Editor User's Guide
+
+ [Click here to consult the Schema Editor User's Guide](http://directory.apache.org/studio/static/users_guide/schema_editor/)
+
+ [The Schema Editor User's Guide is also available as PDF ](http://directory.apache.org/studio/static/users_guide/Apache_Directory_Studio_Schema_Editor_User_Guide.pdf)
+
+
+## Apache DS User's Guide
+
+ [Click here to consult the Apache DS User's Guide](http://directory.apache.org/studio/static/users_guide/apacheds/)
+
+ [The Apache DS User's Guide is also available as PDF ](http://directory.apache.org/studio/static/users_guide/Apache_Directory_Studio_Apache_DS_User_Guide.pdf)
+
+## Apache DS Configuration User's Guide
+
+ [Click here to consult the Apache DS Configuration User's Guide](http://directory.apache.org/studio/static/users_guide/apacheds_configuration/)
+
+ [The Apache DS Configuration User's Guide is also available as PDF ](http://directory.apache.org/studio/static/users_guide/Apache_Directory_Studio_Apache_DS_Configuration_User_Guide.pdf)
+
+
+## Apache Directory Studio User's Guide
+
+ [Click here to consult the Apache Directory Studio User's Guide](http://directory.apache.org/studio/static/users_guide/apache_directory_studio/)
+
+ [The User's Guide is also available as PDF ](http://directory.apache.org/studio/static/users_guide/Apache_Directory_Studio_User_Guide.pdf)
Added: directory/site/trunk/content/studio/working.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/studio/working.mdtext?rev=1391424&view=auto
==============================================================================
--- directory/site/trunk/content/studio/working.mdtext (added)
+++ directory/site/trunk/content/studio/working.mdtext Fri Sep 28 12:24:30 2012
@@ -0,0 +1,60 @@
+Title: Working on Apache Directory Studio
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Working on Apache Directory Studio
+
+## Get and Prepare the Sources
+
+First, check out the active development branch of Apache Directory Studio and all co-projects run the following command:
+
+ svn co https://svn.apache.org/repos/asf/directory/studio/trunk studio
+
+Now, change to studio:
+
+ cd studio
+
+Run the following command to create eclipse descriptors (.project, .classpath files and .settings folder), and create the 'lib' folder as well as the META-INF/MANIFEST.MF files (needed to launch Apache Directory Studio inside Eclipse):
+
+ mvn install studio:eclipse
+
+**Note:** To make sure MANIFEST.MF files are correctly built the goal _install_ is _not_ optional.
+
+## Prepare Eclipse
+
+Declare a classpath variable named M2_REPO, pointing to ~/.m2/repository. You can declare new variables in Eclipse in _Window -> Preferences..._ and selecting _Java -> Build Path -> Classpath Variables_.
+
+Install SWTBot from the SWTBot update site <http://download.eclipse.org/technology/swtbot/galileo/dev-build/update-site>. Select both, SWTBot SWT Feature and SWTBot Eclipse Feature.
+
+To fulfill the coding standards it is recommended to import formatting profiles and code templates as described here: <http://cwiki.apache.org/DIRxDEV/coding-standards.html>
+
+
+## Import Projects into Eclipse
+
+Open the Import Wizard, select _General -> Existing Projects into Workspace_, on the next wizard page choos _Select root directory_ and browse for the checked-out _studio_ folder, select all projects and press _Finish_.
+
+Note that all the feature projects have errors because the feature.xml files contain maven variables that are replaced by the release build. So either ignore the errors in Eclipse or close the feature projects or don't import them.
+
+
+## Start Studio Plugins in a Runtime Environment
+
+To start the studio plugins in a runtime environment select _Run -> Open Run Dialog..._, select _Studio Runtime_ and press the _Run_ button.
+
+To start the core integration tests select _Run -> Open Run Dialog..._, select _Studio-Integration-Test-Core_ and press the _Run_ button.
+
+To start the UI integration tests select _Run -> Open Run Dialog..._, select _Studio-Integration-Test-UI_ and press the _Run_ button. Please make sure to use English locale for UI integration tests. Select _Window -> Preferences -> Plug-in Development -> Target Platform -> Tab Environment_ and set Locale to _en_.
+