Commit 81fb212f authored by Lauren Adoram-Kershner's avatar Lauren Adoram-Kershner Committed by Jesse Mapel
Browse files

Documentation restructure Update (#4851) 

* Final wording of user documentation landing pages

* quick personal review updates
parent 1ad6bcf7

isis/cmake/BuildDocs.cmake

+2 −5
Original line number Diff line number Diff line
@@ -67,7 +67,7 @@ endfunction(copy_app_docs_info) 
function(build_upper_level)



  # Make new (empty) output folders

  set(newFolders UserDocs UserStart UserLearn UserExplore UserInspire DevStart DevExplore DevInspire AboutIsis General Guides Installation TechnicalInfo)

  set(newFolders UserDocs UserStart UserLearn UserExplore UserInspire DevStart DevExplore DevInspire General Guides Installation TechnicalInfo)

  foreach(f ${newFolders})

    file(MAKE_DIRECTORY "${docInstallFolder}/${docVersion}/${f}")

  endforeach()
@@ -86,7 +86,7 @@ function(build_upper_level) 
  # Create the main index.html file aka the home page

  execute_process(COMMAND ${XALAN} ${XALAN_VALIDATE_OPTION} ${XALAN_PARAM_OPTION} menuPath \"${docVersion}/\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/index.html ${XALAN_INFILE_OPTION} ${docBuildFolder}/build/homepage.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/main.xsl)

  # Create a second main page inside the version numbered area for when the page above gets overwritten with a new version 

  execute_process(COMMAND ${XALAN} ${XALAN_VALIDATE_OPTION} ${XALAN_PARAM_OPTION} menuPath \"\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/index.html ${XALAN_INFILE_OPTION} ${docBuildFolder}/build/homepage.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/main.xsl)

  execute_process(COMMAND ${XALAN} ${XALAN_VALIDATE_OPTION} ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/index.html ${XALAN_INFILE_OPTION} ${docBuildFolder}/build/homepage.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/main.xsl)



 # This folder just gets copied as-is

 # Note: Schemas are referenced inside the application xml files. The schema URI inside the xmls do not have version numbers in the path
@@ -175,9 +175,6 @@ function(build_documents_folder) 
  message("    Building table of contents files...")

  # These go in top level folders in /doc/



  # ABOUT ISIS TOC

  execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/AboutIsis/index.html   ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/AboutIsis.xsl)



  # GENERAL TOC

  execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/General/index.html ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/General.xsl)

isis/src/docsys/build/AboutIsis.xsl

deleted100644 → 0
+0 −291
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<xsl:stylesheet version="1.0" 

    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 

    xmlns:fo="http://www.w3.org/1999/XSL/Format" 

    exclude-result-prefixes="xmlns fo">



<!--



This stylesheet will be used to generate the main TOC for the "About Isis" page



Author

Deborah Lee Soltesz

12/05/2002



-->



  <xsl:output 

    media-type="text/html" 

    doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"

    doctype-system="http://www.w3.org/TR/html4/loose.dtd"

    indent="yes"

    encoding="utf-8"

    omit-xml-declaration="yes"/>



  <xsl:include href="menu.xsl"/>





  <xsl:key name="categoryMatch" match="/tableofcontents/document" use="category/categoryItem"/>

  <xsl:key name="audienceMatch" match="/tableofcontents/document" use="audience/target"/>



  <xsl:template match="/">

     <xsl:apply-templates select="tableofcontents" />

  </xsl:template>





  <xsl:template match="tableofcontents">

    <html>

      <head>

        <title>

            USGS Isis: About Isis

        </title>

        <meta name="keywords" content="about, overview, introduction, Isis, image processing, software, open source, remote sensing, planetary science, astrogeology"/>

        <meta name="description" content="About the Integrated Software for Imagers and Spectrometers (ISIS), created and managed by the USGS Astrogeology Research Program. ISIS provides a comprehensive, user-friendly, portable tool for processing, analyzing, and displaying remotely sensed image data."/>

        <meta name="publisher" content="USGS - GD - Astrogeology Program"/>

        <meta name="author" content="Deborah Lee Soltesz, webteam@astrogeology.usgs.gov"/>

        <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

        <meta name="country" content="USA"/>

        <meta name="state" content="AZ"/>

        <meta name="county" content="Coconino"/>

        <meta name="city" content="Flagstaff"/>

        <meta name="zip" content="86001"/>



        <link rel="stylesheet" href="../assets/styles/IsisStyleCommon.css"/>

        <link rel="stylesheet" href="../assets/styles/main.css"/>

        <link rel="stylesheet" href="../assets/styles/menu.css"/>

        <link rel="stylesheet" media="print" href="../assets/styles/print.css"/>

        <!-- Dynamic analytics insertion to prevent running on local URLs -->

        <xsl:text>&#xa;</xsl:text>

        <script type="text/javascript">

          //<xsl:comment><![CDATA[

          (function() {

            var usgsAnalytics = document.createElement('script');

            usgsAnalytics.type = 'text/javascript';

            usgsAnalytics.async = true;

            usgsAnalytics.src = 'http://www.usgs.gov/scripts/analytics/usgs-analytics.js';

            if('http:' == document.location.protocol) {

              var s = document.getElementsByTagName('script')[0];

              s.parentNode.insertBefore(usgsAnalytics, s);

            }

          })(); 

          ]]></xsl:comment>

        <xsl:text>&#xa;</xsl:text>

        </script>

      </head>



      <body>



        <div class="isisMenu">

         <xsl:call-template  name="writeMenu"/>

        </div>



        <div class="isisContent">



        <a href="http://www.usgs.gov">

        <img src="../assets/icons/littleVIS.gif" width="80" height="22" border="0" alt="USGS"/></a><br/>





        <p style="margin-top:10px; padding-bottom:0px;">

        ISIS Documentation</p>



        <hr/>





        <table width="100%" cellpadding="0" border="0" cellspacing="0">

          <tr valign="top">

            <td align="left">

              <h1>

                ABOUT ISIS

              </h1>

            </td>

            <td align="right" class="caption">

            <a href="../index.html">Home</a>

            </td>

          </tr>

        </table>





