How to Include Web Pages with a Project

One of the best things you can include with your data is a simple, clear description of the data, including any related manuscripts and contact information should users have further questions. Possibly the best way to do this is by including a webpage along with your data. This webpage will be visible both on-line so that users can review it before downloading your data, and off-line, providing them with a nice reference of what is included.

The webpage may be anything you like, and it will be accessible directly on-line. For example, here is the webpage for the PNNL's data mirror on Tranche. It is designed to look just like a page from their website, and it works just like their website; however, it links directly to data hosted in the ProteomeCommons.org Tranche system.

Unless you are an expert at HTML, or you have specific ideas for what you would like on the webpage, it is recommended that you stick to a simple, basic webpage.

A template for a simple webpage

Here is a link to a simple template webpage. This is a no-frills webpage that provides others with basic information about your data and contact information. Follow the steps listed below to use this template.

  1. Right-click on the template link and save the page as "index.html"
  2. Edit the values on the page to have the information you want.
  3. Save your customized "index.html" page to the root directory of your data.
  4. Upload your data to ProteomeCommons.org Tranche

The name "index.html" is used because that is the default page that is often presented for a website. People will normally read it first when looking for documentation and it will also be shown by default when the data is hosted in Tranche. Aside from the special naming, the trickiest thing to do is properly customizing the template, especially if you aren't familiar with HTML.

Most of the webpage is designed with text that says, "Put here your information", or something similar. Editing the page is as easy as opening it in Notepad and changing these phrases with the information you would like to include. For example, changing the title involves editing the field below.

<h1 style="padding-bottom:0px;margin-bottom:0px;">Insert here the title for your data set</h1>

To do something similar to what is below.

<h1 style="padding-bottom:0px;margin-bottom:0px;">My Data Set</h1>

HTML is just a combination of plain-text and tags. In the above example the <h1> tag is being used for the header. Changing the text is as easy as editing the text between the <h1> and </h1> tags -- be careful not to delete the tags, they are important. Likewise, changing the rest of the text in the template is as easy as changing the text included with other HTML tags, often the <p> and </p> tags that denote a paragraph of text.

Here is a complete example of how the above template might be edited.

Other options

You don't have to edit webpage markup by hand. There are lots of tools that will help. Some easy ones are Microsoft Word or OpenOffice Writer. Simply make a new page of text. Style it how you like. Then choose "Save as HTML", naming the page "index.html".



Home   •   FAQ   •   Contact Us   •   Join email list   •   Collaborations   •   Credits