Skip to content

Commit 05879c9

Browse files
Copilotrvosa
andcommitted
Add reachability analysis for undocumented pages
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
1 parent 6fb4786 commit 05879c9

1 file changed

Lines changed: 77 additions & 46 deletions

File tree

doc/PAGE_CROSS_REFERENCE.md

Lines changed: 77 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document cross-references the URL mappings in `treebase-servlet.xml` against the pages documented in the v3 UI/UX user story markdown files (`doc/v3/*.md`).
44

5-
**Analysis Date:** 2026-01-12
5+
**Analysis Date:** 2026-01-13
66

77
**Source Documents:**
88
- `treebase-web/src/main/webapp/WEB-INF/treebase-servlet.xml`
@@ -18,76 +18,105 @@ This document cross-references the URL mappings in `treebase-servlet.xml` agains
1818
- Total URL mappings in treebase-servlet.xml: 138
1919
- Pages accounted for in user stories: 107
2020
- Pages NOT in user stories: 32
21+
- Reachable from documented pages: 14
22+
- Unreachable (no links found): 18
2123

2224
---
2325

2426
## Pages NOT in User Story Documentation
2527

26-
The following pages from `treebase-servlet.xml` are NOT mentioned in any "Pages to Account For" section of the v3 user story documents:
28+
The following pages from `treebase-servlet.xml` are NOT mentioned in any "Pages to Account For" section of the v3 user story documents.
29+
30+
**Reachability Analysis:** Pages marked as "(unreachable)" have no links found in JSP files, menu configuration, or controller redirects from any documented pages.
2731

2832
### Public/Utility Pages
2933

30-
| URL | Controller | Description |
31-
|-----|------------|-------------|
32-
| `/accessviolation.html` | filenameController | Access violation error page |
33-
| `/login.html` | filenameController | Login page (note: `/login.jsp` is documented instead) |
34+
| URL | Controller | Description | Reachability |
35+
|-----|------------|-------------|--------------|
36+
| `/accessviolation.html` | filenameController | Access violation error page | Reachable (controller redirects) |
37+
| `/login.html` | filenameController | Login page (note: `/login.jsp` is documented instead) | (unreachable) |
3438

3539
### Alternative Search URL Patterns
3640

3741
These are search-related URLs that use different URL patterns than those documented in User Story 01 (which documents `/search/studySearch.html`, etc.):
3842

39-
| URL | Controller | Description |
40-
|-----|------------|-------------|
41-
| `/search/` | studySearchController | Search root redirect |
42-
| `/searchForm.html` | searchFormController | Search form (alternative URL pattern) |
43-
| `/searchResult.html` | filenameController | Search results (alternative URL pattern) |
44-
| `/searchStudy.html` | searchStudyController | Study search (alternative to `/search/studySearch.html`) |
45-
| `/searchStudyList.html` | listSearchStudyController | Study search list |
46-
| `/study-query.html` | updateStudyQueryController | Study query form |
43+
| URL | Controller | Description | Reachability |
44+
|-----|------------|-------------|--------------|
45+
| `/search/` | studySearchController | Search root redirect | (unreachable) |
46+
| `/searchForm.html` | searchFormController | Search form (alternative URL pattern) | (unreachable) |
47+
| `/searchResult.html` | filenameController | Search results (alternative URL pattern) | (unreachable) |
48+
| `/searchStudy.html` | searchStudyController | Study search (alternative to `/search/studySearch.html`) | Reachable (studyList.jsp) |
49+
| `/searchStudyList.html` | listSearchStudyController | Study search list | (unreachable) |
50+
| `/study-query.html` | updateStudyQueryController | Study query form | (unreachable) |
4751

4852
### Search Download/Export Pages
4953