<!-- tables of links to documentation -->



      <table class="tableTOC">

      <xsl:for-each select="//document[normalize-space(category/categoryItem) = 'about' and

                                       normalize-space(category/categoryItem) != 'hidden' and

                                       (normalize-space(audience/target) != 'user' or

                                        normalize-space(audience/target) != 'all')]">

        <xsl:sort order="ascending" select="normalize-space(title)"/>

        <xsl:apply-templates mode="singleColumn" select="."/>

      </xsl:for-each>

      </table>







<!-- FOOTER -->

<script type="text/javascript" language="JavaScript" src="../assets/scripts/footer.js"></script>

</div>





      </body>

    </html>



  </xsl:template>















<!-- ***************************-->

<!-- SINGLE COL TABLE DOC ENTRY -->



  <xsl:template match="document" mode="singleColumn">

                    <xsl:choose>



                      <!-- if there is only one file in the set -->

                      <xsl:when test="count(files/file) = 1">

                        <tr valign="top">

                          <th style="width:25%">

                            <xsl:variable name="docName" select="normalize-space(title)"/>

                            <xsl:variable name="docSrc"  select="normalize-space(files/file/source)"/>

                            <a href="{$docSrc}">

                            <xsl:value-of select="$docName"/></a>

                          </th>

                          <td>

                            <xsl:if test="files/file/size">

                            (<xsl:value-of select="files/file/type"/>, <xsl:value-of select="files/file/size"/>)

                            </xsl:if>

                            <xsl:value-of select="brief"/><br/>

                          </td>

                        </tr>

                      </xsl:when>



                      <!-- if there are multiple files in the set -->

                      <xsl:otherwise>

                        <xsl:for-each select="files/file">



                          <!-- look for the primary file and print table row -->

                          <xsl:if test="@primary = 'true'">



                            <tr valign="top">

                              <th style="width:25%">

                                <!-- link to the primary file -->

                                <xsl:variable name="docName" select="normalize-space(../../title)"/>

                                <xsl:variable name="docSrc"  select="normalize-space(source)"/>

                                <a href="{$docSrc}">

                                <xsl:value-of select="$docName"/></a>

                              </th>

                              <td>

                                <xsl:if test="size">

                                (<xsl:value-of select="type"/>, <xsl:value-of select="size"/>)

                                </xsl:if>



                                <xsl:value-of select="../../brief"/><br/>



                                  <!-- add links to secondary documents (e.g. chapters) -->

                                  <xsl:for-each select="../../files/file">

                                    <xsl:if test="@primary != 'true'">

                                      <xsl:choose>

                                        <xsl:when test="subtitle">

                                          <xsl:variable name="docName" select="normalize-space(subtitle)"/>

                                          <xsl:variable name="docSrc"  select="normalize-space(source)"/>

                                          <a href="{$docSrc}" style="font-size:80%; font-style:italic;">

                                          <xsl:value-of select="$docName"/></a>

                                        </xsl:when>

                                        <xsl:otherwise>

                                          <xsl:variable name="docName" select="type"/>

                                          <xsl:variable name="docSrc"  select="normalize-space(source)"/>

                                          <a href="{$docSrc}" style="font-size:80%; font-style:italic;">

                                          <xsl:value-of select="$docName"/></a>

                                        </xsl:otherwise>

                                      </xsl:choose>

                                      <xsl:if test="position() != last()"> | </xsl:if>

                                    </xsl:if>

                                  </xsl:for-each>

                              </td>

                            </tr>



                          </xsl:if>

                        </xsl:for-each>

                      </xsl:otherwise>



                    </xsl:choose>



  </xsl:template>







