Assigning VariablesĪ 'KEY' is assigned a 'VALUE' through a mapping which is signaled through a space-seperated colon. are used to specify the end of a YAML stream. Three dashes - are used in a YAML file to signal the start of the document. KEY5: VALUE5# or this comment are legal since there is no space separating the comment from the value Here's a few comments on comments.Ĭomments are indicated by a octothorpe (i.e., pound, hash, number sign, etc.) "#": # This line is a commentĬomments may appear anywhere in a line, even after a data declaration: KEY1: VALUE1 # A comment may follow an assignment, as long as it seperated by a space You'll likely see comments all over the sample YAML files. This intro contains information on the relevant formatting needed for the YAML Header file used by pycartt module. ICARTT header info is written in this file.
YAML HEADERįor more info on the ICARTT file format, check out the official description of the data format. just follow the advice about using soft-tabs. I'd recommend using a text editor that is capable of generating soft-tabs if you want to maintain functionality and a pretty layout when you edit your files. The sample YAML/ICARTT header found here was generated with soft-tabs (that is, space-characters).
If you want to force an assigment across multiple lines (for whatever reason) see the section below. Also use soft-wrapping to maintain long entries on a single line. However, you need to be careful about using tabs. YAML files are human-readable text files, so they can be edited in any text editor. What follows is a very brief introduction to YAML syntax that is used the YAML files which are the basis of generating ICARTT header information. YAML (YAML Ain't Markup Language) provides a nice way to create human-readable data-oriented files that are easily read using existing python packages (e.g., pyml).
0 kommentar(er)
