Creating a new sample

Overview

Users can create new samples that appear in the Samples view, where they could be imported into projects.

Creating a new sample

The project samples appear in the Samples view:

You can create samples that reference a local .zip file or retrieve content from the web.

Sample categories

Here are the current possible values for the "category" element:

Project natures

Project natures can be added to samples by the specification of the "natures" element:

Local content

If your content is hosted locally, you can simply reference a .zip file containing the files in question.

1. Create a sample directory in the bundle and add a project_samples.rb file in the samples directory.

2. Add the following content to the project_samples.rb file:

   require 'ruble'   project_sample "Local Project Sample Example" do |s|   s.id = "sample.local"   s.category = "com.appcelerator.titanium.mobile.samples.category"   s.location = "samples/local_sample.zip"   s.description = "A local sample example"   s.natures = ["com.appcelerator.titanium.mobile.nature", "com.aptana.projects.webnature"]   s.icon = ["samples/local_sample.png"] end

3. Replace the sample name, id, category, location, description, nature, and icon values with values appropriate to your sample. The description, natures, and icon are optional.
4. Drop the file local_sample.zip in the samples folder.
5. Drop the icon in the samples folder if s.icon is defined.
6. Save and close project_samples.rb.

Open the Samples view (Window > Show View > Samples if it is not opened), and you should see your new sample appear under the appropriate category. Right-click on it and select *Import sample as project...* to import the sample into the workspace as a project.

Remote content

If you instead have a project sample hosted on a Git repo, you can reference that as well:

1. Create a sample directory in the bundle and add a project_samples.rb file in the samples directory.

2. Add the following content to the project_samples.rb file:

   require 'ruble'   project_sample "Remote Project Sample Example" do |s|   s.id = "sample.remote"   s.category = "com.appcelerator.titanium.mobile.samples.category"   s.location = "git://github.com/repo.git"   s.description = "Remote sample. Requires network access."   s.natures = ["com.appcelerator.titanium.mobile.nature", "com.aptana.projects.webnature"]   s.icon = ["http://sample_icon.png"] end

3. Replace the sample name, id, category, location, description, nature, and icon values with values appropriate to your sample.
4. Save and close project_samples.rb.

Open the Samples view (Window > Show View > Samples if it is not opened), and you should see your new sample appear under the appropriate category. Right-click on it and select *Import sample as project...* to import the sample into the workspace as a project.

The Ruble Specification gives a complete discussion on the new Ruble scripting system in Studio.