<!-- ***************************-->

<!-- MULTI COL TABLE DOC ENTRY -->



  <xsl:template match="document" mode="multiColumn">

        <!-- developer documents -->

                    <xsl:choose>



                      <!-- if there is only one file in the set -->

                      <xsl:when test="count(files/file) = 1">

                          <p>

                            <xsl:variable name="docName" select="normalize-space(title)"/>

                            <xsl:variable name="docSrc"  select="normalize-space(files/file/source)"/>

                            <a href="{$docSrc}">

                            <xsl:value-of select="$docName"/></a><br/>



                            <xsl:value-of select="brief"/><br/>

                            <xsl:if test="files/file/size">

                              (<xsl:value-of select="files/file/type"/>, <xsl:value-of select="files/file/size"/>)

                            </xsl:if>

                          </p>

                      </xsl:when>



                      <!-- if there are multiple files in the set -->

                      <xsl:otherwise>

                        <xsl:for-each select="files/file">



                          <!-- look for the primary file and print table row -->

                          <xsl:if test="@primary = 'true'">



                              <p>

                                <!-- link to the primary file -->

                                <xsl:variable name="docName" select="normalize-space(../../title)"/>

                                <xsl:variable name="docSrc"  select="normalize-space(source)"/>

                                <a href="{$docSrc}">

                                <xsl:value-of select="$docName"/></a>



                                <xsl:if test="size">

                                  (<xsl:value-of select="type"/>, <xsl:value-of select="size"/>)<br/>

                                </xsl:if>



                                <xsl:value-of select="../../brief"/><br/>



                                  <!-- add links to secondary documents (e.g. chapters) -->

                                  <xsl:for-each select="../../files/file">

                                    <xsl:if test="@primary != 'true'">

                                      <xsl:choose>

                                        <xsl:when test="subtitle">

                                          <xsl:variable name="docName_Subtitle" select="normalize-space(subtitle)"/>

                                          <xsl:variable name="docSrc_Subtitle"  select="normalize-space(source)"/>

                                          <a href="{$docSrc_Subtitle}" style="font-size:80%; font-style:italic;">

                                          <xsl:value-of select="$docName_Subtitle"/></a>

                                        </xsl:when>

                                        <xsl:otherwise>

                                          <xsl:variable name="docName_Type" select="type"/>

                                          <xsl:variable name="docSrc_Type"  select="normalize-space(source)"/>

                                          <a href="{$docSrc_Type}" style="font-size:80%; font-style:italic;">

                                          <xsl:value-of select="$docName_Type"/></a>

                                        </xsl:otherwise>

                                      </xsl:choose>

                                      <xsl:if test="position() != last()"> | </xsl:if>

                                    </xsl:if>

                                  </xsl:for-each>

                              </p>



                          </xsl:if>

                        </xsl:for-each>

                      </xsl:otherwise>



                    </xsl:choose>



  </xsl:template>





