DECdocument
DECdocument
Tutorial and
Application Guide

9.5 Reference Notes

Should you want to put some reference notes in your article, you can use the <REF_NOTE> and <REF_NOTES> tags to do this.

The <REF_NOTE> tag is used in the body of the text to mark a note. This is similar to a footnote mark. The tag is followed by the note text enclosed in parentheses. The reference note number will appear in the output enclosed in square brackets (i.e. [1], [2], etc.).

The <REF_NOTES> tag is placed in the end portion of the SDML text file and causes DECdocument to list all the reference notes that were placed in the main body of text. You can specify a heading or not.

These two tags are specific to the ARTICLE doctype.

The formats are:

<REF_NOTE>(note text)

<REF_NOTES>(optional heading text)

Later, we will put some reference notes in the main body of text. Right now, we will put in the tag that will cause the notes to be listed.

Example: <REF_NOTES>

9.6 Acknowledgments

You can put an acknowledgments section in your article by using the <ACKNOWLEDGMENTS> tag. The acknowledgments text follows the tag. This tag can be placed either in the front portion of the text file or at the end of the SDML file. We will put it at the end in our sample.

This tag is specific to the ARTICLE doctype.

The format is:

<ACKNOWLEDGMENTS>(text)

We will add some acknowledgments text to the end of the text file.

Example: <ACKNOWLEDGMENTS>

9.7 Background of the Author

You can provide some history about the author by using the <VITA> tag. This tag can be placed either in the front portion of the text file right after the <AUTHOR> tag or at the end of the SDML file. We will put the tag at the end in our sample.

This tag is specific to the ARTICLE doctype.

The format is:

<VITA>(text)

We will now add some author history text to the end of the SDML file.

Example: <VITA>

9.8 Reference Notes in the Text

The SAMPLE_ARTICLE.SDML file is completed except for the main body of text. We will now add the main body of text and will also add some reference notes.

The tags used in the main body of the article have all been described in previous chapters. The <REF_NOTE> tag is used for reference notes.

Example: <REF_NOTE>

<title_section> <title>(Country Living) <subtitle>(Where Every Day is an Adventure) <endtitle_section> <running_title>(Life in the Country) <running_feet>(Country Life) <author>(June Bugg\Writer) <author_aff>(<emphasis>(The Country Gazette) Newsletter) <author_addr>(Route 4 - Backcountry\San Diego, California) <abstract> The change from city living to country living can be very exciting. It might even be a little bit hazardous at times. <endabstract> <chead>(Moving to the Country) When you live in the city, the grocery store is just around the corner and the bank, flower shop, cleaners and gas station are within a few blocks. You go to these places daily not thinking about their convenient locations. <ref_note>(Living in the city <emphasis>(does) have its advantages.) When you live out in the country away from stores and shopping centers, you must plan your needs more carefully. For example, you tend to keep a good eye on the gas gauge so that you will not find yourself stranded by the roadside. In the city, pets are somewhat restricted to dogs, cats, birds and other small critters. In the country, you can have lots of animals, small and large. Some people have chickens, horses, cows, sheep, llamas, ostrichs and even camels and buffalo. The list is almost endless. My move to the country came about when I had accumulated 3 large dogs and the backyard was no longer big enough for them. I knew this would be an exciting adventure but I was a little apprehensive, never having had this experience before. And so the search began for a country home. Some of the requirements <ref_note>(These are just a few things to look for when purchasing a home in the country. You should also find out about water sources and sewer/septic systems.) for this country home were: <sample_text> <list>(unnumbered) <le> medium size house <le> not too isolated <le> 1 to 5 acres <le> some trees <le> paved road <endlist> <endsample_text> After many excursions into unknown territory, the search ended at a 2+ acre site studded with pine trees and the most incredible view of the valleys below. As it turned out, this country home came with some chickens. I was a bit uneasy about this situation. As a child, the family had a few chickens including a very big, nasty rooster which used to chase me around the yard. These chickens were banty chickens which are about half the size of regular chickens and the previous owner assured me that they were <emphasis>(nice) chickens. And so it was that these <emphasis>(nice) chickens gave me a good many half-size eggs.<ref_note>(One species of banty chickens lays small, blue eggs.) <chead>(Varmints in the Hen House) About mid-summer my parents and nephew left the Arizona heat to come to spend a few weeks in cooler weather at my country home. They, too, enjoyed the view, the pines and fresh eggs. It was during this time, that problems developed in the chicken pen. Several chickens were killed and eggs were disappearing. My father said it must be a weasel.<ref_note>(Weasels are known for getting into chicken coops.) Late one morning, there was a frantic noise in the chicken pen. The chickens were clucking and cock-a-doodle-doing up a storm. As I was walking over to the pen, something disappeared under the hen house. I was too far away to see what it was. I went back to the house and explained what had happened to my father and nephew. They proceeded over to the chicken pen with shovel and hoe in hand. My mother and I watched from the deck as the two fellows banged on the hen house walls and floor trying to get the little varmint to come out. That didn't accomplish anything. They dug under one end of the coop and shoved the hoe handle into the opening. My mother and I let out a big gasp. You couldn't miss recognizing the black and white stripe of the skunk that raced out from under the other end of the hen house. To this day, we all laugh about the skunk and are ever so thankful it didn't go <emphasis>(OFF). <ref_notes>(Reference Notes) <acknowledgments>(The writer thanks all the country critters for making life such an adventure.) <vita>(June Bugg lives in the country and has or has had many <list>(simple) <le> dogs <le> cats <le> horses <le> chickens <le> fish <le> birds <endlist> She has been writing articles for various publications for many years.)

