Skip to content

Commit 518ad73

Browse files
amystamile-usgsjrcain-usgs
amystamile-usgs
and
jrcain-usgs
authored
9.0.0 Docs Cherry-pick (#5778)
* Move banner jpg out of repo to S3, not in public domain (#5680) * move banner, not public domain * delete moon-cr banner, unused * use same list for front page and regular menu * banner text - ISIS app manuals still here * ISIS App manuals vs new docs wording * grammar have -> has * Menu Fixes to Isis Docs (#5734) * Add in 9.0.0 menu option --------- Co-authored-by: Jacob Cain <115182890+jrcain-usgs@users.noreply.github.com>
1 parent 7f03e78 commit 518ad73

File tree

7 files changed

+113
-160
lines changed

7 files changed

+113
-160
lines changed

‎isis/cmake/BuildDocs.cmake‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,6 @@ function(build_object_docs)
312312
file(MAKE_DIRECTORY ${docInstallFolder}/${docVersion}/Object/apps)
313313
file(MAKE_DIRECTORY ${docInstallFolder}/${docVersion}/Object/Developer)
314314
file(MAKE_DIRECTORY ${docInstallFolder}/${docVersion}/Object/Programmer)
315-
file(MAKE_DIRECTORY ${docInstallFolder}/${docVersion}/documents/DocStyle/assets)
316315
copy_wildcard("${docBuildFolder}/Object/*.html" ${docInstallFolder}/${docVersion}/Object/)
317316
#copy_file(${objBuildDir}/isisDoxyDefs.doxydef ${docInstallFolder}/documents/DocStyle/assets/isisDoxyDefs.doxydef)
318317

‎isis/src/docsys/Object/Makefile‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@ documentation:
3535
mkdir -p $(ISISROOT)/doc/Object
3636
mkdir -p $(ISISROOT)/doc/Object/Developer
3737
mkdir -p $(ISISROOT)/doc/Object/Programmer
38-
mkdir -p $(ISISROOT)/doc/documents/DocStyle/assets
39-
rsync -qlHptr --delete --rsh=ssh build/isisDoxyDefs.doxydef $(ISISROOT)/doc/documents/DocStyle/assets/
4038

4139

4240
assetsDir:
@@ -108,7 +106,6 @@ clean:
108106
rm -f build/Programmer_temp.conf
109107
rm -f build/Developer_temp.conf
110108
rm -rf docbuild
111-
rm -f ../documents/DocStyle/assets/isisDoxyDefs.doxydef
112109
rm -f doxyWarnDeveloper.txt doxyWarnProgrammer.txt
113110

114111
cleandoc:

‎isis/src/docsys/assets/img/PIA26068.jpg‎

-1.25 MB
Binary file not shown.

‎isis/src/docsys/assets/img/moon-cr.jpg‎

-349 KB
Binary file not shown.

‎isis/src/docsys/assets/styles/IsisStyleCommon.css‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
/* Logo/Brand */
9393

9494
#isis-banner {
95-
background: url(../img/PIA26068.jpg) no-repeat;
95+
background: url(https://asc-docs.s3.us-west-2.amazonaws.com/common/img/PIA26068.jpg) no-repeat;
9696
background-position: 50% 75%;
9797
color: white;
9898
padding: 3rem;

‎isis/src/docsys/build/main.xsl‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,20 @@ Deborah Lee Soltesz
8484
</div>
8585
<div class="usa-card__container width-tablet">
8686
<div class="usa-card__header">
87-
<h4 class="usa-card__heading">Documentation Update</h4>
87+
<h4 class="usa-card__heading">Some ISIS Docs have Moved</h4>
8888
</div>
8989
<div class="usa-card__body">
9090
<p>
91-
ISIS documentation, including tutorials, how-to guides, and software usage explanations, has been relocated to <a href="https://astrogeology.usgs.gov/docs/" target="_blank">the USGS Astrogeology Software Docs website</a>. Documentation for previous versions of ISIS remains accessible via the left navigation pane.
91+
ISIS documentation, including ISIS tutorials, guides, and concepts,
92+
has been moved to <a href="https://astrogeology.usgs.gov/docs/" target="_blank">USGS Astrogeology Software Docs</a>.
93+
Manuals for each ISIS Application <a href="{$menuPath}Application/index.html" target="_blank">remain here</a>,
94+
as do docs for previous ISIS versions, accessible via the left panel.
95+
9296
</p>
9397
</div>
94-
<div class="usa-card__footer">
95-
<a href="https://astrogeology.usgs.gov/docs" class="usa-button">Visit USGS Astrogeology Software Docs</a>
98+
<div class="usa-card__footer" style="display: flex;">
99+
<a href="https://astrogeology.usgs.gov/docs" class="usa-button">Go to USGS Astrogeology Software Docs</a>
100+
<a href="{$menuPath}Application/index.html" class="usa-button">Go to ISIS App Manuals</a>
96101
</div>
97102
</div>
98103
</div>

‎isis/src/docsys/build/menu.xsl‎

Lines changed: 103 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -4,93 +4,106 @@
44
xmlns:fo="http://www.w3.org/1999/XSL/Format"
55
exclude-result-prefixes="xmlns fo">
66

7-
<!--
8-
9-
This stylesheet will be used to generate the menu for all pages,
10-
Include this file in other XSL files, define variable for menuPath,
11-
and apply the template mode writeMenu .
12-
13-
Author
14-
Deborah Lee Soltesz
15-
12/13/2002
16-
17-
-->
18-
<xsl:template mode="writeFrontPageMenu" name="writeFrontPageMenu">
19-
20-
<nav aria-label="usa-sidenav" class="sidenav">
21-
22-
<div id="nav-title">
23-
<div id="nav-title-text-box">
24-
<em id="nav-title-text">ISIS<br />Documentation</em>
25-
</div>
26-
</div>
27-
28-
<ul class="usa-sidenav">
29-
<li class="usa-sidenav__item">
30-
<a href="{$menuPath}index.html" target="_top" id="homeLink">Home/About</a>
31-
</li>
32-
<li class="usa-sidenav__item">
33-
<a href="{$menuPath}Application/index.html" target="_top" id="homeLink">Application&#160;Manuals</a>
34-
<ul class="usa-sidenav__sublist">
35-
<li class="usa-sidenav__item">
36-
<a href="{$menuPath}Application/index.html">By Category</a>
37-
</li>
38-
<li class="usa-sidenav__item">
39-
<a href="{$menuPath}Application/alpha.html">By Alphabetical</a>
40-
</li>
41-
<li class="usa-sidenav__item">
42-
<a href="{$menuPath}Application/oldvnew.html">Old vs. New</a>
43-
</li>
44-
</ul>
45-
</li>
46-
<li class="usa-sidenav__item">
47-
<a href="https://github.com/DOI-USGS/ISIS3">GitHub</a>
48-
</li>
49-
<li class="usa-sidenav__item">
50-
<a href="{$menuPath}Object/Developer/index.html">API</a>
51-
</li>
52-
<li class="usa-sidenav__item">
53-
<a href="https://isis.astrogeology.usgs.gov">Versions</a>
54-
<ul class="usa-sidenav__sublist">
55-
<li class="usa-sidenav__item">
56-
<a href="https://isis.astrogeology.usgs.gov">Public&#160;Release</a>
57-
</li>
58-
<li class="usa-sidenav__item">
59-
<a href="https://isis.astrogeology.usgs.gov/8.3.0/">8.3.0</a>
60-
</li>
61-
<li class="usa-sidenav__item">
62-
<a href="https://isis.astrogeology.usgs.gov/8.2.0/">8.2.0</a>
63-
</li>
64-
<li class="usa-sidenav__item">
65-
<a href="https://isis.astrogeology.usgs.gov/8.1.0/">8.1.0</a>
66-
</li>
67-
<li class="usa-sidenav__item">
68-
<a href="https://isis.astrogeology.usgs.gov/8.0.0/">8.0.0</a>
69-
</li>
70-
<li class="usa-sidenav__item">
71-
<a href="https://isis.astrogeology.usgs.gov/7.2.0/">7.2.0</a>
72-
</li>
73-
<li class="usa-sidenav__item">
74-
<a href="https://isis.astrogeology.usgs.gov/7.1.0/">7.1.0</a>
75-
</li>
76-
<li class="usa-sidenav__item">
77-
<a href="https://isis.astrogeology.usgs.gov/7.0.0/">7.0.0</a>
78-
</li>
79-
<li class="usa-sidenav__item">
80-
<a href="https://isis.astrogeology.usgs.gov/6.0.0/">6.0.0</a>
81-
</li>
82-
<li class="usa-sidenav__item">
83-
<a href="https://isis.astrogeology.usgs.gov/3.9.0/">3.9.0</a>
84-
</li>
85-
<li class="usa-sidenav__item">
86-
<a href="https://isis.astrogeology.usgs.gov/3.5.0/">3.5.0</a>
87-
</li>
88-
</ul>
89-
</li>
90-
</ul>
91-
</nav>
92-
93-
</xsl:template>
7+
<!--
8+
9+
This stylesheet will be used to generate the menu for all pages,
10+
Include this file in other XSL files, define variable for menuPath,
11+
and apply the template mode writeMenu .
12+
13+
Authors:
14+
Deborah Lee Soltesz - 2/13/2002
15+
Jacob Cain and Amy Stamile - 11/22/2024
16+
17+
-->
18+
19+
<xsl:template mode="writeMenuContents" name="writeMenuContents">
20+
<ul class="usa-sidenav">
21+
<li class="usa-sidenav__item">
22+
<a href="{$menuPath}index.html" target="_top" id="homeLink">Home/About</a>
23+
</li>
24+
<li class="usa-sidenav__item">
25+
<a href="{$menuPath}Application/index.html" target="_top" id="homeLink">Application&#160;Manuals</a>
26+
<ul class="usa-sidenav__sublist">
27+
<li class="usa-sidenav__item">
28+
<a href="{$menuPath}Application/index.html">By Category</a>
29+
</li>
30+
<li class="usa-sidenav__item">
31+
<a href="{$menuPath}Application/alpha.html">By Alphabetical</a>
32+
</li>
33+
<li class="usa-sidenav__item">
34+
<a href="{$menuPath}Application/oldvnew.html">Old vs. New</a>
35+
</li>
36+
</ul>
37+
</li>
38+
<li class="usa-sidenav__item">
39+
<a href="https://github.com/DOI-USGS/ISIS3">GitHub</a>
40+
</li>
41+
<li class="usa-sidenav__item">
42+
<a href="{$menuPath}Object/Developer/index.html">API</a>
43+
</li>
44+
<li class="usa-sidenav__item">
45+
<a href="https://isis.astrogeology.usgs.gov">Versions</a>
46+
<ul class="usa-sidenav__sublist">
47+
<li class="usa-sidenav__item">
48+
<a href="https://isis.astrogeology.usgs.gov">Latest Release</a>
49+
</li>
50+
<li class="usa-sidenav__item">
51+
<a href="https://isis.astrogeology.usgs.gov/dev/">Dev</a>
52+
</li>
53+
<li class="usa-sidenav__item usa-current">
54+
<a href="https://isis.astrogeology.usgs.gov/9.0.0/">9.0.0</a>
55+
</li>
56+
<li class="usa-sidenav__item">
57+
<a href="https://isis.astrogeology.usgs.gov/8.3.0/">8.3.0</a>
58+
</li>
59+
<li class="usa-sidenav__item">
60+
<a href="https://isis.astrogeology.usgs.gov/8.2.0/">8.2.0</a>
61+
</li>
62+
<li class="usa-sidenav__item">
63+
<a href="https://isis.astrogeology.usgs.gov/8.1.0/">8.1.0</a>
64+
</li>
65+
<li class="usa-sidenav__item">
66+
<a href="https://isis.astrogeology.usgs.gov/8.0.0/">8.0.0</a>
67+
</li>
68+
<li class="usa-sidenav__item">
69+
<a href="https://isis.astrogeology.usgs.gov/7.2.0/">7.2.0</a>
70+
</li>
71+
<li class="usa-sidenav__item">
72+
<a href="https://isis.astrogeology.usgs.gov/7.1.0/">7.1.0</a>
73+
</li>
74+
<li class="usa-sidenav__item">
75+
<a href="https://isis.astrogeology.usgs.gov/7.0.0/">7.0.0</a>
76+
</li>
77+
<li class="usa-sidenav__item">
78+
<a href="https://isis.astrogeology.usgs.gov/6.0.0/">6.0.0</a>
79+
</li>
80+
<li class="usa-sidenav__item">
81+
<a href="https://isis.astrogeology.usgs.gov/3.9.0/">3.9.0</a>
82+
</li>
83+
<li class="usa-sidenav__item">
84+
<a href="https://isis.astrogeology.usgs.gov/3.5.0/">3.5.0</a>
85+
</li>
86+
</ul>
87+
</li>
88+
</ul>
89+
</xsl:template>
90+
91+
<xsl:template mode="writeFrontPageMenu" name="writeFrontPageMenu">
92+
93+
<nav aria-label="usa-sidenav" class="sidenav">
94+
95+
<div id="nav-title">
96+
<div id="nav-title-text-box">
97+
<em id="nav-title-text">ISIS Application<br />Manuals</em>
98+
</div>
99+
</div>
100+
101+
<xsl:call-template name="writeMenuContents"/>
102+
103+
</nav>
104+
105+
</xsl:template>
106+
94107
<xsl:template mode="writeMenu" name="writeMenu">
95108

96109
<nav aria-label="usa-sidenav" class="sidenav">
@@ -100,73 +113,12 @@ Deborah Lee Soltesz
100113
<img id="nav-title-logo" height="65" src="{$menuPath}assets/img/isis-logo-yellow-notxt.svg"></img>
101114
</div>
102115
<div id="nav-title-text-box">
103-
<em id="nav-title-text">ISIS<br />Documentation</em>
116+
<em id="nav-title-text">ISIS Application<br />Manuals</em>
104117
</div>
105118
</div>
106119

107-
<ul class="usa-sidenav">
108-
<li class="usa-sidenav__item">
109-
<a href="{$menuPath}index.html" target="_top" id="homeLink">Home/About</a>
110-
</li>
111-
<li class="usa-sidenav__item">
112-
<a href="{$menuPath}Application/index.html" target="_top" id="homeLink">Application&#160;Manuals</a>
113-
<ul class="usa-sidenav__sublist">
114-
<li class="usa-sidenav__item">
115-
<a href="{$menuPath}Application/index.html">By Category</a>
116-
</li>
117-
<li class="usa-sidenav__item">
118-
<a href="{$menuPath}Application/alpha.html">By Alphabetical</a>
119-
</li>
120-
<li class="usa-sidenav__item">
121-
<a href="{$menuPath}Application/oldvnew.html">Old vs. New</a>
122-
</li>
123-
</ul>
124-
</li>
125-
<li class="usa-sidenav__item">
126-
<a href="https://github.com/DOI-USGS/ISIS3">GitHub</a>
127-
</li>
128-
<li class="usa-sidenav__item">
129-
<a href="{$menuPath}Object/Developer/index.html">API</a>
130-
</li>
131-
<li class="usa-sidenav__item">
132-
<a href="https://isis.astrogeology.usgs.gov">Versions</a>
133-
<ul class="usa-sidenav__sublist">
134-
<li class="usa-sidenav__item">
135-
<a href="https://isis.astrogeology.usgs.gov">Public&#160;Release</a>
136-
</li>
137-
<li class="usa-sidenav__item">
138-
<a href="https://isis.astrogeology.usgs.gov/8.3.0/">8.3.0</a>
139-
</li>
140-
<li class="usa-sidenav__item">
141-
<a href="https://isis.astrogeology.usgs.gov/8.2.0/">8.2.0</a>
142-
</li>
143-
<li class="usa-sidenav__item">
144-
<a href="https://isis.astrogeology.usgs.gov/8.1.0/">8.1.0</a>
145-
</li>
146-
<li class="usa-sidenav__item">
147-
<a href="https://isis.astrogeology.usgs.gov/8.0.0/">8.0.0</a>
148-
</li>
149-
<li class="usa-sidenav__item">
150-
<a href="https://isis.astrogeology.usgs.gov/7.2.0/">7.2.0</a>
151-
</li>
152-
<li class="usa-sidenav__item">
153-
<a href="https://isis.astrogeology.usgs.gov/7.1.0/">7.1.0</a>
154-
</li>
155-
<li class="usa-sidenav__item">
156-
<a href="https://isis.astrogeology.usgs.gov/7.0.0/">7.0.0</a>
157-
</li>
158-
<li class="usa-sidenav__item">
159-
<a href="https://isis.astrogeology.usgs.gov/6.0.0/">6.0.0</a>
160-
</li>
161-
<li class="usa-sidenav__item">
162-
<a href="https://isis.astrogeology.usgs.gov/3.9.0/">3.9.0</a>
163-
</li>
164-
<li class="usa-sidenav__item">
165-
<a href="https://isis.astrogeology.usgs.gov/3.5.0/">3.5.0</a>
166-
</li>
167-
</ul>
168-
</li>
169-
</ul>
120+
<xsl:call-template name="writeMenuContents"/>
121+
170122
</nav>
171123

172124
</xsl:template>

0 commit comments

Comments
 (0)