</xsl:stylesheet>

isis/src/docsys/build/UserInspire.xsl

+45 −19
Original line number Diff line number Diff line
@@ -121,11 +121,12 @@ Deborah Lee Soltesz 
        <tr valign="top">

          <th style="width:25%">

            <a href="https://youtu.be/rxb5_Q0xrqI?t=5040">

            A New Approach to Create Image Control Networks in ISIS

            </a>

          </th>

          <td>

          A presentation given by Kris Becker concerning the motivation and work done to create the <i>findfeatures</i> application. Coresponding abstract 

          can be found <a href="https://www.hou.usra.edu/meetings/planetdata2017/pdf/7133.pdf">here</a>

            A presentation given by Kris Becker concerning the motivation and work done to create the <i>findfeatures</i> application. The corresponding abstract 

            can be found <a href="https://www.hou.usra.edu/meetings/planetdata2017/pdf/7133.pdf">here</a>.

          </td>

        </tr>

        <tr valign="top">
@@ -134,7 +135,8 @@ Deborah Lee Soltesz 
            Using the Community Sensor Model with Planetary Data</a>

          </th>

          <td>

          A talk given by Jesse Mapel at the OpenPlanetary Lunch

            A talk given by Jesse Mapel at the OpenPlanetary Lunch covering the Community Sensor Model API and the USGS ASC's implementation of it and 

            supported cameras as of October 2021.

          </td>

        </tr>

      </table>
@@ -176,34 +178,58 @@ Deborah Lee Soltesz 
      </xsl:if>

-->



<!-- Papers -->

<!-- Papers and Posters -->

    <hr/>

    <h2>Papers</h2>

      <p>

        These documents will take you through a small tutorial to get you running your first few applications and explain some of the basics of ISIS. 

        They will also give you a brief introduction to the planetary data ecosystem and how you can find data to process in ISIS.

      </p>

    <h2>Papers and Posters</h2>

      <table class="tableTOC">



        <!-- hardcoded links -->

        <tr valign="top">

          <th style="width:25%">

            <a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Introduction_to_ISIS">

            Introduction to ISIS</a>

          <th style="width:35%">

            <a href="https://www.hou.usra.edu/meetings/lpsc2018/pdf/2538.pdf">

            Production of New Clementine UVVIS Map Products Tied to the LRO Reference Frame</a>

          </th>

          <td>

          ISIS is typically run through the command-line interface (CLI) or a graphical user interface (GUIs). All application have GUIs, but not all 

          application can be entirely run from the command line. The interactive ISIS applications are GUI only and are used to visualize and edit 

          specialized data, these applications all start with “q” (”qview”, “qmos”, etc.).

          In the production of the new product, the LROC team leveraged ISIS to ingest and calibrate the Clementine image as well as used the <i>findfeatures</i> 

          application to automatically generate control points in their registration process.

          </td>

        </tr>

        <tr valign="top">

          <th style="width:25%">

            <a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/Locating_and_Ingesting_Image_Data">

            Locating and Ingesting Image Data</a>

          <th style="width:35%">

            <a href="https://www.isprs-ann-photogramm-remote-sens-spatial-inf-sci.net/I-4/203/2012/isprsannals-I-4-203-2012.pdf">

            Jigsaw: The ISIS3 Bundle Adjustment for Extraterrestrial Photogrammetry</a>

          </th>

          <td>

            One of the original authors of the <i>jigsaw</i> application describes the sparse matrix method of the photogrammetric bundle implemented in the 

            <i>jigsaw</i> application.

          </td>

        </tr>

        <tr valign="top">

          <th style="width:35%">

            <a href="https://www.hou.usra.edu/meetings/lpsc2014/eposter/1915.pdf">

            Photometric Control of Oblique Apollo 15 Metric Camera Images</a>

          </th>

          <td>

            Assessing the capabilities of the ISIS software to photometrically and geodetically control oblique images from the Apollo Metric Camera (MC) data set.

          </td>

        </tr>

        <tr valign="top">

          <th style="width:35%">

            <a href="https://www.hou.usra.edu/meetings/lpsc2014/pdf/2892.pdf">

            Automated and Accurate: Making DTMs from LRO-NAC using the Ames Stereo Pipeline</a>

          </th>

          <td>

            Outline of the ISIS and ASP commands used by the LROC team to generate automated Digital Terrain Models (DTMs).

          </td>

        </tr>

        <tr valign="top">

          <th style="width:35%">

            <a href="https://agupubs.onlinelibrary.wiley.com/doi/pdfdirect/10.1029/2007JE003000">

            Ultrahigh resolution topographic mapping of Mars with MRO HiRISE stereo images: Meter-scale slopes of candidate Phoenix landing sites</a>

          </th>

          <td>

          Descritpionnnn, description!

            An analysis of candidate landing sites for the Phoenix mission in which ISIS helped calibrate and rectify images from the Mars Global Surveyor 

            (MGS) Mars Orbiter Camera (MOC) and Mars Reconnaissance Orbiter (MRO) High Resolution Imaging Science Experiment (HiRISE) instruments.

          </td>

        </tr>

      </table>