9.9 Article Command and Output

The SAMPLE_ARTICLE.SDML file is completed and ready for DECdocument to process.

Command

When you create an article, you need to specify the ARTICLE doctype.

You can create a PS, TXT or TERM output file. The commands are:

$ document sample_article.sdml article ps
$ document sample_article.sdml article mail
$ document sample_article.sdml article term

Output

The processed sample article appears on the next pages.

Notice how the column margins are left and right-justified. This is one of the main characteristics of the ARTICLE doctype.

Comments

There are a number of other tags that can be used for articles. The "Using the Article Doctype" section in the Using Doctypes and Related Tags manual gives an example of an article and describes all the article tags that are available. It also tells about working with columns.

Chapter 10
Creating a Report

DECdocument allows you to create reports in two different designs. The design is the page format or how text is placed on a page. The page design is specified by the doctype. For example, the REPORT doctype (i.e. design) places the text across the page from left margin to right margin. The REPORT.TWOCOL doctype (i.e. design) places the text in two columns on a page. Both of these doctypes allow you to use the REPORT specific tags.

When creating a report, you can use the global tags and also the special tags used for reports.

This chapter will describe some of the report tags and how to create a report. The example file we will use will be called SAMPLE_REPORT.SDML. We will create both types of reports so you can see the design differences. The first line of report paragraphs are NOT indented, the ARTICLE doctype does that.

10.1 The Front Matter

Reports have a cover page which is the front matter. The title, author and other information are included in the front matter.

The front matter uses the following tags:

<FRONT_MATTER>

front matter tags and text

<ENDFRONT_MATTER>

We will start the SAMPLE_REPORT.SDML file with the front matter tags.

Example: <FRONT_MATTER>, <ENDFRONT_MATTER>

<front_matter> <endfront_matter>

10.2 Title Page Tags

There are three TITLE tags used in reports. Two tags tell the beginning and ending of the title page and the other tag gives the report title. These tags are:

<TITLE_PAGE>

<TITLE>(report title)

<ENDTITLE_PAGE>

We will add the title tags and text to the SDML file.

Example: title tags

<front_matter> <title_page> <title>(Dogs and Cats - Together) <endtitle_page> <endfront_matter>

10.3 Running Titles and Running Feet

As with the ARTICLE doctype, you can have running titles and running feet in your report. Running titles are one or two lines of text that appear at the top of the pages in the report. Running feet is a single line of text that appears, with the page number, at the bottom of the report pages.

The formats for the running title and feet tags are:

<RUNNING_TITLE>(top line of text)

or

<RUNNING_TITLE>(top line 1 text\top line 2 text)

<RUNNING_FEET>(optional bottom line text)

We will put these two tags into our report file. We will NOT provide any text for the <RUNNING_FEET> tag. If you use <CHAPTER> tags, the chapter name is used as the text at the bottom of the page.

Example: <RUNNING_TITLE>, <RUNNING_FEET>

<front_matter> <title_page> <title>(Dogs and Cats - Together) <running_title>(Dogs and Cats) <running_feet> <endtitle_page> <endfront_matter>

10.4 Report Abstract

You can put some comments about the report in the front matter section. These comments will print under the title on the cover page. You use the <ABSTRACT> tags for these comments. The format is:

<ABSTRACT)

comment text

<ENDABSTRACT)

An abstract will be added to the report title page.

Example: <ABSTRACT>, <ENDABSTRACT>

<front_matter> <title_page> <title>(Dogs and Cats - Together) <running_title>(Dogs and Cats) <running_feet> <abstract> This is a short report about dogs and cats living together. <endabstract> <endtitle_page> <endfront_matter>

10.5 Author Information

You can put author information in a report by using the <AUTHOR> tag. A maximum of three lines of text is allowed. The text is separate by the "\" backslash.

<AUTHOR>(author name)

or

<AUTHOR>(author name\text line 1\text line 2)

NOTE: There is another form of the <AUTHOR> tag that is used with the ARTICLE doctype.

We will add some author information to our report SDML file.

