bannerd

SWEHBDOC Quotes in SWEHB

 1. Introduction

Explains how quotes are used and maintained in SWEHB. 

Any document, NASA document or external document,  that is referred to in a SWEHB page may have a quote taken from it and included in the SWEHB page. Quotes must be properly cited and attributed to the author.

Short / Simple Quotes

Short quotes vary from a few words to a short sentence. They are included in-line in the text of a page in the traditional fashion. They are introduced by stating where the quote comes from (title of the reference), and then the quote itself in traditional quotation marks. If a reference is updated and possibly rewritten, some quotes are changed and may not be found verbatim in the updated version of the reference. 

Long Quotes

Long quotes vary from long complex sentences, to strings of sentence fragments (separated with ellipses) to a paragraph or more. These quotes are set apart from the rest of the text in the page in a special form. they are also documented in a special way so that they can be verified when the source reference is updated. 

2. Short / Simple Quotes

When you use a quote it is important to cite the quote accurately and give proper acknowledgement to the source of the quote (author or organization). The use of a SWEREF reference page, and a SWEREFN macro to point to a reference in the References section of the Resources tab is the correct way to do this. 

Short quotes vary be a few words, a phrase, or a short sentence. They are included in-line in the text of a page in the traditional fashion. They are introduced by stating where the quote comes from (title of the reference), and then the quote itself in traditional quotation marks, followed by the SWEREFN macro with the SWEREF number in the body of the macro. 

If a reference is updated and possibly rewritten, some quotes are changed and may not be found verbatim in the updated version of the reference. This can be a maintenance problem. To avoid this situation, where possible, do not use a quote, use a paraphrased version of the idea. It is still appropriate to refer to the source of the idea and have the reference listed in the References on the Resources page. 


3. Long Quotes

Long quotes vary from long complex sentences, to strings of sentence fragments (separated with ellipses) to a paragraph or more. These quotes are set apart from the rest of the text in the page in a special form. they are also documented in a special way so that they can be verified when the source reference is updated. 

The long quote is put into the body of a "Set-Data" macro which is set into the body of a Panel macro.

  • The Set-Data macro uses two parameters
    • Name - 
    • Render - select "wiki"

4.

5.

6. L

  • No labels