isis/src/docsys/build/homepage.xml

+1 −1
Original line number Diff line number Diff line
@@ -48,7 +48,7 @@ 
          and analysis of derived data products.  By using ISIS, missions can

          leverage millions of dollars of software development that NASA has paid

          for.  However, before the power of ISIS can be applied to an instrument,

          a camera model and custom programs to ingest mission-specific ancillary

          a camera model, and custom programs to ingest mission-specific ancillary

          data are necessary.  Once an instrument is added to ISIS, it can support

          data processing pipelines, radiometric calibration, photometric

          calibration, band-to-band registration of multispectral data,

isis/src/docsys/build/menu.xsl

+25 −14
Original line number Diff line number Diff line
@@ -23,40 +23,51 @@ Deborah Lee Soltesz 
      Home</a>

    </div>





    <hr/>

    <h2>

      User Documentation

    </h2>



    <div>

      <a href="{$menuPath}UserStart/index.html" target="_top">

      Getting Started</a>

    </div>



    <div>

      <a href="{$menuPath}AboutIsis/index.html" target="_top">

      About ISIS</a>

      <a href="{$menuPath}UserLearn/index.html" target="_top">

      Learn More</a>

    </div>



    <div>

      <a href="https://github.com/USGS-Astrogeology/ISIS3/issues" target="_blank" title="Launch the ISIS Support Center in a new window">

      Support</a>

      <a href="{$menuPath}UserExplore/index.html" target="_top">

      Explore in Detail</a>

    </div>



    <div>

      <a href="{$menuPath}Installation/index.html" target="_top">

      Download</a>

      <a href="{$menuPath}UserInspire/index.html" target="_top">

      Get Inspired</a>

    </div>





    <hr/>

    <h2>

      ISIS

      Contributor Documentation

    </h2>



    <div>

      <a href="{$menuPath}UserDocs/index.html" target="_top">

      Documentation</a>

      <a href="{$menuPath}DevStart/index.html" target="_top">

      Getting Started</a>

    </div>



    <!-- Isis Workshop is only available on the website  -->

    <div>

      <a href="https://github.com/USGS-Astrogeology/ISIS3/wiki/ISIS_Online_Workshops" target="_blank" title="Launch ISIS Workshop in a new window">

      Tutorials</a>

      <a href="{$menuPath}DevExplore/index.html" target="_top">

      Explore in Detail</a>

    </div>



    <div>

      <a href="{$menuPath}TechnicalInfo/index.html" target="_top">

      Technical Documents</a>

      <a href="{$menuPath}DevInspire/index.html" target="_top">

      Get Inspired</a>

    </div>