Example: <AUTHOR>

10.6 Signature Lines

If this is the type of report where several people read it and sign it off, you can use tags to show the names and signature lines. The tags you use are the <SIGNATURES> and <BYLINE> tags. The <SIGNATURES> tag tells DECdocument that one or more names and lines will follow. The <BYLINE> tag causes a signature line to be created and a name to be created under the line. The signature lines can optionally be placed on a separate page.

The <SIGNATURES> tag is specific to the REPORT doctype.

Some optional text can be used with the <BYLINE> tag.

The formats are:

<SIGNATURES>

or

<SIGNATURES>(NEWPAGE)

<BYLINE>(name)

or

<BYLINE>(name\optional text)

We will put these tags in our report text file.

Example: <SIGNATURES>, <BYLINE>

10.7 Report Date

You should have a date on your report. We can use the <DATE> tag for this. You have used the <DATE> tag in previous chapters. The format is:

<DATE>

or

<DATE>(FULL)

or

<DATE>(text)

The date is added to the SDML file. Several tags were placed before the <DATE> tag so there would be some space between the signatures and the date.

This will be the last tags we put in the front matter section.

Example: <DATE>

10.8 Body of the Report

The body of a report can contain chapters, paragraph text, lists, tables, examples, etc. Reports can also have outlines. There are three specific REPORT tags that are used to make outlines.

The body of our report will contain a chapter, some paragraph text and an outline so you can see how outlines are put together.

The following example shows some added text.

Example: body text added

10.9 Creating an Outline

There are three tags used to make an outline. These tags are:

<OUTLINE> and <ENDOUTLINE> tags
The <OUTLINE> and <ENDOUTLINE> tags indicate the beginning and end of an outline. The <OUTLINE> tag also enables the <LEVEL> and <SHOW_LEVELS> tags.
The outline can have a title. A maximum of three text lines is allowed for a title.
<LEVEL> tag
The <LEVEL> tag specifies an outline entry. This tag also provides the level number of the entry. The levels are from 1 to 6. Level 1 will show outline entries in uppercase Roman numerals. Each successive level will have its own numbering format.
<SHOW_LEVELS> tag
The <SHOW_LEVELS> tag is used to emphasis text. The text can be shown as bold or italic. All the entries in the level will be shown as bold or italic. You can turn OFF the bolding and italics with the <SHOW_LEVELS>(off) option.

The formats for the outline tags are:

<OUTLINE>

or

<OUTLINE>(title line 1\title line 2\title line 3)

outline entries

<ENDOUTLINE>

The format for the level tag is:

<LEVEL>(level number\entry text)

The formats for the show levels tag are:

<SHOW_LEVELS>(BOLD)

<SHOW_LEVELS>(ITALIC)

<SHOW_LEVELS>(OFF)

Using the outline tags, we will add an outline to the SAMPLE_REPORT.SDML file. There are blank lines between some of the outline entries. These are for readability.

Example: <OUTLINE>, <LEVEL>, <SHOW_LEVELS>

<front_matter> <title_page> <title>(Dogs and Cats - Together) <running_title>(Dogs and Cats) <running_feet> <abstract> This is a short report about dogs and cats living together. <endabstract> <author>(Sara Cook\Pet Shop Owner\Tins Inn, Maine) <signatures> <byline>(Julian Rose\Editor) <byline>(Jackie Rose\Associate Editor) <date>(January 1, 1995) <endtitle_page> <endfront_matter> <chapter>(Report Summary) This report will tell what it is like to raise dogs and cats together. As a general rule, dogs do not like cats and cats do not like dogs. Dogs tend to chase cats because cats run when they see dogs. Actually, dogs think that cats want to be chased and this is just a game. If a cat does not run, the dog might ignore it. It is possible for dogs and cats to live in harmony. Creating this environment does take some time and lots of patience. <head1>(Topics in This Report) There are several topics that will be discussed in this report. The topics are listed in the following outline. <outline>(Report Topics\Dogs and Cats) <level>(1\Dogs need) <level>(2\This is outline level 2) <level>(3\This is outline level 3) <level>(4\This is outline level 4) <level>(5\This is outline level 5) <level>(6\This is outline level 6) <level>(1\Cats need) <level>(2\Feeding) <level>(3\A good cat food; canned or dry) <level>(3\Water) <level>(3\Grass or lettuce) <level>(3\Cat treats) <level>(2\Care) <show_levels>(bold) <level>(3\Shelter) <level>(3\Litter box) <show_levels>(off) <level>(2\Toys) <show_levels>(italic) <level>(3\Scratching post) <level>(3\Toys containing catnip) <level>(3\Toys with bells) <level>(3\Paper bag) <show_levels>(off) <level>(2\Training) <endoutline>

Contents

Index

DECdocumentDECdocument Tutorial and Application Guide