INRIA Gforge Implementation Material

From IHE Wiki
Revision as of 11:33, 11 August 2008 by Smoore (Talk | contribs) (Fill in details of folder layout)

Jump to: navigation, search

This page discusses the INRIA Gforge and its use for storing implementation material. Some of the material requires knowledge of the subversion software system and tools for using subversion. This is not a tutorial on subversion.

Introduction

Some IHE Technical Frameworks include technical files that are difficult to maintain in Word or other systems. The INRIA Gforge will be used to manage such documents and provide a simple mechanism for repairing those files while maintaining a change history.

The INRIA forge has explanatory material on their home page. If you have questions, you can contact Steve Moore for help.

Administrative Steps

This assumes you want to actively edit documents.

  1. Contact your Technical Committee chair. Secure permission to have write access to the documents. Ask the TC chair to send confirmation to Steve Moore or Bill Majurski who will be involved in account management.
  2. Use a web browser to access the INRIA forge. Select the link (upper right corner) that says "New Account" and request a new account.
    1. One of the questions is "Name of the Inria research team you are working with or in". Until I have a better answer, enter Eric Poiseau/IHE"
  3. Once you have received confirmation of your account, follow up with Steve or Bill who will add you to the IHE project. If the TC chair sent confirmation to one of us, then follow up with the same person. That will reduce the traffic and confusion between us.
  4. Once you have been added to the IHE project, you will see that on your home page when you login to the INRIA forge.

Subversion Tools

You will need a subversion client on your computer. If you just want to browse the files, a web browser is sufficient. If you want to retrieve, edit and upload files, you will need a client.

  1. Subversion tools are listed at http://subversion.tigris.org. We have used the eclipse plugin and tortoise.
  2. Unix/linux folks can always use the svn command line tool

Folder Structure

The project is divided by domain. Each top level folder represents one domain.

Each domain should then use the same folder structure. If you feel the need to extend, consult with Bill Majurski or Steve Moore for consistency. Text in italics provides instruction.

This is the expected folder layout

  • examples
    • PROFILE_ACRONYM Use the profile acronym to create a folder.
      • Each folder can have examples; no specific naming convention.
  • schema
    • IHE Place IHE schemas here.
      • Inside this folder, drop in your schema. Do not create another level. For a profile with one schema, name the file PROFILE.xsd (e.g., RFD.xsd). If you have multiple schemas, the schema name should begin with the profile acronym.
    • Other: Create a folder with proper attribution: HL7, DICOM, W3C, etc.
  • wsdl
    • Place all wsdl files here. Each wsdl file starts with the profile acronym (RFD). Do not create another level of folders.

Process for Managing Documents