2. Using This Demo

This demo page contains a demonstration of how Generic Topics can be made to work in SWEHB. 

This demo uses several pages created in different versions of SWEHB to prove out the viability of the generic topic approach. 

2.1 Links to files in this demo

• 5.02 - IDD - Interface Design Description - SiteDemo This is the topic page constructed in the SITE space.
• 5.02 - IDD - Interface Design Description - demo This is the topic page in the SWEHBVC space. It contains only an Include-Page macro pointing to the page in SITE.
• 5.02 - IDD - Interface Design Description - Demo This is the topic page in the SWEHBVD space. It contains only an Include-Page macro pointing to the page in SITE. 

2.2 Navigating the Demo

1. Click on the demo page for the SWEHBVD space "5.02 - IDD - Interface Design Description - Demo". Open it in a new tab. 
   1. Notice that header for the page is the header for the SWEHBVD space
   2. Go to the Guidance tab and click on one of the superscripts. It will take you to the Resources tab. 
   3. In section 3. Guidance, notice that there are SWE and Topic page names listed but they are not links. 
   4. In section 5.3 Additional Guidance, notice that the list of Related Links contains SWE and topic page names but no links
   5. In section 5.3 Additional Guidance, there is a Note stating that this topic is generic and contains no links. 
2. Click on the demo page for the SWEHBVC space "5.02 - IDD - Interface Design Description - demo". Open it in a new tab. 
   1. Notice that header for the page is the header for the SWEHBVC space
   2. Go to the Guidance tab and click on one of the superscripts. It will take you to the Resources tab. 
   3. In section 3. Guidance, notice that there are SWE and Topic page names listed but they are not links. 
   4. In section 5.3 Additional Guidance, notice that the list of Related Links contains SWE and topic page names but no links
   5. In section 5.3 Additional Guidance, there is a Note stating that this topic is generic and contains no links. 
3. Click on the demo page for the SITE space. "5.02 - IDD - Interface Design Description - SiteDemo" Open it in a new tab. 
   1. Notice that header for the page is the header for the SWEHBVD space. That is because the header for SITE is the default header for all spaces and that is the header for the current SWEHB version - SWEHBVD. 
   2. Go to the Guidance tab and click on one of the superscripts. It will take you to the Resources tab. 
   3. In section 3. Guidance, notice that there are SWE and Topic page names listed but they are not links. 
   4. In section 5.3 Additional Guidance, notice that the list of Related Links contains SWE and topic page names but no links
   5. In section 5.3 Additional Guidance, there is a Note stating that this topic is generic and contains no links. 
   6. The page in SITE space is the generic topic page.
      1. The other pages in other spaces pull the content of this page into their page shell so that the appropriate header is displayed on the screen. 
      2. The references are built using the topic number . In spaces that don't have the topic number in the page name work because the references list is built from the number in the SITE space before the content is displayed in the space that called it. 

3. Making a Topic Generic

These are the steps for making a topic generic.

3.1 Setup in SITE

The SITE space needs to be prepared for holding the topics to be moved. These are the one time steps. 

1. Created the "Generic Topics" page under the SITE Home page.  - DONE
2. Created this page content to explain how generic topics works.  - DONE

3.2 Evaluate a topic for moving to Generic Topics

1. The topic may contain links to SWEs or other Topics. These links will be removed when the generic page is created, but the page names that were linked will remain. This allows the reader to find the page in the SWEHB version they are using. Note: some older versions may not contain some of the SWE or topic versions referenced. 
2. The topic may reference some features that are not available in older versions of the SWEHB. For example, Activities are referred to in the generic topic because they exist in SWEHBVD but are not available in earlier SWEHB versions. Older versions of Topics that are later determined to be Generic will need to be re-evaluated to see if and how the topic could be made Generic. If it cannot be made Generic, just leave it in the old SWEHB version as a unique topic. 

3.3 Convert A Topic To Generic Topic

This is done once per topic. It is based on a topic coming from SWEHBVD.

