HUML

https://huml.io
Admin
HUML is a human-oriented markup language that prioritizes strict form and human-readability for...
Tokens:4,995
Snippets:52
Trust Score:5.5
Update:7 months ago
Show doc for...
Tokens:
Raw
### HUML Configuration Syntax Example

Source: https://huml.io/example

A comprehensive example demonstrating HUML syntax, including nested dictionaries, lists, numeric types (hex, octal, binary), and multi-line string handling. This configuration serves as the root dictionary for the HUML Showcase Suite application.

```huml
application_config::
  application_name: "HUML Showcase Suite"
  version: "1.0.0-beta"
  environment: "development"
  debug_mode: true
  retry_attempts: 5
  timeout_seconds: 30.5
  inline_list:: 1, 2, 3, "test"
  feature_flags::
    new_dashboard_enabled: true
    user_experiment_ab: false
    "legacy-system.compatibility_mode": true

  contact_points::
    - ::
      type: "admin"
      email: "admin@example.com"
      phone: null
    - ::
      type: "support"
      email: "support@example.com"
      availability::
        weekdays: "9am - 6pm"
        weekends: "10am - 2pm"

  numerical_data::
    integer_val: 1_234_567
    float_val: -0.00789
    scientific_notation_val: 6.022e23
    hex_val: 0xCAFEBABE
    octal_val: 0o755
    binary_val: 0b11011001
    empty_integer_list:: []
    empty_mapping:: {}

  string_examples::
    simple_greeting: "Hello, \"Universe\"!"
    path_example: "C:\\Users\\Default\\Documents"
    multiline_preserved_poem: """

      First line
           Second
        Third Line
    """
    multiline_stripped_script: """
          First line
          Second line
          Third line
    """
```

--------------------------------

### Vector Examples using `::` in huml

Source: https://huml.io/specifications/v0-2-0

Provides practical examples of using the `::` indicator for vectors in huml, demonstrating inline and multi-line lists and dictionaries. This syntax aims for clarity and avoids ambiguity.

```huml
# Inline list: [1, 2, 3, "four"]
foo:: 1, 2, 3, "four"

# Inline dict: {"foo": {"bar": "baz", "one": 1}}
foo:: bar: "baz", one: 1

# Multi-line list
foo::
  - 1
  - 2
  - 3

# Multi-line dict
foo::
  bar: "baz"
  one: 1

```

--------------------------------

### HUML Comments and Inline Comments Example

Source: https://huml.io/specifications/v0-2-0

Demonstrates how to use comments in HUML. Lines starting with '#' are comments. Inline comments are allowed after a value, separated by '#'. Comments must be preceded by at least one space after the '#' marker.

```HUML
# Comment-only line
key: "value"         # Inline comment with many preceding spaces.

```

--------------------------------

### HUML Configuration Syntax Example

Source: https://huml.io/home

A sample HUML document demonstrating key features including hostname definition, inline lists, inline dictionaries, multi-line lists, and multi-line string blocks.

```huml
website::
  hostname: "huml.io"
  ports:: 80, 443
  enabled: true
  factor: 3.14
  props:: mime_type: "text/html", encoding: "gzip"
  tags::
    - "markup"
    - "webpage"
    - "schema"

haikus::
  one: """
    A quiet language
    Lines fall into their places
    Nothing out of place
  """
```

--------------------------------

### HUML Document Structure Example

Source: https://huml.io

This snippet demonstrates the core syntax of HUML, including key-value pairs, inline lists, inline dictionaries, multi-line lists, and multi-line string blocks. It highlights the language's focus on clear hierarchy and strict formatting.

```huml
# A sample HUML document.
website::
  hostname: "huml.io"
  ports:: 80, 443 # Inline list.
  enabled: true
  factor: 3.14
  props:: mime_type: "text/html", encoding: "gzip" # Inline dict.
  tags:: # Multi-line list.
    - "markup"
    - "webpage"
    - "schema"

haikus::
  one: """
    A quiet language
    Lines fall into their places
    Nothing out of place
  """
```

--------------------------------

### HUML Scalar Data Types Example

Source: https://huml.io/specifications/v0-2-0

Illustrates the basic scalar data types supported in HUML: strings, numbers, booleans, and null. Scalar values are denoted by a single colon after the key.

```HUML
key: "value"
number: 123
boolean: true
type: null

```

--------------------------------

### Multi-line String Formatting

Source: https://huml.io/specifications/v0-2-0

Demonstrates the use of multi-line strings in huml_io, where content is treated literally and indentation defines the block. The opening `"""` must follow the key with a single space, and the closing `"""` aligns with the key's indentation.

```huml
description: """
  Line 1
   Line 2
    Line 3
          All spaces are preserved.
"""

```

--------------------------------

### Define HUML Application Configuration

Source: https://huml.io/specifications/v0-2-0

Demonstrates the primary configuration structure for the HUML Showcase Suite. It includes nested dictionaries, feature flags, and contact information using various data types.

```huml
application_config::
  application_name: "HUML Showcase Suite"
  version: "1.0.0-beta"
  environment: "development"
  debug_mode: true
  feature_flags::
    new_dashboard_enabled: true
    "legacy-system.compatibility_mode": true
  contact_points::
    - ::
      type: "admin"
      email: "admin@example.com"
      phone: null
```

