If the quotation is a short sentence, a sentence fragment, or a phrase, it may be put into the page surrounded by quotation marks. The attribution for the quote may be put either before or after the quote. The attribution should include the title of the document from which the quote is taken. The attribution will also be followed by a SWEREFN macro containing the 3 digit SWEREF number for the reference. All quotes should be taken from a properly referenced source. See References in SWEHB for details of creating and maintaining references. If the quotation is a long, complex sentence or more, it will be put into a "Set Data" macro so it can be tied properly to the reference it came from in the References Table database. In the SWEHB page, the quote is put into a Set Data macro contained within a Panel macro. The panel macro serves to highlight the quote for the reader. It is set off with a blue border to make it distinctive and different from the Note panel which has a yellow border and yellow background. The title of the panel contains the title of the reference from which the quotation is taken. Inside of the panel are two macros: When a quote is taken from a reference, is it important to identify it in the SWEREF page so that if the source document is changed, the new document can be reviewed to see if any changes were made to any of the items quoted in SWEHB pages. In some cases a quotation will be built from two or more fragments with ellipses separating the fragments. This is done to exclude text that is superfluous and might confuse the reader. In the example below, The quotation is in 3 parts, taken from the opening paragraphs in the reference. The quotation in the SWE contains the fragments along with notes describing where the fragments are taken from. To ensure that the text display does not run together, set the Render parameter to "wiki" in the Set Data macro. If it is text, the returns are removed when displaying the text and the text will all run together with no white space or new lines where you expect them. A quote in a SWEHB page should be put into a "Set Data" macro contained in a Panel. Once the Panel and Set Data are saved in the SWE page, you can go to the SWEREF page to complete the quote. In the SWEREF page, click on Edit. Below the Live Template and the Show If macros, start a new line in heading style 3. The line should be "Quotes used in SWEs and Topics". Below that, put in a link to the page containing the quote in a bulleted list. After the page link, describe Below the bullet with the link to the SWE page, Start a Report Info macro with the command "{Report In". After a few characters the dropdown menu should let you select the "Report Info" macro. In the parameter block: The completed entry in SWEREF-038 looks like this. report info
See edit history of this section
Post feedback on this section
1. Introduction
Quotations have been used in SWEHB since the first version. Quotes vary from short quotes of a few words or phrases, to long quotes of one or more long sentences or paragraphs.1.1 Short Quotes
1.2 Long Quotes
2. Quotation Structure
2.1 In the SWEHB page containing the quote
2.2 In the SWEREF page
2.3 Fragmented Quotations
3. Adding a Quotation
3.1 Panel Macro
3.2 Set Data Macro
3.3 Report Info Macro in the SWEREF page
3.3.1 Quotes used in SWEs and Topics
Quotes used in SWEs and Topics
3.3.2 - Display the quote from the SWE
Quotations in SWEHB
Web Resources
View this section on the websiteUnknown macro: {page-info}
Q1-SEI CERT Coding Standards.
some quote from SWEREF-004 ...