| Previous | Contents | Index |
Abstract, source note, and acknowledgment sections are special formats that typically occur at the beginning or end of an article, depending on your preference.
Abstracts
Use the <ABSTRACT> tag to specify an abstract for an article. You can specify the <ABSTRACT> tag either in the context of the <TITLE_SECTION> tag or following it.
In the following example, a short abstract is created in the context of the <TITLE_SECTION> tag. This causes the abstract to be formatted using the full page width rather than just a single column. Unlike its use in the previous example, the <AUTHOR> tag occurs outside of the context of the <TITLE_SECTION> tag and so formats using a single column.
<TITLE_SECTION> <TITLE>(A Guide to Instrument Care) <ABSTRACT>(A summary of brass and keyboard instrument care fundamentals by a professional musician.) <ENDABSTRACT> <ENDTITLE_SECTION> <AUTHOR>(Dan Dover) |
Source Notes
The <SOURCE_NOTE> tag lets you specify the origin of material for an article. In the following example, the output from the <SOURCE_NOTE> tag prints at the bottom of the current column of output:
<SOURCE_NOTE>(From the Boston Globe <LINE>(<MCS>(COPYRIGHT) 1986 by the Boston Globe)) |
You can specify source information at the beginning or end of an article.
Acknowledgments
Use the <ACKNOWLEDGMENTS> tag to create any necessary acknowledgments for your article. Enter the text of the acknowledgment as an argument to the <ACKNOWLEDGMENTS> tag.
The following example shows an acknowledgments section created using the <ACKNOWLEDGMENTS> tag. Note how you use it near the end of the SDML file with the <BACK_NOTES> and <REF_NOTES> tags.
<REF_NOTES>(Bibliography) <BACK_NOTES>(References) <ACKNOWLEDGMENTS>(I am deeply indebted to my doctor for her support in this task.) |
The ARTICLE doctype uses the global numbered heading tags (<HEAD1>, <HEAD2>, and so on). However, by default, these headings are not numbered. Specify numbered headings by using the <DOCUMENT_ATTRIBUTES> tag, as shown in the following example:
<DOCUMENT_ATTRIBUTES> <SET_HEADINGS>(NUMBERED) <ENDDOCUMENT_ATTRIBUTES> |
In addition to using them for primary headings, use the global <SUBHEAD1> and <SUBHEAD2> tags to specify unnumbered paragraph topics or side headings, as in the following example:
<SUBHEAD1>(Rationale.) <P> The purpose of this experiment... |
Use the <RUNNING_TITLE> and <RUNNING_FEET> tags to place a title at the top or bottom of all the pages of your article.
The <RUNNING_FEET> tag accepts a single text argument, which it uses to create a title at the bottom of the page. The <RUNNING_TITLE> tag accepts one or two text arguments, which it uses to create a 1- or 2-line title at the top of the page.
The following example shows a 2-line running title being set for the top of the page using the <RUNNING_TITLE> tag and a single-line running title being set for the bottom of the page using the <RUNNING_FEET> tag.
<RUNNING_TITLE>(Mr. A. Author and\Mrs. B. Author) <RUNNING_FEET>(The Story of Our Life Together) |
You can use either the ARTICLE doctype <QUOTATION> tag or the global <SAMPLE_TEXT> tag to place extended quotations in an article.
Use the <QUOTATION> tag to format text you want to appear exactly as it is entered into the SDML file. The following example shows a Haiku poem formatted using the <QUOTATION> tag:
<P>
A similar Haiku follows.
<QUOTATION>
All lights are frozen;
The cursor box blinks blandly.
Soon, I see the dump.
<ENDQUOTATION>
|
Use the global <SAMPLE_TEXT> tag to create an extended quotation that is to be filled and justified in the text. You must supply any internal punctuation, special spacing, and so on. The following example shows how to use the <SAMPLE_TEXT> tag to create an extended quotation:
...mankind, as in the following text fragment: <SAMPLE_TEXT> <P> <QUOTE> Many are the ways of mankind. As some strive for recognition, others seek obscurity. Surely, we are the strangest of creatures. <ENDQUOTE> <ENDSAMPLE_TEXT> |
You can use two types of automatically numbered notes in the ARTICLE doctype: back notes and reference notes. Back notes, sometimes called end notes, are referenced in the text of an article using superscript numbers. Reference notes are similar to back notes, except that the references in the text are output using normal-sized numbers enclosed in brackets.
Footnotes are similar to back notes, except they are placed at the bottom of a column of text. To create footnotes, use the global <FOOTNOTE> tag . However, do not use the <FOOTNOTE> tag in an article in which you are using back notes. Both the <FOOT_NOTE> and the <BACK_NOTE> tags create superscript numbers for references, and that output would be extremely misleading and confusing. |
DECdocument accumulates references to each type of note while the
article processes, and outputs them at the end of the article. Use only
one of these two types of notes in your article.
2.1.7.1 Back Notes
To create a set of notes at the end of an article, use the <BACK_NOTE> tag and the <BACK_NOTES> tag. Enter the <BACK_NOTE> tag in your SDML file wherever you want to have a superscript number in the text to show a note. Enter the text of the note as an argument to the tag. DECdocument sequentially numbers each of the back note entries and places the appropriate sequential number as a superscript in the output file.
For example, if you want to cite the book Training Seagulls as a back note, and this back note was the third in your document, the text where you cited the book would appear as follows:
These techniques are outlined in Training Seagulls ^³ .
The following example shows how to use the <BACK_NOTE> tag. The <BACK_NOTE> tag would be replaced by a superscript number in the output, and the note produced by that tag would be output near the end of the article using the <BACK_NOTES> tag.
As Ms. Roma so clearly stated <BACK_NOTE>(P.A. Roma, <QUOTE>(Computer-Chart Making from the Graphic Editor's Perspective,) <EMPHASIS>(ACM Computer Graphics, SIGGRAPH '99 Conf. Proc.), Vol 45. No. 3, July 1999, pp. 247-253.)... <BACK_NOTES> |
You can create bibliographic reference notes by using the <REF_NOTE>, <REF_NOTES>, and optionally, the global <REFERENCE> tags. Place the <REF_NOTE> tag in your SDML file at the point you want the reference to appear. This tag is replaced in the output by a number in brackets, which corresponds to the number assigned to the note text, for example, [4].
Use the <REF_NOTES> tag to process the text of the reference notes you have created with assigned numbers. Typically, you place this tag at the end of the SDML file, but you can have the references appear earlier.
To reference a source that you have already referenced using the <REF_NOTE> tag, specify the symbol name argument to that <REF_NOTE> tag and use the global <REFERENCE> tag to refer to that symbol.
The following example shows a reference note created using the <REF_NOTE> tag, a referral to that note using the global <REFERENCE> tag, and the printing of all the accumulated reference notes using the <REF_NOTES> tag. Note how the <REF_NOTE> tag was coded with the symbol CHICAGO_MAN, so that the subsequent <REFERENCE> tag could reference that symbol and use that same reference note number.
Sorting entries word by word is preferred <REF_NOTE>(<EMPHASIS>(A Manual of Style,) The University of Chicago Press, 1969.\CHICAGO_MAN)... <P> Overuse of emphasis can cause confusion <REFERENCE>(CHICAGO_MAN)... <REF_NOTES>(References) |
Use the <BIBLIOGRAPHY> tag to create a bibliography of related reading when you do not use numbered reference notes to reference other works in the text of the article. The <BIBLIOGRAPHY> tag enables the <BIB_ENTRY> tag and lets you specify a heading for the bibliography as an argument to the <BIBLIOGRAPHY> tag.
Create each entry in the bibliography by specifying the entry as an argument to the <BIB_ENTRY> tag. When you use the <BIB_ENTRY> tag, use the <EMPHASIS> and <QUOTE> tags to specify the entry.
The following example shows a bibliography with two entries:
<BIBLIOGRAPHY>(Bibliography) <p> The following may also be of interest: <BIB_ENTRY>(<EMPHASIS>(Molecular Connectivity in Chemistry and Drug Research.) Lamont B. Kier and Lowell H. Hall. Academic Press, 1983.) <BIB_ENTRY>(Arhnheim, Rudolph, <EMPHASIS>(Visual Thinking). University of California Press, Berkeley, 1984.) <ENDBIBLIOGRAPHY> |
The ARTICLE doctype creates a 2-column document. Although this doctype lets you visualize what your document will look like when printed, it is somewhat less flexible in terms of how it formats SDML tags than the single-column doctypes. This section summarizes how you can improve the format of your 2-column document.
The REPORT.TWOCOL doctype also outputs a 2-column document, and these techniques work for it also. |
The width of the text column for paragraphs is much smaller in the 2-column doctype than in the single-column doctypes. Furthermore, the left column is formatted right-justified. As you enter the text for your document into the SDML file, do not be overly concerned about text paragraphs that exceed the right margin during text formatting. The text formatter issues the following message when a text line exceeds the right margin:
%TEX-W-LINETOOLONG_P, line too long ... in paragraph ... |
As you complete your document, you can use the global <HYPHENATE> and <KEEP> tags to improve line breaks in your printed document.
Use the global <HYPHENATE> tag to specify possible points of hyphenation in words the text formatter does not know how to hyphenate, but that you want to allow to hyphenate. This increases the number of places the text formatter can hyphenate the text, and so creates more even line breaks.
Use the global <KEEP> tag to specify text that you do not want hyphenated (broken across a line) by the text formatter. Use this tag sparingly, because it decreases the number of places the text formatter can hyphenate the text, making it difficult for the text formatter to create well-placed line breaks.
The text formatter constructs more well-formatted text lines in each
column when it has more places to hyphenate words in the text. The more
places you allow the text formatter to hyphenate your text, the better
your final output formats.
2.2.2 Wide Tables and Examples
When developing examples and tables using a 2-column doctype, be careful of the following conditions:
If a table, figure, or example is wider than the text column width, use the WIDE argument to specify attributes for the tag.
When you specify the <TABLE_ATTRIBUTES>, <FIGURE_ATTRIBUTES>, or <EXAMPLE_ATTRIBUTES> tag with the WIDE argument to create a wide table, figure, or example, that table, figure, or example causes the 2-column output to be suspended and the text entered before that table, figure, or example to be placed in the two columns above the table, figure, or example.
The table, figure, or example then outputs using the full page width, as if occurring in a single-column doctype. Two-column formatting is restored after the table, figure, or example ends, and the text after the table, figure, or example begins again in the first column under the table, figure, or example.
A code example, itself, using the <CODE_EXAMPLE> and
<ENDCODE_EXAMPLE> example tags, does not suspend the column
output and print the code example across both columns. You must encase
the code example in a table, figure, or example.
2.2.3 Final Adjustment of Column and Page Breaks
Using a 2-column doctype, you may need to adjust your paged output when your text is complete. It is sometimes difficult to create balanced pages with the constraints of a 2-column document. Occasionally, you must insert explicit line, column, and page breaks into a 2-column document to improve its appearance.
Adjusting Column Breaks
When the text formatter creates a 2-column page, it breaks the text into two columns so as to create a page in which the columns are of as nearly equal length as possible. Certain text elements (such as tables and figures) cannot be easily broken across columns. The text formatter uses vertical space to adjust the length of the columns. Therefore, you may see large amounts of vertical white space preceding and following those text elements that accept a variable amount of white space, such as headings, lists, and tables.
Specify that columns be explicitly broken by using the <COLUMN> or <FINAL_CLEANUP>(COLUMN_BREAK) tags. Use the <COLUMN> tag only when you want the subsequent text to always begin a new column, regardless of any changes you make to the text. Use the <FINAL_CLEANUP>(COLUMN_BREAK) tag only after your text is finished and you want to improve the appearance of your document by specifying a new column of text. In either case, if the current text is in the first column of a page, starting a new column places the next text in the second column. If the current text is in the second column of a page, starting a new column results in a new page of output.
In some circumstances, the output of a 2-column page may appear to have lost vertical space before a text element. For example, a heading tag may have no space before it. When this occurs in a 2-column doctype, ignore the occurrence until you are ready to give your document a final revision. If the space is still being lost, use the <FINAL_CLEANUP>(SPECIAL_BREAK) tag. For example, suppose the following lines represent fragments of a 2-column page:
====================== ======================
======================
MAJOR HEADING ======================
==================== ======================
====================== ======================
==================== ======================
====================== Next Heading
====================== ====================
====================== ======================
shows what happens to ======================
|
<P> ...better place. An example <FINAL_CLEANUP>(SPECIAL_BREAK) shows what happens to the end of text in this column. |
You should need to use this special column break only in rare instances.
Adjusting Page Breaks
A new page of output explicitly starts whenever the following conditions exist:
In either of these situations, the current page is set in two columns, without balancing the columns. The length of the text in either column may be less than that of the regular balanced page.
2.3 A Sample Use of the ARTICLE Doctype Tags
This section contains a sample input SDML file for an article created
using the ARTICLE doctype tags and processes using the ARTICLE doctype
design.
<TITLE_SECTION> <TITLE>(I Have to Care for This Instrument?) <SUBTITLE>(One of the Young People's Musical Guides) <ENDTITLE_SECTION> <RUNNING_TITLE>(Caring for Instruments) <RUNNING_FEET>(Instrument Care) <AUTHOR_LIST>(By) <AUTHOR>(Dan Dover) <AUTHOR_AFF>(Cleveland Conservatory of Music) <AUTHOR_ADDR>(Cleveland, Ohio) <AUTHOR>(Clair Frobisher) <AUTHOR_AFF>(Toledo Academy of Fine Arts) <AUTHOR_ADDR>(Toledo, Ohio) <ENDAUTHOR_LIST> <ABSTRACT> Musical instruments of any kind can bring years of enjoyment to the player, and hopefully to the listener. But the musical instrument must be cared for properly along the way. This guide discusses basic care of several musical instruments representative of the major instrument families. <ENDABSTRACT> <CHEAD>(Keyboard Instruments) <P> The first rule in caring for any keyboard instrument is <EMPHASIS>(Are your hands clean?) <REF_NOTE>(<EMPHASIS>(Tickling the Ivories: Piano for Beginners), Architect Press, 1982.). Sticky fingers lead to sticky keys. Also, grime and dirt will scratch the keys and lodge between them as well. <P> Even the natural oils of your hand have a bad effect on the keyboard. It is always a good idea to wash your hands before playing the piano, organ, or other keyboard instrument. And after you are through playing, take a warm, damp cloth and wipe down the keyboard. This removes any residual hand oil from the keys. <column> <P> The second rule for keyboard care is <EMPHASIS>(tuning). Like Mary Edith Whiteout of the Hanscom Music Company says: <QUOTATION> You can tell the quality of pianists by the pitch of their instrument. A well-tuned piano is as much a joy, as a badly-tuned piano is a horror. <ENDQUOTATION> <P> Have your piano tuned every 6 months (for the average piano player); if you play more than 4 hours a day, we recommend you have it tuned every 3 to 4 months. <P> If your organ or your accordion goes out of tune, take it to a repairman and get the offending note fixed. In summary, basic care for your keyboard instrument entails: <LIST>(NUMBERED) <LE> Clean hands and a clean instrument; wash your hands before, wash the keyboard after <LE> Tune your instrument regularly; 6 months - average use, 3 to 4 months for heavy use <ENDLIST> <COLUMN> <CHEAD>(Brass Instruments) <P> The first rule in caring for any brass instrument is <EMPHASIS>(Keep your mouth clean.) Be sure to brush your teeth and rinse your mouth if you are going to play the trumpet <REF_NOTE>(<EMPHASIS>(Trumpeter Lullaby: Caring for Your Horn), County Ecks Press, 1985), trombone <REF_NOTE>(<EMPHASIS>(Trombone Exercises) Emerald Books, 1983), or other brass instrument. Food particles left in your mouth will foul up the valves and slides. They may even restrict the air flow, make the instrument go out of tune, or even damage it permanently. <P> The second rule is <EMPHASIS>(Oil your valves and slides regularly.) Use the recommended oil for your instrument. This will ensure that things move smoothly and quickly. <P> The third rule is <EMPHASIS>(Polish your instrument after each use) with a warm, damp cloth. This will help keep it from tarnishing from the natural oils in your hand. In addition to this, you should use a recommended brass polish every month. In summary, basic care for your brass instrument entails: <LIST>(NUMBERED) <LE> A clean mouth. <LE> Oiled valves and slides. <LE> Polishing on a regular basis. <ENDLIST> <REF_NOTES>(Additional Reading) <VITA>(Dan Dover is Toscanini Professor of Music at the Cleveland Conservatory of Music. He publishes the annual Musician's Guide to Symphonic Opportunities.) <VITA>(Clair Frobisher is the Director of the Toledo Academy of Fine Arts. Recently, she instituted the acclaimed Young People's Symphonies.) <ACKNOWLEDGMENTS>(The authors are indebted to the Toscanini Foundation for support in this series of guides.) |
Should you wish to create this output yourself, you can obtain the file ARTICLE_SAMPLE.SDML from directory DOC$ROOT:[EXAMPLES] and process it using the ARTICLE doctype. Comparing the output to this SDML file may be helpful in understanding how to use these tags.
| Previous | Next | Contents | Index |