This page contains information about how to contribute to the ULC Code Community.
About the Community
The UltraLightClient (ULC) code community provides information about open source ULC projects and contributions. These can be hosted anywhere on the web. The purpose is to collect this information so that you can find ULC projects and code snippets easily.
The Overview Snip
The goal of the
Overview snip is to display the core labels of this community. The order of the contributions depends on how many times a contribution has been accessed.
Filtering the Overview
Besides the regular full text search you have the possibility to apply a filter to the overview snip. It carries out a full text search and classifies the search result according to the core labels.
How to Publish your own Contribution
Here is the procedure how to publish your own ULC contribution:
Where to Host your Project
We recommend that you host your ULC project as a subproject of the
UltraLightClient project at
http://www.java.net. But, please feel free to host your project wherever you want.
- Java.net offers the following tools:
- Version control
- Mailing lists
- Issue tracking
- Discussion forums
How to Get Started
- If you decide to host your project at Java.net, we recommend reading the UltraLightClient project faq. It offers information about the registration process, how to use the different tools, and how to list your project as a subproject.
- There is an extension template that helps to set up the package structure and takes care of some build tasks. Please feel free to use it, if you find it helpful.
What You Should Offer
- Your project or contribution should include the following:
- Source code of your extension.
- Sample application using your extension.
- Running sample application; if you do not have any possibility to host the web application you can ask Canoo to host it for you.
- Server.jar and client.jar for developers who want to use your extension straightaway.
Publishing your Project at this Community
- To publish your project:
- Register if you are not already registered.
- Create a new snip
- At the top of your snip, add the {set-labels:Label1|LabelN} macro to set the appropriate labels. You have to set the ULC version label. The following labels are used on the overview snip. Please feel free to set your own labels.
- Extension
- Graphic
- Integration
- ULC5.2
- ULC6.0
- ULC6.1
- Utility
- If you already have an existing website, we offer a macro that displays the content of the index.html file. Simply use the following command: {import-content:https://xyz.dev.java.net/} where https://xyz.dev.java.net/is the URL at which your project or contribution is located. Please note: You have to enclose your html code between <!-- startImport --> and <!-- endImport --> to tell the macro what it should import. This macro will also work for content not hosted at Java.net. In future, you will only need to change the labels, e.g. the ULC version number.
