Appendix C: Editing The T.N.

Notes regarding the construction and structure of this document:

  • The original version is ProcessingAlgorithms.lyx, which needs ’LyX’, a user interface to TeX. It is available on EOL machines like tikal. Start it with “lyx ProcessingAlgorithms.lyx”. This version was last updated in Feb 2019. It can be obtained from the GitHub site. Copy this to an RStudio project file to use this version.
  • A revised version is written in RMarkdown to facilitate editing by others. It provides an HTML version of the document suitable for hosting on web servers. To obtain this version, download this repository. This works best if output: bookdown::gitbook is selected. Download this branch to an RStudio project directory and use the “knit” button to construct the web site. The output will be html files that can be moved from there to a web server. The directories “assets” and “www” should also be transferred; the former contains CSS files and the latter some memos that are referenced in the document. For example, if the web server delivers files from /var/www/html, make a new directory there called “ProcessingAlgorithms” and move all .html files and those two directories to “ProcessingAlgorithms”. Then view the document via http://URL/ProcessingAlgorithms where URL is the appropriate reference for your web files.
    • The R Markdown files have a mix of conventions including HTML, LaTeX formulas, and R Markdown conventions. At some point, it may be useful to become more consistent, e.g., by changine HTML references to R Markdown reference, changing HTML italics to R Markdown italics, changing table structures from HTML to R Markdown kable format, etc.
    • The R Markdown files can produce a PDF file, but many features available in the HTML files will not be available, at least at present. PDF files can always be produced by printing from a web browser.
  • The document is broken into many sections, referenced by the above file, so they must be present also. In the lyx version they have names like Section3.lyx. In the Rmd version, they reside as, e.g., Section3.Rmd in the “Children” directory.
  • The lyx document generates three indices: a regular index, a list of symbols, and a list of variables. The references for these are embedded in the .lyx files, and they can be modified or more can be added via the “Insert -> Index Entry” controls. These practices are useful when generating index entries:

    • entries like ’wind!relative’ will generate index entries as subordinate entries with ’relative’ below ’wind’. In the Rmd version, the index is not generated automatically but the existing links should remain valid as the text is changed. To add a variable, use a subsection or subsubsection entry and identify a label by following the heading with {#newlabel}. Then follow the pattern in the existing index to add an entry for the new term. Also add a similar link to the list of variables in Appendix B.

    • I have tried to emphasize using nouns to start index entries, so for example I would favor “coefficient!calibration” over “calibration coefficient.

    • It is sometimes useful to generate “see xxx” entries, which can be done as follows in the LyX version: “INS|see {Inertial Navigation System}” where the part in braces is also in LaTeX code, generated by pressing CNTL-L.

  • Creating a PDF-format file in LyX usually will generate these lists also.
  • The LyX files have embedded notes with additional information that should be retained, and exporting to LaTeX will lose this information, so it will be useful to retain the LyX format. The suggested next steps in the table above, for example, almost all have associated notes that will appear in yellow and will help identify where the comment applies.
  • It is sometimes easiest to edit the PDF file directly. Some of the web references have been changed in this way and can be adjusted as the reference files are moved, e.g., from my Google Drive to the EOL web pages. For this purpose, I found master-pdf-editor useful. This will lose continuity, however, because then the links can’t be re-generated by running LyX.
  • As of Feb 2019, many links formerly to google-drive addresses or eol system files have been changed to https://github.com/NCAR/aircraft_ProcessingAlgorithms links. In that directory there is a file (’links’) with a list of all the links in the document. It is worthwhile when updating this document to check that all the links remain current. One way is to use these R statements and then check EURL to see that the links are all found:
    links <- readlines(’./links’); EURL <- rep(FALSE, length(links));
    for (i in 1:length(links)) {EURL<- RCurl::url.exists(links[i])}
  • For the Rmd version:
    • In place of the Table of Symbols, there is Appendix A. It is a .gif copy of the LyX-generated table, and there is no easy way to update it except vis LyX.
    • In place of the “Variable Names” index, there is Appendix B that lists the variable names and includes links to appropriate references to variables in the technical note. This is not generated automatically, so when a new variable is added to the document a new entry with appropriate links should be added to Appendix B. Follow the style in “Children/Appendices.Rmd” and add an appropriate target for the link to the new discussion of the variable, which should be a 4th-level or higher heading.

Referencing Specific Sections or Pages of this Document (LyX version):

Variables

The document includes named destinations for each variable name, so when used in a URL that destination can be reached. This is done differently in different browsers or PDF viewers:

Most variable names can be used in these URL modifiers. Here is a list of available targets by section in the report:

Section 1: Time

Section 2: [none]

Section 3: ACINS ALT BLATA BLONA BNORMA BPITCHR BROLLR BYAWR DEI DNI FXAZIM FXDIST GGALT GGLAT GGLON GGNSAT GGOIDHT GGSPD GGSTATUS GGTRK GGVEW GGVNS GGVSPD GGWUAL GMODE GSF HGM HGM232 HGME HI3 LAT LATC LON LONC PALT PITCH ROLL THDG VEW VEWC VNS VNSC VSPD

Section 4: ADIFR AKRD AT_ITR ATx ATX ATxD ATxJ BDIFR CAVP_x CONCH_UVH CONCV_VXL DP_CR2C DP_VXL DPx DP_x DPxC DPXC DVALUE EDPC EW_UHV EWx EWX FP_CR2 MACHx MACHX MIRRORT_CR2 MIRRTMP_DPX MR MRCR MRLA MRLH MRVCL OAT PCAB PS_A PSDPx PSFD PSFRD PSURF PSx PSX PSxC PSXC QCx QCX QCxC QCXC RAWCONC_VXL RHOx RHUM RHUMI RTHRx RTx RTX RTxH SPHUM SSLIP TASHC TASx TASX TASxD THETA THETAE THETAP THETAQ THETAV TVIR UI UIC UX UXC VI VIC VY VYC WD WDC WI WIC WS WSC XSIGV_UHV

Section 5: A1DC A1DP A200X A200Y A260X ACDP AF300 AFSSP APCAS AS100 AUHSAS C1DC C1DP C200X C200Y C260X CCDP CF300 CFSSP COMCP CONC1DC CONC1DC100 CONC1DC150 CONC1DP CONC3 CONC6 CONCD CONCF CONCU CONCX CONCY CPCAS CS100 CUHSAS DBAR1DC DBAR1DP DBAR3 DBAR6 DBARD DBARF DBARP DBARU DBARX DBARY DBZ DBZ1DC DBZ1DP DISP1DC DISP1DP DISP3 DISP6 DISPD DISPF DISPP DISPU DISPX DISPY DT1DC FRANGE FRNG PLWC1 PLWC1DC PLWC1DP PLWC6 PLWCC PLWCC1 PLWCD PLWCF PLWCG PLWCX PLWCY REFF2DC REFF2DP REFFD REFFF RICE

Section 6: CO2_PIC COMR_AL CORAW_AL FO3_ACD FO3_CL O3MR_CL TEO3 TEO3C TEO3P TEP TET XFO3FNO XFO3FS XFO3P XNCLF XNMBT XNO XNOCAL XNOCF XNOSF XNOY XNOYP XNOZA XNSAF XNST XNYCAL XNZAF XO3

Section 7: CNTEMP CNTS CONCN CONCP CONCU CONCU100 CONCU500 FCN FCNC PCN PFLW PFLWC TCHTP TCNTL TEMP1 TEMP2 UPRESS USFLWC USMPFLW XICN XICNC

Section 8: IRxHT IRxV RSTx SPxPitch SPxRoll TRSTx VISxC VISxHT VISxV

Section 9: [none]

Section 10: OBSOLETE

Page Numbers (LyX Version)

To reference a specific page in the document, use a web reference like this:
ProcessingAlgorithms.pdf#page=44

In evince, this syntax will work, or the page number can be specified in this way:

evince -p 115 ProcessingAlgorithms.pdf

Sections and Subsections

Targets have not been provided for other parts of the document, but the above method of referencing pages can be used to link to specific sections and other components of the document.

Adding New Targets

When a new variable is added, a new anchor point can be added by inserting, in LaTeX mode, “\nop{LAT}” at the appropriate point in the LyX document. (“\nop” has been defined to use \hypertarget but displace the reference upward one line.) In addition, when a new variable is added, entries should be made in the index items and the variable-names list, following the pattern used for existing variables, and if appropriate any new symbols used in discussing the algorithm should be added to the similar symbols list.

Referencing Specific Sections of this Document (RMarkdown version):

Most discussions of variables are in subsubsubsections with appropriate labels, and those labels can be referenced as in the model provided by Appendix B.