50-
| URL | Controller | Description |
51-
|-----|------------|-------------|
52-
| `/search/downloadANexusRCTFile.html` | downloadANexusRCTFileController | Download reconstructed NEXUS file |
53-
| `/search/downloadAStudy.html` | downloadAStudyController | Download entire study |
54-
| `/search/downloadATreeBlock.html` | downloadATreeBlockController | Download tree block |
55-
| `/search/downloadAnAnalysisStep.html` | downloadAnAnalysisStepController | Download analysis step data |
56-
| `/search/matrixRowList.html` | listMatrixRowController | Matrix row list view |
57-
| `/search/searchResultsAsRDF.rdf` | searchResultsAsRDFController | Search results as RDF |
58-
| `/search/summary.html` | summaryController | Search summary page |
59-
| `/search/taxonList.html` | listTaxaSearchController | Taxon list view |
54+
| URL | Controller | Description | Reachability |
55+
|-----|------------|-------------|--------------|
56+
| `/search/downloadANexusRCTFile.html` | downloadANexusRCTFileController | Download reconstructed NEXUS file | (unreachable) |
57+
| `/search/downloadAStudy.html` | downloadAStudyController | Download entire study | (unreachable) |
58+
| `/search/downloadATreeBlock.html` | downloadATreeBlockController | Download tree block | Reachable (treeBlockList.jsp, treeBlocks.jsp) |
59+
| `/search/downloadAnAnalysisStep.html` | downloadAnAnalysisStepController | Download analysis step data | Reachable (algorithm.jsp, analysis.jsp, analyses.jsp) |
60+
| `/search/matrixRowList.html` | listMatrixRowController | Matrix row list view | Reachable (matrixList.jsp, viewAllRowSegmentData.jsp) |
61+
| `/search/searchResultsAsRDF.rdf` | searchResultsAsRDFController | Search results as RDF | (unreachable) |
62+
| `/search/summary.html` | summaryController | Search summary page | (unreachable) |
63+
| `/search/taxonList.html` | listTaxaSearchController | Taxon list view | (unreachable) |
6064

6165
### User Submission Pages
6266

63-
| URL | Controller | Description |
64-
|-----|------------|-------------|
65-
| `/user/analyses.html` | summaryController | Study analyses (duplicate of analysisDisplay) |
66-
| `/user/authorForm.html` | authorFormController | Author edit form |
67-
| `/user/authorList.html` | authorFormController | Author list |
68-
| `/user/directToPhyloWidget.html` | directToPhyloWidgetController | Direct PhyloWidget link (alternate to directMapToPhyloWidget) |
69-
| `/user/displaySubmissionMenu.html` | displaySubmissionMenuController | Submission menu display |
70-
| `/user/downloadANexusRCTFile.html` | downloadANexusRCTFileController | Download reconstructed NEXUS |
71-
| `/user/editorForm.html` | editorFormController | Editor edit form |
72-
| `/user/nexusFiles.html` | nexusFilesController | View NEXUS files |
73-
| `/user/readOnlyListTree.html` | readOnlyListTreeController | Read-only tree list |
74-
| `/user/submissionMain.html` | filenameController | Submission main page |
75-
| `/user/treeParser.html` | treeParserController | Tree parser |
76-
| `/user/treeParserResult.html` | treeParserResultController | Tree parser results |
77-
| `/user/viewXML.html` | filenameController | View XML output |
67+
| URL | Controller | Description | Reachability |
68+
|-----|------------|-------------|--------------|
69+
| `/user/analyses.html` | summaryController | Study analyses (duplicate of analysisDisplay) | Reachable (menu-config.xml) |
70+
| `/user/authorForm.html` | authorFormController | Author edit form | Reachable (peopleList.jsp) |
71+
| `/user/authorList.html` | authorFormController | Author list | (unreachable) |
72+
| `/user/directToPhyloWidget.html` | directToPhyloWidgetController | Direct PhyloWidget link (alternate to directMapToPhyloWidget) | Reachable (analysisSection-Piece.jsp) |
73+
| `/user/displaySubmissionMenu.html` | displaySubmissionMenuController | Submission menu display | (unreachable) |
74+
| `/user/downloadANexusRCTFile.html` | downloadANexusRCTFileController | Download reconstructed NEXUS | Reachable (nexusFiles.jsp) |
75+
| `/user/editorForm.html` | editorFormController | Editor edit form | Reachable (peopleList.jsp, citationForm-booksection.jsp) |
76+
| `/user/nexusFiles.html` | nexusFilesController | View NEXUS files | Reachable (menu-config.xml) |
77+
| `/user/readOnlyListTree.html` | readOnlyListTreeController | Read-only tree list | (unreachable) |
78+
| `/user/submissionMain.html` | filenameController | Submission main page | (unreachable) |
79+
| `/user/treeParser.html` | treeParserController | Tree parser | Reachable (testParser.jsp) |
80+
| `/user/treeParserResult.html` | treeParserResultController | Tree parser results | Reachable (treeList.jsp) |
81+
| `/user/viewXML.html` | filenameController | View XML output | Reachable (treeParserResult.jsp) |
7882

