About JDox

JWST User Documentation, informally known as "JDox," is an agile, user-friendly source of information inspired by the Wikipedia style. Its goal is to provide focused, well-linked articles about the observatory and instruments, tools for proposing, advice on observing strategies, roadmaps for the proposal preparation process, and JWST data calibration and analysis. 

On this page

Navigating JDox

There are various methods to explore the JDox information, including:

  • Start from the JDox Home Page for easy visual access to key content inside and outside of JDox through an organized array of buttons/icons. To return to this location from anywhere else inside JDox, click the "Home" button in the menubar at the top of the page.

  • Use the sidebar on the left of the window that displays a hierarchy of all pages (note: this sidebar may not be visible if your browser window is too narrow, your font size is too large, or you are viewing using a phone or tablet; either widen the window, or click the Browse button at the top or bottom of the screen.) Items on a black background are subject headers (akin to books or chapters). Each item preceded by a bullet indicates an individual article, while an item preceded by ">" indicates a menu (akin to subsections) that can be expanded by clicking on it. Clicking on an individual article in the sidebar displays it in the main browser window.

  • Use the Search field in the menu bar at the top of the screen, which uses the Google search engine and its associated tools, to search for a particular topic within JDox. Then, in the search results listing, click the page that appears most likely to contain the desired information. If that page does not contain the desired information, then either: (a) choose a different page from the search results; or (b) scroll in the sidebar to find the location of the page that was suggested (it should be highlighted), and then look for nearby pages in the hierarchy that may be of more relevance. If neither works, then try to repeat the search with alternative search terms. (Note: You can, of course, also do searches for JWST information directly from a search engine in your browser, but that will explore and expose information outside of JDox, which may be outdated or unofficial.)

  • Use the Table of Contents page for a particular subject area. These can be accessed by clicking one of the black horizontal subject header bars in the sidebar. Some of the icons on the JDox Home Page also lead to these Table of Contents pages. A Table of Contents for all of JDox is available as well. These pages may be useful for locating a page with a known title, or for finding pages that have a particular keyword in the title (use the "Find" feature of your browser). 
     
  • Use the PDF button in the menu bar at the top of the screen to find the same content divided by topic in a set of distinct PDF files. This provides documentation in a format similar to traditional instrument handbooks. Within each PDF handbook, it is possible to search for words or topics using the standard features of your PDF viewer. Links within the document generally work by clicking on it, while those to other sections of JDox will open a browser window. Only minimal manual editing was done to these PDFs, so they look visually similar to what you would get by choosing "save as PDF" or "print" in your web browser. (Note: the PDF files should not be considered the official source of JWST documentation, because they may be outdated; they are generated as a courtesy roughly once a year, and updates to the content since those PDFs were generated will not be reflected in them.)     

Auxiliary pages

JDox contains a number of auxiliary pages with top-level or supporting information. These are not accessible from the sidebar, but can be navigated to either from the menu bar at the top of every JDox page, or using the buttons on the home page. For completeness, these pages are:

Additional linked documentation

Proposal Parameters

In addition to JDox User Documentation, a related collection of articles called Proposal Parameters contain technical documentation on legal values for each "field" (parameter) in the Astronomer's Proposal Tool (APT). These articles are not designed as a primary reference and not displayed on the left-hand navigation sidebar of the JDox site. However, some links in JDox may point to a Proposal Parameters article. If the article you are viewing is in the Proposal Parameters area, the left-hand sidebar will look different and the background color will change. Use your browser's back arrow or the JDox Home button to return to the primary JDox User Documentation area.

Read the Docs

Articles in the "Data" section of JDox provide high level information about JWST data calibration and analysis. Many JDox Data articles, especially in the JWST Science Calibration Pipeline section, contain links to detailed technical documentation maintained in Read the Docs. Again, the appearance of these pages and presence of a different sidebar will alert users that they are in a different documentation area. Use your browser's back arrow to return the the main JDox User Documentation site.

Usage of figures and images

Unless otherwise indicated, most figures and images were provided by STScI and NASA. These are covered by the Creative Commons (CC BY 4.0) license and may be used without permission. Where other attribution is provided, please contact the paper authors for permission to use their figures or images. If you identify any image or figure that is incorrectly credited, please contact the JWST Helpdesk to report it.

Additional details are provided at the STScI content use policy page



How to cite JDox

Citing the JWST User Documentation website:

In-text ref.: (JWST User Documentation, 2016-)

