Oils ReferenceOSH | YSH | Data Notation

This reference has three tables of contents. They link to topics within 15 chapters.

(in progress)

Data Notation Table of Contents

  1. JSON / J8 Notation
  2. Errors

OSH Table of Contents - Compatible

YSH Table of Contents - New and Powerful

  1. Types and Methods
  2. Builtin Functions
  3. Builtin Commands
  4. Front End
  5. Command Language
  6. Standard Library
  7. OSH Assignment
  8. YSH Command Language Keywords
  9. Word Language
  10. YSH Expression Language
  11. Mini Languages
  12. Global Shell Options
  13. Special Variables
  14. Plugins and Hooks

Index

help command

When you type help in OSH or YSH, it shows a URL to this reference, or text extracted from it.

About

The source files for this reference are in Markdown:

REPO/
  doc/
    release-index.md     # /release/$VERSION/

    index.md             # All Docs on Oils, /release/$VERSION/doc/
    getting-started.md
    ...

    ref/
      index.md           # this page, the Oils Reference
      toc-osh.md         # OSH topics
      toc-ysh.md         # YSH topics
      toc-data.md        # Data language topics

      chap-cmd-lang.md   # chapter on the command language
      chap-front-end.md
      ...

The URLs mirror the source, with minor differences:

/release/$VERSION/
  index.html
  doc/
    index.html
    getting-started.html
    ...

    ref/
      index.html
      toc-osh.html
      toc-ysh.html
      toc-data.html

      chap-cmd-lang.html
      chap-front-end.html
      ...

You can link to topics with internal anchors:

Terminology

This reference has a 3-level structure:

  1. Chapter - A big HTML page.
  2. Section - An <h2> heading in a chapter
  3. Topic - An <h3> heading in a chapter.

More terminology:

Generated on Thu, 25 Jul 2024 23:38:53 +0000