Home » NIF Components »  DISCO LinkOut Format

The DISCO LinkOut format

(New format revised on: 12/13/2010)

The DISCO LinkOut format is encoded in XML format, as described below.

The root node should contain the following information:

<disco format="disco.linkout" format-version="1.0">

... the first node contains brief site information (e.g.:)

<site-info site-name="CCDB" />

... the second node contains brief site information (e.g.:)

<technical_contact name="Willy WaiHo Wong" email="wawong@sdsc.edu" /

... the next node is the required data container node:

<linkout_list>

... and inside this node one or more child "<linkout>" nodes are used to describe one LinkOut item at the time. The content in bold in the XML sample below shows the type of content that can be provided from a resource.

<linkout
      db="PubMed"
      oid="15988042"
      linkcategory="Electron microscopy product"
      linkname="Development of a model for microphysiological simulations: ... electron tomography"
      linkurl="http://ccdb.ucsd.edu/sand/main?event=displayAllProjectProds&amp;mpid=48&amp;ptype=sproject"
      />

The contents of the attributes of the <oid> node above may contain the following information:

  • db: An NCBI database name (e.g.: "PubMed", "Protein", "Nucleotide", etc). For the complete list of these databases, refer to the databases available for linking list on the NCBI's LinkOut documentation Web site.
  • oid: An Entrez object ID of an item in that database (e.g.: "15988042").
  • linkcategory: A short phrase used to categorize the link. This phrase is used to group similar links from different resources. The use of terms from the NIFSTD ontology is recommended for this attribute. (This integration capability is only available within the LinkOut server's Gateway tool, and not present on Entrez.)
  • linkname: The description of the link. This name is used by Entrez to describe the data linked from a resource. It should be concise and NCBI does not allow using their object names on this text.
  • linkourl: The URL in your resource associated with this information.

In addition to this LinkOut format, your resource needs a main "disco.xml" to identify  its location. That file and its purpose is described in this page. For more information or help regarding this format please contact the NIF Interoperability team


Back to NIF Interoperation page

Go to the DISCO DASHBOARD

NIF Navigator