Anyterial
Note: prerelease version v0.1, subject to change

Extended Hermann-Mauguin alias markups (property)

This page documents an OPTIMADE Property Definition. See https://schemas.optimade.org/ for more information.

ID: https://schemas.anyterial.se/defs/v0.1/properties/spacegroups/hm_extended_aliases_markup
Definition name: hm_extended_aliases_markup

Property name: Extended Hermann-Mauguin alias markups
Description: Display-oriented renderings corresponding element-by-element to the alternate extended Hermann-Mauguin symbols in hm_extended_aliases.
Type: list

The plain string values are stored in the corresponding unsuffixed alias list; this list only provides alternate markup forms for display.

Examples:

Formats: [JSON] [MD]

JSON definition:

{
    "$id": "https://schemas.anyterial.se/defs/v0.1/properties/spacegroups/hm_extended_aliases_markup",
    "$schema": "https://schemas.optimade.org/meta/v1.3/optimade/property_definition.json",
    "title": "Extended Hermann-Mauguin alias markups",
    "x-optimade-type": "list",
    "x-optimade-definition": {
        "kind": "property",
        "version": "0.1.0",
        "format": "1.3",
        "name": "hm_extended_aliases_markup",
        "label": "hm_extended_aliases_markup_spacegroups"
    },
    "x-optimade-unit": "inapplicable",
    "type": [
        "array",
        "null"
    ],
    "description": "Display-oriented renderings corresponding element-by-element to the alternate extended Hermann-Mauguin symbols in `hm_extended_aliases`.\n\nThe plain string values are stored in the corresponding unsuffixed alias list; this list only provides alternate markup forms for display.",
    "items": {
        "$id": "https://schemas.anyterial.se/defs/v0.1/properties/core/string_markups",
        "title": "String markups",
        "x-optimade-type": "dictionary",
        "x-optimade-definition": {
            "kind": "property",
            "version": "0.1.0",
            "format": "1.3",
            "name": "string_markups",
            "label": "string_markups_core"
        },
        "x-optimade-unit": "inapplicable",
        "type": [
            "object",
            "null"
        ],
        "description": "Strings with alternate markup and/or encoding for display rendering.\n\nThe object is intended for display-oriented variants only, a sibling property should be used for canonical plain string value.\n\n**Requirements/Conventions**:\n\n- It MUST be a dictionary with the following keys:\n\n    - **html**: OPTIONAL; String.\n      HTML rendering of the sibling string, using inline HTML elements where needed for typographic structure such as subscripts, superscripts, overlines, fractions, and line breaks.\n\n    - **latex**: OPTIONAL; String.\n      LaTeX rendering of the sibling string, suitable for use with a LaTeX or MathJax-like renderer.\n\n    - **unicode**: OPTIONAL; String.\n      Unicode rendering of the sibling string, using Unicode code points for display features where practical.",
        "properties": {
            "html": {
                "x-optimade-type": "string",
                "x-optimade-unit": "inapplicable",
                "type": [
                    "string",
                    "null"
                ],
                "description": "HTML rendering of the sibling string."
            },
            "latex": {
                "x-optimade-type": "string",
                "x-optimade-unit": "inapplicable",
                "type": [
                    "string",
                    "null"
                ],
                "description": "LaTeX rendering of the sibling string."
            },
            "unicode": {
                "x-optimade-type": "string",
                "x-optimade-unit": "inapplicable",
                "type": [
                    "string",
                    "null"
                ],
                "description": "Unicode rendering of the sibling string."
            }
        },
        "examples": [
            {
                "html": "<i>P</i> 2<sub>1</sub>/<i>c</i>",
                "latex": "\\mathit{P}\\,2_{1}/c",
                "unicode": "P2\u2081/c"
            }
        ]
    },
    "examples": [
        [
            {
                "html": "<i>P</i> 1",
                "latex": "\\mathrm{P} 1",
                "unicode": "P 1"
            }
        ]
    ]
}