bannera

Book A.
Introduction

Book B.
7150 Requirements Guidance

Book C.
Topics

Tools,
References, & Terms

SPAN
(NASA Only)

The Healthcheck page is used to quickly determine if there are broken plugins or macros in the SWEHB. Most of the plugins and macros used in the SWEHB are included in this page along with tips on how they are used and interrelate. 

The Alias macro should not be seen If it is broken you will see an error message with a red background like "The license could not be verified: License Certificate has expired!" for example. 

SWEREFSETTAB is a user macro. It should not be seen on the page unless there is a problem. If it is broken you will see an error message with a red background like "The license could not be verified: License Certificate has expired!"

Healthcheck

TABSETUP Macro

The TABSETUP macro is responsible for the page being displayed like a set of tabbed index cards. If you don't see tha tabbed cards you will know that the macro is broken. You may also see an error message.

Additionally, if the TABSETUP macro is broken you may see the content of the remaining tabs listed on the page without tabs.

SWEREFSETTAB Macro

This macro is typically used outside of the tab set (above). Its purpose is to tell the SWEREF macro which tab contains the References (REFSTABLE macro). It is present only if the References are on a tab other than the fifth tab.

TERM Macro

The TERM macro is no longer used.

 

SWEREF Macro

There should be a number "438" at the end of this sentence. $param0.

This uses the SWEREFN macro which should show the number "123" at the end of this sentence. 123

Clicking on the superscript number should take you to tab 4 - the Resources tab. If it does not take you there then the SWEREFSETTAB macro is not working or the "Set Data" macro is not working.

The number should look like a link (color blue) and rendered as a superscript. If the SWEREF macro is broken you may see an error message like "The license could not be verified: License Certificate has expired!" onclick="scrollTo(0,0)">438

 

This tab contains two user macros

Resources - REFSTABLE Macro

The REFSTABLE macro should provide a list of references from the children of the References Table page. In this case, the ones that are tagged with the "Intro" tag. REFSTABLE is a user macro and is not supported by any outside organization.

When it is working properly you should see an info panel with the text "Click here to view master references table." in a blue background. above a bulleted list of references. If it is not working you may see an error message with a red background like "The license could not be verified: License Certificate has expired!".

Tools - TOOLSTABLE Macro

The TOOLSTABLE macro should provide a list of tools from the children of the Tools Table page. In this case, the ones that are tagged with the "Intro" tag. TOOLSTABLE is a user macro and is not supported by any outside organization.

When it is working properly you should see an info panel with the text "Tools relative to this SWE may be found in the table below. You may ..." in a blue background. above a bulleted list of tools. If it is not working you may see an error message with a red background like "The license could not be verified: License Certificate has expired!".

5.1 Tools

Tools relative to this SWE may be found in the table below. You may wish to reference the Tools Table in this handbook for an evolving list of these and other tools in use at NASA. Note that this table should not be considered all-inclusive, nor is it an endorsement of any particular tool. Check with your Center to see what tools are available to facilitate compliance with this requirement.

No tools have been currently identified for this SWE. If you wish to suggest a tool, please leave a comment below.

Other User Macros and Plugins

"Applicable"

The "applicable" macro is used to display a table of applicable software classes that a SWE page belongs to. "APPLICABLE"is a user macro and is not supported by any outside organization.

If it is working properly, you will see a table of classes (a through h) with either (tick) (check) or (error) ("x") indicating applicability. In this example all are checked except for two which are marked P(C).

 

Class

  A_SC 

A_NSC

  B_SC 

B_NSC

  C_SC 

C_NSC

  D_SC 

D_NSC

  E_SC 

E_NSC

     F      

     G      

     H      

Applicable?

   

   

   

   

   

   

   

   

   

    P(C)

   

   

    P(C)

Key:    A_SC = Class A Software, Safety Critical | A_NSC = Class A Software, Not Safety Critical | ... | - Applicable | - Not Applicable
X - Applicable with details, read above for more | P(C) - P(Center), follow center requirements or procedures

"Applicable b"

The "applicable b" macro is used to display a table of applicable software classes that a SWE page belongs to. "APPLICABLE b"is a user macro and is not supported by any outside organization.

If it is working properly, you will see a table of classes (a through h) with either (tick) (check) or (error) ("x") indicating applicability. In this example only "B" is marked with an (error).

Class

     A      

     B      

     C      

   CSC   

     D      

   DSC   

     E      

     F      

     G      

     H      

Applicable?

   

   

   

   

   

   

   

   

   

   

Key:    - Applicable | - Not Applicable
A & B = Always Safety Critical; C & D = Not Safety Critical; CSC & DSC = Safety Critical; E - H = Never Safety Critical.

Scaffolding and Report Plugins

The Scaffolding and Report plugings are add-ons to the Confluence wiki software. They are developed and supported by ServiceRocket.

These plugins are critical for the operation of several user macros including

  • TERM
  • SWEREF
  • REFSTABLE
  • TOOLSTABLE
  • SWEREFSETTAB
  • Set Data

Panel and related macros

My panel

This is my panel.

This is my warning

This is my info box.

This text should be in a grey box with a triangular icon in front of it since it is contained within a Note macro. The Note macro is a standard feature of Confluence.

  • No labels