SWEHBDOC Add A Reference To A Page

Several situations may exist that complicate this simple request. 

• the reference may need to be added to the References Table. 
• the reference in the table my need to be updated,  
• the reference needs to be properly called out in the page,  
• the reference needs to be tagged properly so it can be displayed in the page. 

All of this possibilities are covered below. They may not all be present when you add a reference to a page. 

You can explore existing pages to find out how all of these things work. 

1. Use An Existing Reference In The References Table

1. Open the References Table page in a new tab. The References Table in SWEHBVD actually displays the table from the 7150 space. That is the home for the master References Tables. 
2. Search the page for the reference you want to add. Ctrl-F will open the search function and any sub-string may be used in the search. If you have multiple hits in the search, you may need to decide which one is appropriate. All references have a SWEREF Reference ID number. That is the key to the Reference page. 
3. If there is no reference in the table matching the one you want to add, you will have to "Add A Reference To The Table". See details below. 
4. When you find the reference, click on the Reference ID and open it in a new tab. (example SWEREF-083)
5. If you need to change the Link, Title, Citation, or Notes, click on "Edit Contents" and make your changes in the field provided. Save your changes and verify that they are working. 
6. To make the Reference appear on your SWEHB page, use "Edit Contents" and go into the "SWE or Topic" section. Follow the patterns in this section and add your page code accordingly. DO NOT ADD AN "ENTER" ANYWHERE IN THE SECTION. 
7. Save the SWEREF when you are done and go to your SWEHB page and look at the results. The reference should be displayed in the Resources tab in the References section. 

2. Add A Reference To The Table

If a reference is not in the References Table you will need to add it. 

1. The easiest way to do this is to view the last SWEREF in the table (not one in the 9xx series), and use the Copy command to make a copy of it. 
2. Once the page is copied you will be in the editor and the title of the new page starts with "Copy of ..." . 
   1. Edit the title to remove the "Copy of" from the title
   2. Change the SWEREF-number to be the next one in the series. 
   3. Leave the "Live Template" macro in place. 
   4. Save the page. 
3. The page should look empty of data and only contain a table of variable names. 
4. Use the "Edit Contents" command and fill in the table of values for the Reference:
   1. In the Link row, copy in the HTTP link to the reference. This may be to a NASA server or some outside internet site containing the document. 
   2. In the Title row, copy in the title of the document. 
   3. In the Citation row, copy in the information about the author, hosting organization, published date for the document, etc. 
   4. In the Notes row put in any other information pertinent to how the reference is valuable to the SWEHB. 
   5. In the "SWE or Topic" row, add the code for the SWE or Topic where the reference should appear. 
      1. For a SWE, use the first 7 characters of the SWE page using a comma as a separator. For example "SWE-456, "
      2. For a topic, the format is "Topic 9.99, ", where the "9.99" is replaced by the 4 character topic code, and using a comma as a separator. The word "Topic" must precede the 4 character code. 
      3. THERE MUST BE NO "ENTER" AT THE END OF THE TABLE CELL. 
5. Save the page and verify that everything looks correct. Compare to other SWEREFs if there is any question about how things look
6. Look on the target page for the reference. It should appear on the Resources tab, in the References section along with other references. 

For additional details on how References work see SWEHBDOC References in SWEHB. 

3. References In Page Content

Once you have a SWEREF in the References Table, and appearing in the References list on the Resources tab of your page, you will want to tie this into the reference you put into the content part of the page. 

In a paragraph of content, you may include the title of the reference in bold font to make it stand out on the page. Another way to do this is to use the document ID such as NPR7150.2D. To direct the user to the Resources page so they can find a copy of the reference, add the SWEREFN macro. Leave a space between the title and the start of the SWEREFN macro. The shortcut to adding the macro is using the curly bracket followed by SWEREFN. 

Once the macro is in place click on it and edit the contents. There is only one parameter: the 3 digit SWEREF number. Save it. Then save the page and test the macro. 

The title or ID of the reference should be bold, followed by a space, followed by a 3 digit number as in this example: 

NPR7150.2D ⁰⁸³ .

When yo click on the superscript "083" link, it should take you to the Resources tab where you will see the reference listed among the other references for the page. When you click on the link for reference SWEREF-083, It should take you to a page where you can get to the NPR7150.2D. 

4. Where is the Resources Tab? 

The SWEREFN macro will take the user to tab 5 of the page. This is because tab 5 is the Resources tab for all SWEs and some Topics. If the tab structure is changed (like it is in many topics) an alternative tab must be specified for Resources. Note what tab is used for Resources on your page. 

If needed, above the "tabsetup" macro, add a "Set-data" macro using the curly bracket shortcut. It has only a name parameter. Assign a name of "reftab" and save the macro. In the body of the macro, put in the number of the Resources tab. In the example below it is 7. It should look like the image to the right at this point. 

Below is a working example of a Set-Data macro. You will need to be in Edit mode to see it. 7

5. The Magic That Builds The References List In A Page

There are several User Macros that build the References list on a page when the page is viewed. These macros are documented in SWEHBDOC References in SWEHB, in tab 3. They are designed to use the number codes that are built into the SWE and Topic titles. Make sure that your page has the appropriate macro in the References section of the Resources tab and all will be fine.