Project Homebase User GuideThis manual explains how to use the HL7 Project Homebase software.
The manual is divided in 4 parts:
This section explains how to register as a new user, how to register a new project, how to login and how to logout.
This section describes the functions of the HL7 Project Homebase that are relative to the user's section.
This document describes the user's homepage, how to modify user settings, how to handle user ratings, skill profiles and Diary and Notes.
This section explains the project specific functions of the HL7 Project Homebase software.
- Project Summary
This document describes the Project Summary page for your project.
- Project Administration
This document describes the Administration of the project. The Project Administrator function is accessible only to the Project Administrators.
- Discussion Forums
This document describes the use and administration of the Discussion Forums.
- Tracker
This document describes how to use the Tracker to track bugs, patches, support requests.
- Mailing Lists
This document describes the creation of maintenance of mailing lists for your project.
- Task Manager
This document describes how to use the Task Manager to track activities.
- Document Manager
This document describes the Document Manager.
- Surveys
This document describes how to set up Surveys for your project.
- News
This document describes how to add and release News for your project.
- CVS
This document describes how to manage CVS repositories for your project.
- File releases
This document describes how to publish new releases of your project.
- Trove Map
This document describes the Project Classification System.
- Snippet Library
This document describes how to use the code fragment Library.
- Project Help
This document describes how to use the Project help function of the HL7 Project Homebase.
Connect with your browser to the HL7 Project Homebase at: http://hl7projects.hl7.nscee.edu.
To register a new user, click on the New Account link on the top right side of the browser window.
To register as a user, you need to fill out the form with the following data:
- Login Name
-
You should select an unique user name to access to the system. The name should not contain uppercase letters and usually is a combination of your name and your surname; e.g. jdoe for John Doe. Also, the user name cannot match that of an existing system user account. (i.e., you can't be a user named "root".)
- Password
You should insert your password here. It must be at least 6 characters long. You shouldn't use too obvious names for the password. It should be easy to remember for you, but hard to guess for others. So don't use the name of your dog, of your cat, or the name of your birth city.
You should use instead, a combination of letters and numbers.
- Full/Real Name
Here you should insert your full name.
- Language Choice
Select here your preferred language. This choice does not influence only the language in which the HL7 Project Homebase will speak to you, but also some local specific data display, like dates, etc.
- Timezone
Select your timezone. Note that GMT is preselected. All dates will be showed relative to your timezone.
- Email Address
You should insert your email address here.
The email address should be correct, the HL7 Project Homebase will send you a confirmation email for your subscription. If the email address you're inserting here is wrong, you'll never receive the confirmation email and the account you're registering will never be activated.
When you receive the confirmation email, you must connect to the HL7 Project Homebase using the provided URL in the email. This is the only way to become a registered user.
- Receive Email about Site Updates
If you check this, you'll periodically receive information about the HL7 Project Homebase site. The traffic is very low, it is recommended that you activate this option.
- Receive additional community mailings
If you check this, you will receive information about the site's community.
To register a new project, connect to your HL7 Project Homebase , login and go to the My Page section. You have a Register Project link in the menu at the top of the page.
You need to insert the following information to register a project:
- Project Full Name
-
The Name of the Project: eg. Homebase Master project
- Project Purpose and Summarization
A brief summary of the Project
- License
-
If yours is a software project, you must select a license for your software.
- Project Public Description
Insert a description of the Project. This description will appear in the Project Summary page
- Project Unix Name
Insert here the unix name of your project. This name must respect the following rules:
it cannot match the unix name of any other project
its length must be between 3 and 15 characters
it must be in lowercase
-
only characters, numbers, and dashes are accepted
The unix name will be used for your website, the CVS Repository and the shell access for the HL7 Project Homebase.
Note
the unix name will never change. Once a project is set up with its unix name, the name cannot be changed.
Click on the I agree button to register the project. Your project is now registered on HL7 Project Homebase; but you cannot yet access it. It has to be approved from the site administrators.
When the project is approved, you'll receive an email from the HL7 Project Homebase confirming that the project is active.
You can login by clicking the Login link in the top-right border of the browser window.
The form requires that you insert your username and your password to access the site. If the data is correct, the user homepage will be displayed.
The User home page appears after the user has performed the login or when he clicks the My Page tab.
The User homepage contains a list of all open activities/tracker items:
- My Assigned Items
This list shows the Tracker items assigned to you. Only items in the open state will be listed here. Clicking on the number of the item, you'll go to the detail of the item. The items are ordered by priority.
- My Submitted Items
This list shows the Tracker items submitted by you. Only items in the open state will be listed here. Clicking on the number of the item, you'll go to the detail of the item. The items are ordered by priority.
- Monitored Forums
This list shows the Forums you are monitoring. See the section about Forums for more details on how monitoring works.
- Monitored FileModules
This list shows the FileModules you are monitoring. See the section Filemodules for more information on how monitoring of FileModules works.
- Quick Survey
This box shows the open surveys. The survey will be displayed directly in the Survey box.
- My Bookmarks
This list shows your bookmarked pages. When you click on a bookmark, you'll go direct to the page you bookmarked. When you click on Edit, you can edit or delete the bookmark.
- My Projects
This list shows you the active projects you are participating. When you click on a project, you will go to the project summary.
- Pending Projects
This section lists the new projects registered on HL7 Project Homebase. This section is available only to administrators of the HL7 Project Homebase site. It will be displayed only when pending projects needs to be approved.
- Pending News Bytes
This section lists the News that needs to be approved by the user.
When you click on Account Maintenance on your user homepage, you get a page where you can change some data you inserted. You can change every data you inserted when you registered as user except:
Registration date (Member since)
User Id
Login name
You can be rated by other users and you can rate other users. Every time you go to the detail of a user, you can rate the user.
Ratings can be given for:
Teamwork/Attitude
Coding
Design/Architecture
Follow-Trough/Reliability
Leadership/Management
In this section you can add your skills. You can set your skills profile to public, so everyone can see it, or to private, so that only you can view it.
The information that you can insert is:
Language
Level of experience (Beginner, Master, expert)
Duration of experience (6 months, 1 year, 5 years)
The project summary shows summarized information about the current project. The following information is displayed:
- Project description and statistics
Description of the project and some statistics about it
- Project administrators and members
List of the developers involved in the project
- Latest file releases
Latest file releases published via the FRS.
- Public areas
For each Tool of the HL7 Project Homebase, Summary Information is displayed; e.g. Public Forums (7 message in 2 forums), Bugs (4 open, 12 total).
- News
Latest news of the project.
The Project Administration section allows you to administer the project.
The Project Admin web page is where all the administration of the project is done from. To get there, log into HL7 Project Homebase, and select the project from your personal page. This will bring you to the page.
The Project Admin page is available by clicking on the Admin tab.
Clicking here will present you with links to Admin, User Permissions, Edit Public Info, Project History, VHOSTS, Post Jobs, Edit Jobs, Edit MultiMedia Data, Database Admin and Stats. The Project Admin page is only accessible to members of the project who have been granted administrator privileges. By default, the person who registers the project is given admin privileges. Other members can be granted admin rights by the project administrator(s).
The Admin page presents the user with Misc. Project Information, Trove Categorization, Tool Admin and Group Members.
- Misc Project Information
This shows the Short Description of the project and the location of the project homepage. There's also a link to Download Your Nightly CVS Tree Tarball, but this doesn't currently work.
- Trove Categorization
In order for people to be able to find the project, it must be classified in the Trove Map. This is basically a set of categories in which like projects are grouped.
Clicking on Edit Trove Categorization presets a page which allows you to select the category(s) to which the project belongs (select as many as needed).
Clicking Submit All Category Changes will set the categorizations, and you will be returned to the Project Admin page. You can change the trove categorizations during the lifetime of the project by following the above steps, as the project moves through its life.
- Tool Admin
This section shows the links to the tools describes the tools listed under the Tool Admin section on the Project Admin page.
- Group Members
This displays the names of the members in the project, and allows you to add members or delete them. To add members simply enter their Unix Name into the box provided and press Add User. To remove them, click on the rubbish bin to the left of their name. The Edit Member Permissions functionality is described in the section User Permissions.
This allows the project admin to set the permissions of each member of the project. The page is self explanatory.
This page enables the project admin to select the information that is visible to the public and to the members of the project. It is possible to select the utilities that are used by the project, so that any that are not desired are not presented on the web page. Specifically it is possible to disable/enable:
Mailing Lists
Surveys
Forums
Project/Task Manager
CVS
pserver (CVS server with password authentication)
Anonymous access to CVS
News
Document Manager
FTP
Tracker
File Release System (FRS)
Statistics
It is also possible to change the home page (eg, it is possible to set up a web page on another machine, which has other information). In this case, the summary page will remain on HL7 Project Homebase, pointing to the project, and the Home Page link will point to the pages specified in the Homepage Link field.
You can also change the descriptive group name and the short description. If desired you can add an email address to which all Bugs, Patches, Support Requests and Task Assignments will be sent. This could be a Mailing list or just an email address.
This page presents a history of the project, so you can see when major changes took place, eg members added/removed, Trove categories changed etc. There is nothing that you can do here.
This section allows you to handle the different virtual hosts needed for your project. A small interface is presented where you can add, modify or delete virtualhosts.
Note
These virtualhosts are not created immediately, they are created by a backend script (be sure that the backend script is configured in your crontab).
This allows you to post jobs for your project, so that when non-project members visit the site, they can offer to help with the development.
This section shows you information about your project:
- Usage statistics
A graph shows you for the latest 30 days the number of views/dowloads for each day.
- Lifetime statistics
This stat shows you, for the lifetime of the project, the number of visits/downloads, number of items inserted in the tracker, number of items in the PM/Task manager
Every project can have his own discussion forums. When a new project is created, 3 forums are automatically created:
- Open Discussion
A place where to discuss about everything.
- Help
A forum where to ask for help.
- Developers
A place where developers discuss about developments.
New forums can be created using the Admin section of the forum. When a new forum is created, you must insert a name of the forum, the description of the forum, select if the forum is public or private and if anonymous posts are allowed on the forum.
Public forums are visible only to project members. If Anonymous posts are enabled, everybody can post messages to the forum, even users that are not logged in.
You can also insert an email address where all posts will be sent.
When you click on the name of the forum, you go to the detail of the forum.
You can select the following types of visualization for the forum lists:
- Nested
Shows the messages ordered by thread. All data of the message, including the posted message itself will be visualized.
- Flat
Similar to Nested, the messages will be showed in chronological order.
- Threaded
Shows only title, author and date of each message. Shows the messages in threaded order. Clicking on the title of the message the entire message will be displayed.
- Ultimate
Shows only the “topic started” messages. Topic starters are the messages that starts a new thread.
You can select the number of messages for every page: 25, 50, 75 or 100.
The forums have 2 very powerful options:
- Save place
This function registers the number of messages already inserted in the forum and will highlight new messages the next time you return to the forum.
- Monitor forum
You can select to monitor the forum by clicking on the Monitor Forum button.
If this option is enabled, every post to the forum will be sent to you by email.This allows you to be informed about new messages without being logged on to gforge. The name of the monitored forum will appear in the users homepage in the section Monitored Forums.
Clicking on the link presents you with links to , or .
This allows you to add a new discussion forum. You can select if it is public or private (only members of the project can see it).
This allows you to delete a message (and any followups) from a forum. You must know the message id of the message you wish to remove. This can be obtained by viewing the message in the forums web page and noting the message id of the message.
The Tracker is a generic system where you can store items like bugs, feature requests, patch submissions, etc.
In previous versions of the software, these items were handled in separate software modules. Bugs, Enhancement Requests, Support Requests and Patches handle the same type of data, so it was logical to create an unique software module that can handle these types of data. New types of trackers can be created when needed, e.g. Test Results, meeting minutes, etc.
You can use this system to track virtually any kind of data, with each tracker having separate user, group, category, and permission lists. You can also easily move items between trackers when needed.
Trackers are referred to as “Artifact Types” and individual pieces of data are “Artifacts”. “Bugs” might be an Artifact Type, while a bug report would be an Artifact. You can create as many Artifact Types as you want, but remember you need to set up categories, groups, and permission for each type, which can get time-consuming.
When a project is created, HL7 Project Homebase creates automatically 4 trackers:
- Bugs
Used for Bug tracking
- Support Requests
Users can insert here support requests and receive support
- Patches
Developers can upload here patches to the software
- Feature Requests
Requests for enhancements of the software should be posted here
The following descriptions can be applied to any of the trackers. The functionalities between the different trackers are the same, we'll use the Bugs Tracker as example to describe the functionality of all trackers.
The Tracker provides the following functions:
Submitting a new item
Browsing of Items
Reporting
Administration
To submit a new bug, click on the link. A form will be displayed, where you can insert/select the following data:
- Category
The Category is generally used to describe the function/module in which the bug appears. E.g for HL7 Project Homebase, this might be the items “User Login”, “File releases”, “Forums”, “Tracker”, etc.
- Group
The Category can be used to describe the version of the software or the gravity of the bug. E.g “3.0pre7”, “3.0pre8” in case of version or “Fatal error”, “Non-fatal error” in case of gravity.
- Assigned To
You can assign the item to a user. Only users which are “Technicians” are listed here.
- Priority
You can select the Priority of the item. In the Browse list, and the homepage of the users, priorities are displayed in different colors, and can be ordered by priority.
- Summary
Give a short description of the bug, e.g. Logout function gives an SQL Error
- Detailed Description
Insert the most detailed description possible.
- File upload
You can also upload a file as an attachment to the bug. This can be used to attach a screenshot with the error and the log file of the application.
To upload the file, Check the checkbox, select a file using the Browse button and insert a file description.
Note
Attachments to tracker items can be no larger than 256KB.
The Browse page shows the list of bugs. You can select to filter the bugs by Assignee, Status, Category or Group.
You can sort the items by ID, Priority, Summary, Open Date, Close Date, Submittere, Assignee and the Ordering (Ascending, descending).
The different colors indicate the different priorities of the bug; a * near the open date indicates that the request is more than 30 days old. The overdue time (default 30 days) is configurable for each tracker.
When you click on the summary, you go to the detail/modify Bug page.
In the modify Bug page, you can modify the data you inserted, and also add the following information:
- Data Type
This combo box lists the trackers of the project. If you select a different tracker and submit the changes, the item will be reassigned to the selected tracker.
- Status
The status indicates the status of the item. When an item is inserted, it is created in the “Open” state. When you fix a bug, you should change the state to “Closed”. When a bug is duplicated or not valid, change it to “Deleted”.
- Resolution
This indicates the resolution of the item.
- Canned Responses
Canned responses are prefixed responses. You can create canned responses for your project in the admin section and select the responses in the combo box.
The Changelog on the bottom of the page shows in chronological order the changes applied to the item. Also all followups can be viewed.
If you select the button on the top left of the Bug detail page, bug monitoring will be enabled.
When you are monitoring a bug, every change to the bug will be sent to you by email.
To disable bug monitoring, simply reselect the button.
If you are an Administrator of the tracker, you can add or change bug groups, categories, canned responses:
- Add/Update Categories
You can add new categories or change the name of existing categories.
You can also select a user in the Auto-Assign To combo box; every bug with this category will be auto-assigned to the selected user. This feature can save you lots of time when administering the tracker.
- Add/Update Groups
You can add new groups or change the name of existing groups.It is not recommended that you change the group name because other things are dependent upon it. When you change the group name, all related items will be changed to the new name.
- Add Update Canned Responses
Canned responses are predefined responses. Creating useful generic messages can save you a lot of time when handling common requests.
- Add Update Users and Permissions
You can add new users to the tracker or delete users from the tracker.
- -
The user has no specific permission on the tracker; he cannot administer the tracker, no items can be assigned to the user.
- Technician
Items can be assigned to the user.
- Administrator and Technician
The user is both an Administrator and also a Technician.
- Administrator
User can administer the tracker (add user, set permissions, create/update groups, categories, canned responses).
- Update preferences
Here you can update the following information on the tracker:
- Name
The name of the Tracker. This is the name displayed in the tracker list, e.g. Bug Submissions.
- Description
The description of the Tracker. E.g. This is the tracker dedicated to the Bugs of the project
- Publicly Available
By default, this checkbox is not enabled.
- Allow non-logged-in postings
If this checkbox is enabled, also non logged-in users can post items to the tracker. If this checkbox is not enabled, only logged in users can post items.
By default, this checkbox is not enabled.
- Display the “Resolution” box
By default, this checkbox is not enabled.
- Send email on new submission to address
All new items will be sent to the address inserted in the text box.
- Send email on all changes
If this checkbox is enabled, all changes on the items will be sent out via email. It is useful to check this radiobutton only if in the Send email address is inserted an email address.
- Days still considered overdue
- Days till pending tracker items time out
- Free form text for the page
This allows you to put a specific introduction on the page.
- Free form text for the page
This allows you to put a specific introduction on the page.
If you are an Administrator of the tracker, you are also enabled for the Mass Update function.
This function is visible in the browse bug page and allows you to update the following information:
Category
Group
Priority
Resolution
Assignee
Status
Canned Response
When this function is enabled, a checkbox will appear at the left side of each bug id. You can check one or more of the ids, select one or more of the values in the Mass Update combo boxes and click Mass Update.
All selected bugs will be modified with these new value(s). This function is very useful if you need to change the same information for more bugs; e.g. assigning 5 bugs to one developer or closing 10 bugs.
The reporting functions allows to check the life-span of the Bug. The lifespan is the duration of the bug; it starts when the bug is inserted (opened) in the tracker and ends when the bug is closed.
- Aging Report
The Aging report shows the turnaround time for closed bugs, the number of bugs inserted and the number of bugs still open.
- Bugs by Technician
The Bugs by Technician report shows for every member of the project: the number of bugs assigned to the user, the number of closed bugs and the number of bugs still open.
- Bugs by Category
The Bugs by Category report shows for every Category: the number of bugs inserted, the number of closed and the number of open bugs
- Bugs by Group
The Bugs by Group report shows for every Group: the number of bugs inserted, the number of closed and the number of open bugs.
- Bugs by Resolution
The Bugs by Resolution report shows for every type of Resolution (Fixed, invalid, later, etc): the number of bugs inserted, the number of closed and the number of open bugs.
This is where you will set up and administer the mailing lists associated with the project.
This page shows the list of available mailing lists.
Clicking on List Name Archives will allow you to browse the archives of the selected mailing list.
You can subscribe, unsubscribe or edit your preferences for a specific mailing list by clicking the appropriate link.
This brings you to the Mail Admin page, where the following options are available to you.
- Add Mailing List
Clicking here will allow you to create a new mailing list. You can specify if it is to be made public (people who are not members of the project can see and/or join it) or not. You can also add a description of the list. You will receive an email with the administration password of the list.
- Administrate/Update Lists
This allows you to change the description of the list, the state of the list, and by clicking on you can add members to the mailing list, set the properties of the list, posting policies and so forth.
The Task Manager is similar to the tracker, with the following differences:
you can insert the start date of the item
you can insert the end date of the item
you can insert the number of hours for the item
you can have multiple assignees for the item
you can handle dependencies between tasks
Tasks are organized in subprojects. Before inserting a new task, you must first create a subproject. You can use the link to create new subprojects.
Tasks allows you to create and manage tasks, or blocks of work, similar to the way projects are broken down in eg MS Project.
This allows you to add tasks to the sub projects - e.g. Write Design Doc, Review Doc, Update Doc, Write Code, Review Code, Update Code, Test, Log Test Results, etc. They can be assigned to members of the team, and start and end dates set up for them, dependencies on other tasks set, percentage completion etc.
You need to select first a subproject from the subproject list and then select the link.
A form appears, where you are requested to insert the following data:
- Percent Complete
You can select here the Percentage of the completion of the work.
- Priority
You can select here the priority of the task.
- Task Summary
You should insert a brief description of the task.
- Task Details
You should insert here the most detailed description possible of the task.
- Start Date
You can insert here the start date.
- End Date
You can insert here the end date of the task.
- Assigned To
You can select one or more assignees of the task. Only users which are defined as “Technicians” are listed here.
- Dependent on task
You can select here one ore more task upon which this task depends.
- Hours
It is the estimated duration of this task in hours.
Only Administrators can add new items on the Task Manager; only Administrators can make changes to the task; only administrators can close the task.
The Admin section allows you to:
- Add a project
You can select if the subproject is public (visibile to everyone) or not (visibile only to project memebers).
This allows you to add a subproject to a project, such as modules, documentation, etc.
Required arguments are Project Name and description.
- Update information
Here you can select if the project is public, private or deleted (visible to nobody) and update the name and description of the subproject.
The Document Manager provided with HL7 Project Homebase gives you a simple way to publish documents on the site.
Here you can submit new documents for approving/publishing on the site. The form requires you to insert the following information:
- Document Title
The document title refers to the relatively brief title of the document
- Description
A brief description to be placed just under the title.
- Upload File
Here you should select the file to be uploaded. You can upload text files (.html, .txt) or binary files (.zip, .doc, .pdf).
- Language
You should select here the language of the document.
- Group that document belongs in
You should select here the group of the document. This feature is used to categorize documents.
Fill in all the fields, select the group from the drop down list and click . The document will then be placed in the section of the page, to be approved or rejected.
The View Documentation page shows you a list of documents published and approved for viewing; grouped by Document groups. You can click on a document to view the entire content.
Clicking on this will present you with a page showing pending and active documents. In order to allow users to submit a document, you must first set up the document groups for the project.
The Admin section allows you to:
- Approve/publish pending submissions
The Pending Submissions list shows the list of submissions that are waiting for your approval. Clicking on the document name, the Edit Document form will be displayed.
- Edit Documents
The Edit Document links shows all states of the documents, and the documents in the state:
- Active Documents
Active Documents are displayed in the View Documentation list.
- Pending Documents
Pending Documents are waiting for your approval.
- Hidden Documents
Hidden documents are not displayed.
- Deleted Documents
Deleted Documents are old, outdated documents.
- Private Documents
Private documents are displayed only for members of the project.
- Edit Document Groups
Clicking on this will present you with a box and a button to add document groups, and it also shows the document groups associated with this project. Submit as many document categories as you wish - eg Howto, Release notes, FAQ, etc. These groups will be the categories the documents will fall into when users submit documents.
When you select a document from one of the lists, a form will be displayed. In this form you can change the Document Title, the Short Description, the Language, the Document Group and the State.
If the Document is a text file with .txt, .html or .htm extension, a textbox appears where you can edit the content of the document.
If the Document is a binary document, you can upload a new version of the document.
Surveys allow you to ask questions to your developer/users and view the results. Surveys are often very helpful if you need some feedback from the users, examples of surveys might be:
User feedback: ask users if they like your project
Developer feedback: ask developers on new features to be implemented
Of course, surveys are not limited to this list. Basically, you can ask everything you want with surveys.
Before you can add/modify existing surveys, you need to administer the questions for your surveys. Questions are global for all surveys.
Gforge surveys handle the following question types:
Radio Buttons 1-5: This type of question shows 5 radio buttons where the user can select between 1 (low) and 5 (high).
This is useful for indicating priorities or quality feedback (e.g.: the question might be: did you like the new xxx feature. The user can select (1 (not very much), 2,3,4, 5(really)
Radio Buttons Yes/No. This type of question allows only two choices: Yes or No.
Comment Only
Text field: This type of question allows the user to insert some text in a text field.
Text area: This type of question allows the user to insert some text in a textarea
When inserting new questions or modifying existing questions, take note of the ID of the question. You'll need them when creating/modifying surveys.
You can create a new survey by clicking on the link and then .
You'll be asked to insert the following data:
- Survey name
The name of the survey
- Survey name
The name of the survey
- Question list
Here you should insert the IDs of the questions in the order they should appear. If you wish to see question 4 first, then question 6, then question 1, you should insert here 4,6,1.
Warning
Don't insert spaces or any other character between the numbers.
- Active
This flag indicates if the survey is active or not.
You can modify an existing survey, although this is not recommended if answers to the survey have already been given.
You should know that the results of a survey ar not consistent if you modify the survey and users have already inserted answers.
The news section allows you to insert news relative to your project. News can be monitored similar to tracker items, forums. News will be displayed on the project homepage and also on the site homepage, if the site administrators approve the news.
News are generally used to announce software releases, milestones, or significant changes in the software.
You can insert a news item by clicking on the Submit link.
You can post news about your project if you are an admin on your project.
All posts for your project will appear instantly on your project summary page. Posts that are of special interest to the community will have to be approved by a member of the HL7 Project Homebase news team before they will appear on the HL7 Project Homebase home page.
You may include URLs, but not HTML in your submissions. URLs that start with http:// are made clickable.
The news item will go to the News Admin for approval for publication.
The CVS button shows a page that contains information on how to access the CVS repository. Use this information to configure your client for CVS access.
This page also displays some statistics about the selected project's CVS tree.
The Browse CVS Repository link opens the viewcvs web interface, where you can view the CVS repository, view differences between revisions, download versions of a file.
Note
Only public projects will show the browse CVS repository link.
The File Releases System (FRS) is used to upload files to the HL7 Project Homebase site and to make these files available to the users in an easy and efficient way.
Files can be divided in different packages, and every single package can be monitored by the users; these users will receive an email every time a new file has been added to the package.
The FRS system allows you to upload file to HL7 Project Homebase and make this file available to the public.
You have to define a package before you can release a file. A package should have a descriptive name for the project, e.g. gforge3.
To add a new package, insert a package name in the textbox at the bottom of the page and click Create this Package.
Your package will appear in the Releases list at the bottom of the page.
Click Add release. The form has the following fields:
- Package ID
You can select here the package.
- Release Name
Insert here the name of your release. The name should be indicative for the version of your file, e.g. pre-8.
- Release Date
The Release Date.
- File Name
Click the browse button to select the file to upload. In some browsers you must select the file in the file-upload dialog and click OK. Double-clicking doesn't register the file.
Note
You can't upload file that exceed the UploadFile Limit in php.ini.
- File Type
You can select here the file type (.zip, .html, .exe, .tar.gz, etc).
- Processor Type
You can select here the processor required to run the application.
- Release Notes
The release notes.
- Changelog
The changelog.
Click the Release File button. Your file will now appear in the list of files in the File section.
The side-wide functions are available anytime, they are not dependent on the single projects.
The site-wide functions handle data that are not relevant to a single project, as code fragments, project classification, project helps, etc.
The single site-wide functions available to the users are:
Project help
Search
Snippet Library
Trove map
You can search in the HL7 Project Homebase for the following arguments:
- People
You can search for login name or the complete username. The search is not case sensitive. Inserted text must be at least 3 characters.
- Software/Group
You can search for software groups. Inserted text must be at least 3 characters.
- Skill
You can search for skills inserted by the users. Only public skills profiles can be searched. Inserted text must be at least 3 characters.
You can search for People or Software groups by selecting the item in the combo box and inserting the search text in the text box.
If the user is inside one of the Trackers, a voice Tracker appears in the combo box.
If the user is inside a forum, a voice Forum appears in the combo box.
This allows users to classify their projects in a tree so that they can be found more easily.
The Snippet Library function of HL7 Project Homebase is very interesting; it allows to collect all the type of information/knowledge which is not a complete piece of code and which is usually difficult to organize/share.
A typical example are sophisticated shell commands, javascript functions, perl one-liner, SQL expressions that perform special queries, an algorithm, etc.
You can insert a new Snippet by clicking on the link.
A form appears, where the following information can be inserted:
- Title
Insert the title of the snippet. This will be displayed in the list of the snippets.
- Description
Insert the description of the snippet.
- Type
Select the type of the snippet: function, full script, Howto, class, Readme.
- License
Select the license you want to use for your snippet.
- Language
Select the language of the snippet (if it is language dependent).
- Category
Classify your snippet in categories tree.
- Version
You should insert here the version of the snippet. For a new snippet, insert 1.0.
- Code
Paste here the code of the snippet.
You can browse snippets by clicking the link.
You can browse snippets by Language or by Category. The resulting table shows the list of all snippets of the Language/Category. You can click on the snippet number to view the detail of the snippet.
You cannot modify an existing snippet, but you can add a new version of the snippet by clicking on the Submit a new version link on the bottom part of the detail page of the snippet.
Adding a new version does not delete the old version, all previous versions will be available.