--------------------------------

### Data Serialization in HUML and JSON

Source: https://huml.io/playground

Demonstrates the conversion of a complex data object between HUML and JSON formats. It covers key-value pairs, nested dictionaries, inline lists, and multi-line string handling.

```HUML
website::
  hostname: "huml.io"
  ports:: 80, 443
  enabled: true
  factor: 3.14
  props:: mime_type: "text/html", encoding: "gzip"
  tags::
    - "markup"
    - "webpage"
    - "schema"

mixed_list:: 1, 2, "three", true

haikus::
  one: """
    A quiet language
    Lines fall into their places
    Nothing out of place
  """
```

```JSON
{
  "website": {
    "hostname": "huml.io",
    "ports": [80, 443],
    "enabled": true,
    "factor": 3.14,
    "props": {
      "mime_type": "text/html",
      "encoding": "gzip"
    },
    "tags": ["markup", "webpage", "schema"]
  },
  "mixed_list": [1, 2, "three", true],
  "haikus": {
    "one": "A quiet language\nLines fall into their places\nNothing out of place"
  }
}
```

--------------------------------

### Define Empty Collections in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates the syntax for defining an empty dictionary or an empty list at the root level.

```huml
{}
[]
```

--------------------------------

### Define Inline List Root in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates an inline list at the root of a HUML document. No nesting or additional keys are allowed.

```huml
1, 2, "three"
```

--------------------------------

### Implement Complex Nested Collections

Source: https://huml.io/specifications/v0-2-0

Illustrates the use of inline collections and nested server node definitions. This highlights the flexibility of HUML in representing lists of dictionaries and complex metadata.

```huml
inline_collections::
  simple_list:: "red", "green", "blue"
  points_of_interest::
    - :: x: 10, y: 20, label: "Start"

server_nodes::
  - ::
    id: "node-alpha-001"
    roles:: "web", "api"
    config_file_content: """
      port = 8080
      threads = 16
    """
```

--------------------------------

### Define String Root in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates a HUML document evaluated as a string. The document must contain only this value.

```huml
"Hello, world"
```

--------------------------------

### Define Block List Root in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates a block-style list at the root of a HUML document. No additional data is permitted outside the list elements.

```huml
- 1
- 2
- "three"
```

--------------------------------

### List Representations in huml

Source: https://huml.io/specifications/v0-2-0

Illustrates various ways to define lists (vectors) in huml, including inline, multi-line, nested, and empty lists. Inline lists are comma-separated scalars, while multi-line lists use hyphens and support nesting.

```huml
inline_list:: 1, 2, "three"

multiline_list::
  - 1
  - 2
  - "three"

nested_list::
  - 1
  - 2
  - "three"
  - ::
    - 1
    - 2
    - "three"

list_of_dicts::
   - ::
     one: 1
     foo: "bar"
   - ::
     two: 2
     foo: "baz"

empty_list:: []

```

--------------------------------

### Define Nested Dictionary Root in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates a dictionary at the root that allows for further nested keys and complex data types.

```huml
foo: 1
bar: "two"
baz::
  foo: "child"
```

--------------------------------

### Represent Numeric and String Data in HUML

Source: https://huml.io/specifications/v0-2-0

Showcases the handling of various numeric formats including scientific notation, hex, octal, binary, and special floating point values. Also demonstrates multiline string preservation and escaped characters.

```huml
numerical_data::
  integer_val: 1_234_567
  scientific_notation_val: 6.022e23
  hex_val: 0xCAFEBABE
  infinity_positive: +inf
  not_a_number: nan

string_examples::
  simple_greeting: "Hello, \"Universe\"!"
  multiline_preserved_poem: """
    The HUML spec, so clear and bright,
      Makes data shine with pure delight.
  """
```

--------------------------------

### Define Inline Dictionary Root in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates an inline dictionary at the root of a HUML document. No further nesting is permitted for this structure.

```huml
foo: 1, bar: "two"
```

--------------------------------

### Dictionary Representations in huml

Source: https://huml.io/specifications/v0-2-0

Shows how dictionaries (vectors) are defined in huml, covering inline, multi-line, nested, and empty formats. Inline dictionaries use comma-separated key-value pairs, while multi-line dictionaries indent pairs and support nesting.

```huml
inline_dict:: one: 1, foo: "bar"

multiline_dict::
  one: 1
  foo: "bar"

nested_dict::
  one: 1
  foo: "bar"
  nested::
    two: 2
    foo: "baz"

empty_dict:: {}

```

--------------------------------

### Define Boolean Root in HUML

Source: https://huml.io/specifications/v0-2-0

Demonstrates a HUML document evaluated as a boolean true. No additional data is permitted after the initial value.

```huml
true
```

--------------------------------

### List Representation Ambiguity Avoidance with `::` in huml

Source: https://huml.io/specifications/v0-2-0

Highlights how the `::` indicator in huml prevents parsing ambiguities common in other formats like YAML, particularly with comma-separated values and nested structures. It clarifies intent for both lists and dictionaries.

```huml
# This is a list with one item: key = ["one"]
key:: "one"

# Without :: it is not possible to represent an inline list
# without an enclosure such as [ ... ]. For example, key: ["one"]
# Here, key = "one"
key: "one"

```
Tokens:
Raw