Text Products

« Back to Products Documentation

$Id: text.html 15596 2012-07-06 17:31:03Z tene $
$URL: https://ghttrac.cr.usgs.gov/websvn/ProductDistribution/trunk/etc/documentation/userguide/products/text.html $

Introduction

The content of a simple text-type product is displayed directly on the event page. Text may be plain text or HTML markup. However, markup is not validated nor reviewed; product producers sending this type of product must take care to ensure the text content is appropriate.

There are three types of text products: general-text, scitech-text and impact-text. The text product-type is determined by the content of the code property of the product, where code is associated with the addon product. For example, if code = "GeneralMisc", a general-text product is created, rather than scitech-text or impact-text. The text product itself is never created.

In a sense, addon and text can be considered "abstract" products having properties that are used by other products, resulting in the creation of one of the three concrete text product types. To illustrate, if an origin product makes use of the addon-type and text properties with code = "GeneralMisc", then a general-link product will be created in addition to origin. This extra link information will then be seen of the Summary page for the product.

Types

general-text
general-text is currently displayed on the Summary page for the event. These products are created when code starts with case insensitively: "Aftershock", "AfterWarn", "ASW", "GeneralMisc".

scitech-text
scitech-text is currently displayed on the Technical page for the event. These products are created when code starts with case insensitively: "Energy", "FocalMech", "ncfm" (deprecated, use FocalMech instead), "HistMomentTensor", "FiniteFault", "MomentTensor", "mtensor" (deprecated, use MomentTensor instead), "Phase", "SeisCrossSec", "SeisRecSec", "TravelTimes", "Waveform", "Seismograms", "SciTechMisc".

impact-text
impact-text is currently displayed on the Impact page for the event. These products are created when code starts with case insensitively: "TsunamiLinks", "ImpactMisc".

Properties

addon-type
A value of "comment" specifies this as a text product.
code
Starting case-insensitve text determines the type of text product (see Introduction above): general-text, scitech-text or impact-text.

Contents

inline
The text to display on the event page.