7983
### Development/Test Pages
8084

81-
| URL | Controller | Description |
82-
|-----|------------|-------------|
83-
| `/test/testParser.html` | treeParserController | Test parser (development) |
85+
| URL | Controller | Description | Reachability |
86+
|-----|------------|-------------|--------------|
87+
| `/test/testParser.html` | treeParserController | Test parser (development) | (unreachable) |
8488

8589
### JSON/API Pages
8690

87-
| URL | Controller | Description |
88-
|-----|------------|-------------|
89-
| `/json/submissionIsland.html` | submissionToJsonController | Submission JSON data |
90-
| `/appletInteraction.html` | appletInteractionController | Applet interaction handler |
91+
| URL | Controller | Description | Reachability |
92+
|-----|------------|-------------|--------------|
93+
| `/json/submissionIsland.html` | submissionToJsonController | Submission JSON data | (unreachable) |
94+
| `/appletInteraction.html` | appletInteractionController | Applet interaction handler | (unreachable) |
95+
96+
---
97+
98+
## Summary of Unreachable Pages
99+
100+
The following 18 pages have no links from documented pages and may be candidates for deprecation or need explicit documentation:
101+
102+
1. `/login.html` - Alternative to documented `/login.jsp`
103+
2. `/search/` - Search root
104+
3. `/searchForm.html` - Alternative search form
105+
4. `/searchResult.html` - Alternative search results
106+
5. `/searchStudyList.html` - Study search list
107+
6. `/study-query.html` - Study query form
108+
7. `/search/downloadANexusRCTFile.html` - Download reconstructed NEXUS (search context)
109+
8. `/search/downloadAStudy.html` - Download entire study
110+
9. `/search/searchResultsAsRDF.rdf` - Search results as RDF
111+
10. `/search/summary.html` - Search summary
112+
11. `/search/taxonList.html` - Taxon list view
113+
12. `/user/authorList.html` - Author list
114+
13. `/user/displaySubmissionMenu.html` - Submission menu display
115+
14. `/user/readOnlyListTree.html` - Read-only tree list
116+
15. `/user/submissionMain.html` - Submission main page
117+
16. `/test/testParser.html` - Development test page
118+
17. `/json/submissionIsland.html` - JSON submission data
119+
18. `/appletInteraction.html` - Applet interaction handler
91120

92121
---
93122

@@ -177,6 +206,8 @@ The following pages from `treebase-servlet.xml` ARE documented in the v3 user st
177206

178207
4. **JSON/API Endpoints** (`/json/submissionIsland.html`) - Consider adding to User Story 06 (Technical)
179208

209+
5. **Unreachable Pages** - The 18 unreachable pages may be candidates for deprecation or may need their links restored if they provide needed functionality
210+
180211
---
181212

182213
## Notes

0 commit comments

Comments
 (0)