bannerc

A. Introduction

B. Institutional Requirements

C. Project Software Requirements

D. Topics

E. Tools, References, and Terms

F. SPAN
(NASA Only)

Versions Compared

Old Version 18

changes.mady.by.user Haigh, Fred Douglas. (HQ-KA000)[PEROT]

Saved on

compared with

New Version Current

changes.mady.by.user Haigh, Fred Douglas. (HQ-KA000)[PEROT]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

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.   

Set-Data is a 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!"

Set Data
hiddentrue
namereftab
4
Tabsetup
01. TABSETUP Macro
12. Panel and Note Macro
23. SWEREF Macro
34. Resources
45. Other User Macros and Plugins
56. TOC Macro
67. Show if Macro
7Gliffy Plugin
Div
idtabs-1

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.

Div
idtabs-2

Panel and Note Macro

The TERM macro is no longer used. .


Panel

This text should be in a grey box since it is contained within a Panel macro. The Panel macro is a standard feature of Confluence.

Note

This text should be in a yellow 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.



Div
idtabs-3

SWEREF Macro

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

sweref
refnum438
. SWEREF macro is broken. It has been replaced by SWEREFN below.

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

Swerefn
refnum123

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


Div
idtabs-4

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!".

refstable-intro

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!".

toolstable

Div
idtabs-5

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).


applicable
f1
g1
hp
ansc1
asc1
bnsc1
csc1
bsc1
esc1
cnsc1
dnsc1
dsc1
enscp
"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). 
 Applicable b
a1
b0
csc1
c1
d1
dsc1
e1
f1
g1
h1
"Applicable c"
The "applicable c" macro is used to display a table of applicable software classes that a SWE page belongs to. "APPLICABLE c"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" , "C", and "F" is marked with an (error).
 Applicable c
a0
b1
c1
d0
e0
f1

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
  • SWEREF
  • REFSTABLE
  • TOOLSTABLE
  • SWEREFSETTAB
  • Set Data
 Div
idtabs-6
TOC Macro
 Panel
This is a panel
 Table of Contents
 Div
idtabs-7
Show if Macro
The Show if macro will display its contents only to members of the "confluence-users" group. a Show if macro is in the panel below.
 Panel
 Show If
groupconfluence-users
This text will be displayed only to members of the Confluence-users group. Any other user viewing this tab will see nothing in this panel.
If there is an error, both confluence users and all others including anonymous users will see the error message.
 Div
idtabs-8
Gliffy Plugin
Panel with a Gliffy in it from topic 8.9 tab 2. 
 Panel
Figure 1: Software Function Definition Example
 Gliffy Diagram
nameSoftware Function Definition Example
pagePin4




    
    






    
	

    
    
    



    




    
    

    
    
    






        



        

    

    



										
								
		        

		    



		
						
 











Page Editor: Tim Crumbley 

NASA Official: Tim Crumbley






NASA Software Engineering Handbook - A service of the NASA Office of the Chief Engineer

 NASA Privacy Statement

______________________________________________________________________________