End reference: JWST User Documentation (JDox). Baltimore, MD: Space Telescope Science Institute; 2016- [access date in year month day]. https://jwst-docs.stsci.edu

For citation formats including BibTeX, AASTeX, MNRAS, Icarus, and XML, use the Astrophysics Data System (ADS) Export Citation selection from the left side menu within ADS: https://ui.adsabs.harvard.edu/abs/2016jdox.rept....../abstract

JDox content contributors

J. Aguilar, M. Alam, K. Alatalo, S. Alberts, C. Alves de Oliveira, T. Beck, P. Bennet, S. Birkmann, B. Blacker, W. Blair, T. Böker, M. L. Boyer, G. Brammer, S. Bright, B. Brooks, R. Brown, H. Bushouse, A. Canipe, A. Carter, L. Chambers, P. Chayer, C. Chen, B. Cherinka, M. Clarke, D. Coe, R. Cooper, M. Correnti, M. Cracraft, A. Deshpande, H. Diamond-Lowe, R. Diaz, R. Downes, N. Earl, N. Espinoza, H. Ferguson, P. Ferruit, J. Filippazzo,  P. Forshay, A. Fox, O. Fox, J. Fraine, S. Friedman, A. Fullerton, M. Garcia Marin, M. Gennaro, G. Giardino, R. Gicking, K. Gilbert, J. Girard, J. Goldberg, D. Golimowski, S. Gonzaga, K. Gordon, C. Gosmeyer, P. Goudfrooij, T. Greene, B. Hagan, A. Hamanowicz, J. Hargis, R. Hawkins, C. Hayes, A. Henry, B. Hilbert, D. Hines, S. Holfeltz, B. Holler, J. Hunkeler, B. James, A. Jones, G. Kanarek, D. Karakla, S. Kassin, S. Kendrew, T. Keyes, A. Koekemoer, N. Kumari, S. La Massa, K. Larson, D. Law, J. Lee, M. Libralato, P-L Lim, C. Lean, J. Leisenring, R. Levy, D. Long, M. López-Morales, J. Lotz, N. Lützgendorf , E. Manjavacas, R. van der Marel, A. Martel, C. Martlin, M. McDonald, J. V. Medina, L. McCuen, S. Milam, T. Morishita, A. Moro-Martin, K. Murray, J. Muzerolle, S. Neff, E. Nelan, B. Nickson, N. Nikolov, M. Oboryshko, P. Ogle, S. Osborne, C. Pacifici, T. Pauly, C. Pavlovsky, J. Pegues, M. Pena-Guerrero, M. Perrin, K. Peterson, A. Petric, N. Pirzkal, K. Pontoppidan, C. Proffitt, E. Puga, L. Pueyo, S. Ravindranath, T. Rawle, M. Regan, I. N. Reid, M. Ressler, A. Rest, A. Riedel, G. Rieke, M. Rieke, J. Rigby, C. Ritchie, M. Robberto, A. Roman, S. Rose, K. Rowlands, R. Ryan, J. Sahlmann, B. Sargent, P. Sessa, E. Schlawin, R. Shaw, M. Sirianni, A. Sivaramakrishnan, G. Sloan, D. Soderblom, S. T. Sohn, G. Sonneborn, I. Spitzer, J. Stansberry, K. Stevenson, L. Strolger, B. Sunnquist, J. Taylor, T. Temim, D. Thatte, E. Tollerud, L. Ubeda, J. Valenti, K. Volk, G. Wahlgren, L. Watkins, B. Williams, C. Willmer, I. Wong, E. Wislowski, B. York, P. Zeidler.

JDox project team

JDox Editorial Board
Shireen Gonzaga
Roeland van der Marel
Dean Hines (retired)

JDox IT Technologists
Paul Mulgrew
Hsing-Ying Liu
Stacy Smith
Matthew Bonnitt (previous)

JWST User Support Project Scientist
Patrick Ogle
William Blair (retired)

JDox Content and Technical Editors
Shireen Gonzaga (lead)
Susan Rose (retired)

JDox NASA Reviewers
Knicole Colon (lead)
Susan Neff
Stefanie Milam
Jane Rigby (previous)
George Sonneborn (previous)
Jonathan Gardner (previous)

Previous JDox Project leads
Alaina Henry
Ori Fox
Jennifer Lotz

Previous JDox Deputy Project Leads
Stephanie La Massa
Dan Coe
Dave Soderblom





Notable updates
  •  
    Section added on navigating JDox
Originally published