This project is read-only.

Getting Started

CCI Metadata

This topic describes how to get started with CCI Metadata.

Tip: If you also plan to use the CCI Code and AST libraries, you can skip this topic. The CCI AST and Code Model API includes the CCI Metadata API, so there is no need to enlist in CCI Metadata separately.This topic describes how to get started with CCI Metadata.

Read the Background Documentation

For conceptual background that is essential to understanding how to use the CCI Metadata API effectively, see the Documentation tab.

Obtain the Libraries

There are two ways to obtain the CCI Metadata libraries: enlist or download.

Enlist in the CCI Metadata Project

The recommended approach is to enlist in the project, as follows:
  1. If you have not done so already, obtain a CodePlex user name and password. To do so, go the CodePlex home page and click the Register link at the top of the page.
  2. Install a source control client. This procedure assumes that you are using TortoiseSVN Subversion client, but you can also use one of the clients listed later in this section. The basic procedure is similar for all clients.
  3. On the Source Code tab, click the appropriate link under Source Control Setup to display a dialog box with enlistment information.
  4. Copy the information from the dialog box and use it to enlist in the project. For TortoiseSVN, copy the URL from dialog box (https://ccimetadata.svn.codeplex.com/svn) and use the URL and your CodePlex user name and password to enlist in the project. See the TortoiseSVN documentation for details on how to enlist in a project.
  5. Check out the CCI Metadata source tree, as described in the TortoiseSVN documentation.
Note: TortoiseSVN uses a checkout/commit model, so checking out the source tree simply copies the files to your hard drive. You can then use the source code as you choose. To modify the parent source tree, you must explicitly commit your changes.

The source tree’s root folder has several subfolders. The key folders are:
  • Documentation: contains an API reference help file.
  • Samples: contains the source code for the basic samples.
  • Sources: contains the source code for the libraries.
  • Test: contains the source code for the test applications.
Other Source Control Clients
You can also enlist by using one of the following Visual Studio Team Foundation Server clients. Click the appropriate link for download information. See the client’s documentation for details on how to enlist in a project.
Important: Anyone can use TortoiseSVN or CodePlex Client to download and update the CCI Metadata source tree. You must be a team member to use Visual Studio Team Explorer or Teamprise Explorer.

Download CCI Metadata.

To download a .zip file that contains the current recommended CCI Metadata version:
  1. Go to the Source Code tab
  2. Under Latest Version, click the Download link, and save the file to your hard drive.
  3. Extract the contents to an appropriate location on your hard drive.
This is a less than ideal approach, for the following reasons:
  • The .zip file includes a snapshot of the CCI Metadata source tree. However, you cannot build the libraries from this tree, because the project depends on the XUnit testing framework, which is not included. To build the libraries, you must enlist in the project.
  • Each time you update to a new version, you must download the entire tree. If you enlist in the project, you download only the changes, which is much more efficient.

Build the Libraries and Samples

The CCI Metadata source tree is a Visual Studio 2008 solution that includes projects for each library and for a set of basic samples. To build the solution:
  1. Go to the source tree’s root folder.
  2. Open the solution, Metadata.sln, in Visual Studio.
  3. On the Build menu, click Build Solution to build the libraries and samples.
To use the CCI Metadata libraries in a solution that belongs to another CodePlex project or another Subversion repository:
  1. Use the svn:external property to set up a link between the two repositories
  2. Add the relevant CCI projects to your solution.
See the CCI Code and AST API for an example of this procedure.

Build the API Reference

The source tree’s Documents subfolder includes an HTML Help File (CHM), CCIMetadata.chm, which contains a complete API. However, CCIMetadata.chm is not routinely built and might not be completely up to date. You can build a CHM which is synchronized with the current sources, as follows:
  1. Install SandCastle Help File Builder.
  2. In the Documents folder, double-click the documentation project folder, Metadata.shfbproj, which loads the project into SandCastle Help File Builder.
  3. In SandCastle Help File Builder, click the toolbar’s Compile button. This builds the CHM and places it in the Documents folder.

Contribute to CCI Metadata

To contribute to CCI Metadata, see How to Contribute.

Last edited Dec 18, 2009 at 9:18 PM by Guy_Smith, version 3

Comments

No comments yet.