1. Create a page in SITE, under the "Generic Topics" page, with the name of the page being moved from SWEHBVD. Make sure that the topic is properly numbered and retains the complete page title. 
2. Copy the complete body content from the SWEHBVD version of the page and paste it into the SITE space version of the page.
   1. This may include an "Excerpt Include", "Show If", or other macros in addition to the main "tabsetup" macro containing the body of the page.   
   2. Save both versions.
   3. Verify that the copies are complete and functional. 
3. In the SITE version of the page, make the following changes: 
   1. Remove all SWE and topic links.
      1. Click each link and use the "Unlink" function in the editor. 
      2. Make each page title BOLD, Green, Underlined so that it can be easily found by users. 
   2. Replace all "SWERREFN" macros with "TABLINK2" macros. Ensure that
      1. the correct tab is used for the Resources,
      2. the SWEREF number is entered. 
      3. The formatting of the completed macro must be changed to superscript
      4. Remove the old SWEREFN macro
   3. Above the "tablink" macro, add a note informing the reader how to get to the SWEs and topics in the version of the SWEHB they are using. Do this by using "Include=Page" pointing to Generic Additional Guidance. 
   4. In the Resources tab, in the section "x.x Additional Guidance", add a note informing the reader how to get to the SWEs and topics in the version of the SWEHB they are using. Do this by using "Include=Page" pointing to Generic Additional Guidance. 
   5. Build child pages under the new Topic in SITE for "Related SWEs" and "Related SM".  
      1. Copy the contents of these pages from their counterparts in SWEHBVD.
      2. Make sure that the entries are all unlinked and changed to BOLD, Green, Underlined
      3. Make sure that the links to the child pages all work in the generic page.
   6. Verify that the "x.x Center Process Asset Libraries" section is still functional. 
   7. Add a Note in section "x.x Associated Activities",
      1. Use "Include-Page" pointing to Generic Associated Activities.
      2. The activities may be linked. 
4. Verify that the page, in SITE, is fully functional: 
   1. Verify that "tabsetup" macro is properly working
   2. Verify that SWEREFs are going to the Resources tab. Only using the new tablink2 macros and old SWEREFN macros have been removed. 
   3. Verify that the new Related Links are properly coming from the child pages
   4. Verify that all links to SWEs and Topics are unlinked. 
   5. Verify that the note in Resources, Additional Guidance is visible. 
   6. Verify that the note in Resources, Associated Activities is visible. 
5. Fix links in SWEHB Versions
   1. SWEHBVD: D. Topics
   2. SWEHBVC: D. Topics
   3. SWEHBVB: D. Software Topics - only has series 7.x topics
   4. 7150:  Book C. Topics - only has series 7.x topics
   5. Go to the Topics page in each SWEHB version and check that the topic has been updated and appears correctly when opened.
      1. Ensure that the topic excerpt points to the Generic Topic in SITE space and not to the one in the SWEHB space. 
6. Fix links in Activity pages for Generic Topics
   1. Use Traceability of Subjects to SWEs and SM page to find where excerpts are present in Activities. 
   2. Go to each Activity containing the topic and fix the Excerpt pointer to get excerpt from SITE. 

3.4 Replace A Topic In A SWEHB Version

This is done once per topic in each SWEHB version. It is based on a topic coming from SWEHBVD. Additional steps are added for other versions. 

1. Initial steps in the topic page in SWEHBVD.
   1. Edit the page and remove the "tabsetup" macro including all of the content. 
   2. Add the "Include Page" macro. Point the macro to the appropriate topic page in SITE. 
   3. Remove the "show if" macro. If a Show-If macro is needed it will be in the SITE page. 
   4. Leave the "Excerpt Include" macro if there is one. This is used when moving to a new SWEHB version. 
   5. Save the page and verify that the body of the page is now coming from the SITE page (all the links to SWEs and Topics will be gone).
2. Open the Topics page in a new tab. 
   1. Verify that the topic page can still be opened from the Topics page. The page should look the same but the links to SWEs and topics will be gone. 
   2. Verify that the References in the Resources tab are still working. 

Make updates in Migration of Topics.