From 8beb6e8b064061613676d71ed47b1a6fe1ee5ec6 Mon Sep 17 00:00:00 2001 From: sinaatalay Date: Sat, 7 Sep 2024 23:22:20 +0000 Subject: [PATCH] docs: update schema.json --- schema.json | 196 +++++++++++++++++----------------------------------- 1 file changed, 63 insertions(+), 133 deletions(-) diff --git a/schema.json b/schema.json index 250977c8..2ab12c3d 100644 --- a/schema.json +++ b/schema.json @@ -136,11 +136,7 @@ "type": "boolean" }, "margins": { - "allOf": [ - { - "$ref": "#/$defs/MarginsForClassic" - } - ], + "$ref": "#/$defs/MarginsForClassic", "default": { "page": { "bottom": "2 cm", @@ -344,10 +340,10 @@ "title": "Date", "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "integer" + "type": "string" } ] }, @@ -551,11 +547,7 @@ "type": "boolean" }, "margins": { - "allOf": [ - { - "$ref": "#/$defs/MarginsForEngineeringresumes" - } - ], + "$ref": "#/$defs/MarginsForEngineeringresumes", "default": { "page": { "bottom": "2 cm", @@ -711,10 +703,10 @@ "title": "Date", "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "integer" + "type": "string" } ] }, @@ -1068,11 +1060,7 @@ "description": "This class is a data model for the margins.", "properties": { "page": { - "allOf": [ - { - "$ref": "#/$defs/PageMargins" - } - ], + "$ref": "#/$defs/PageMargins", "default": { "top": "2 cm", "bottom": "2 cm", @@ -1083,11 +1071,7 @@ "title": "Page Margins" }, "section_title": { - "allOf": [ - { - "$ref": "#/$defs/SectionTitleMargins" - } - ], + "$ref": "#/$defs/SectionTitleMargins", "default": { "top": "0.3 cm", "bottom": "0.2 cm" @@ -1096,11 +1080,7 @@ "title": "Section Title Margins" }, "entry_area": { - "allOf": [ - { - "$ref": "#/$defs/EntryAreaMargins" - } - ], + "$ref": "#/$defs/EntryAreaMargins", "default": { "left_and_right": "0.2 cm", "vertical_between": "0.2 cm", @@ -1110,11 +1090,7 @@ "title": "Entry Area Margins" }, "highlights_area": { - "allOf": [ - { - "$ref": "#/$defs/HighlightsAreaMargins" - } - ], + "$ref": "#/$defs/HighlightsAreaMargins", "default": { "top": "0.10 cm", "left": "0.4 cm", @@ -1124,11 +1100,7 @@ "title": "Highlights Area Margins" }, "header": { - "allOf": [ - { - "$ref": "#/$defs/HeaderMargins" - } - ], + "$ref": "#/$defs/HeaderMargins", "default": { "vertical_between_name_and_connections": "0.3 cm", "bottom": "0.3 cm", @@ -1146,11 +1118,7 @@ "description": "This class is a data model for the margins.", "properties": { "page": { - "allOf": [ - { - "$ref": "#/$defs/PageMargins" - } - ], + "$ref": "#/$defs/PageMargins", "default": { "top": "2 cm", "bottom": "2 cm", @@ -1161,11 +1129,7 @@ "title": "Page Margins" }, "section_title": { - "allOf": [ - { - "$ref": "#/$defs/SectionTitleMargins" - } - ], + "$ref": "#/$defs/SectionTitleMargins", "default": { "top": "0.3 cm", "bottom": "0.2 cm" @@ -1174,11 +1138,7 @@ "title": "Section Title Margins" }, "entry_area": { - "allOf": [ - { - "$ref": "#/$defs/EntryAreaMarginsForClassic" - } - ], + "$ref": "#/$defs/EntryAreaMarginsForClassic", "default": { "left_and_right": "0.2 cm", "vertical_between": "0.2 cm", @@ -1189,11 +1149,7 @@ "title": "Entry Area Margins" }, "highlights_area": { - "allOf": [ - { - "$ref": "#/$defs/HighlightsAreaMargins" - } - ], + "$ref": "#/$defs/HighlightsAreaMargins", "default": { "top": "0.10 cm", "left": "0.4 cm", @@ -1203,11 +1159,7 @@ "title": "Highlights Area Margins" }, "header": { - "allOf": [ - { - "$ref": "#/$defs/HeaderMargins" - } - ], + "$ref": "#/$defs/HeaderMargins", "default": { "vertical_between_name_and_connections": "0.3 cm", "bottom": "0.3 cm", @@ -1225,11 +1177,7 @@ "description": "This class is a data model for the margins.", "properties": { "page": { - "allOf": [ - { - "$ref": "#/$defs/PageMargins" - } - ], + "$ref": "#/$defs/PageMargins", "default": { "top": "2 cm", "bottom": "2 cm", @@ -1240,11 +1188,7 @@ "title": "Page Margins" }, "section_title": { - "allOf": [ - { - "$ref": "#/$defs/SectionTitleMargins" - } - ], + "$ref": "#/$defs/SectionTitleMargins", "default": { "top": "0.3 cm", "bottom": "0.2 cm" @@ -1253,11 +1197,7 @@ "title": "Section Title Margins" }, "entry_area": { - "allOf": [ - { - "$ref": "#/$defs/EntryAreaMarginsForEngineeringresumes" - } - ], + "$ref": "#/$defs/EntryAreaMarginsForEngineeringresumes", "default": { "left_and_right": "0 cm", "vertical_between": "0.2 cm", @@ -1267,11 +1207,7 @@ "title": "Entry Area Margins" }, "highlights_area": { - "allOf": [ - { - "$ref": "#/$defs/HighlightsAreaMarginsForEngineeringresumes" - } - ], + "$ref": "#/$defs/HighlightsAreaMarginsForEngineeringresumes", "default": { "top": "0.10 cm", "left": "0 cm", @@ -1281,11 +1217,7 @@ "title": "Highlights Area Margins" }, "header": { - "allOf": [ - { - "$ref": "#/$defs/HeaderMarginsForEngineeringresumes" - } - ], + "$ref": "#/$defs/HeaderMarginsForEngineeringresumes", "default": { "vertical_between_name_and_connections": "5 pt", "bottom": "5 pt", @@ -1464,10 +1396,10 @@ "title": "Date", "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "integer" + "type": "string" } ] }, @@ -1672,10 +1604,10 @@ "title": "Date", "oneOf": [ { - "type": "string" + "type": "integer" }, { - "type": "integer" + "type": "string" } ] } @@ -1689,17 +1621,31 @@ }, "RenderCVSettings": { "additionalProperties": false, - "description": "This class is the data model of the rendercv settings. The values of each field\nupdates the `rendercv_settings` dictionary.", + "description": "This class is the data model of the RenderCV settings.", + "properties": { + "render_command": { + "default": null, + "description": "RenderCV's `render` command settings. They are the same as the command line arguments. CLI arguments have higher priority than the settings in the input file.", + "title": "Render Command Settings", + "oneOf": [ + { + "$ref": "#/$defs/RenderCommandSettings" + } + ] + } + }, + "title": "RenderCVSettings", + "type": "object" + }, + "RenderCommandSettings": { + "additionalProperties": false, + "description": "This class is the data model of the `render` command's settings.", "properties": { "output_folder_name": { "default": "rendercv_output", - "description": "The name of the folder where the output files will be saved. The default value is \"rendercv_output\".", + "description": "The name of the folder where the output files will be saved. The following placeholders can be used:\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\n- NAME: The name of the CV owner\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case\nThe default value is an empty string.\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\nThe default value is \"MONTH_ABBREVIATION YEAR\".\nThe default value is \"rendercv_output\".", "title": "Output Folder Name", - "oneOf": [ - { - "type": "string" - } - ] + "type": "string" }, "use_local_latex_command": { "default": null, @@ -1713,50 +1659,55 @@ }, "pdf_path": { "default": null, - "description": "The path of the PDF file. If it is not provided, the PDF file will not be generated. The default value is an empty string.", + "description": "The path of the PDF file. If it is not provided, the PDF file will not be generated. The following placeholders can be used:\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\n- NAME: The name of the CV owner\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case\nThe default value is an empty string.\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\nThe default value is \"MONTH_ABBREVIATION YEAR\".\nThe default value is null.", "title": "PDF Path", "oneOf": [ { + "format": "path", "type": "string" } ] }, "latex_path": { "default": null, - "description": "The path of the LaTeX file. If it is not provided, the LaTeX file will not be generated. The default value is an empty string.", + "description": "The path of the LaTeX file. If it is not provided, the LaTeX file will not be generated. The following placeholders can be used:\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\n- NAME: The name of the CV owner\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case\nThe default value is an empty string.\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\nThe default value is \"MONTH_ABBREVIATION YEAR\".\nThe default value is null.", "title": "LaTeX Path", "oneOf": [ { + "format": "path", "type": "string" } ] }, "html_path": { "default": null, - "description": "The path of the HTML file. If it is not provided, the HTML file will not be generated. The default value is an empty string.", + "description": "The path of the HTML file. If it is not provided, the HTML file will not be generated. The following placeholders can be used:\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\n- NAME: The name of the CV owner\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case\nThe default value is an empty string.\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\nThe default value is \"MONTH_ABBREVIATION YEAR\".\nThe default value is null.", "title": "HTML Path", "oneOf": [ { + "format": "path", "type": "string" } ] }, "png_path": { "default": null, - "description": "The path of the PNG file. If it is not provided, the PNG file will not be generated. The default value is an empty string.", + "description": "The path of the PNG file. If it is not provided, the PNG file will not be generated. The following placeholders can be used:\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\n- NAME: The name of the CV owner\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case\nThe default value is an empty string.\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\nThe default value is \"MONTH_ABBREVIATION YEAR\".\nThe default value is null.", "title": "PNG Path", "oneOf": [ { + "format": "path", "type": "string" } ] }, "markdown_path": { "default": null, - "description": "The path of the Markdown file. If it is not provided, the Markdown file will not be generated. The default value is an empty string.", + "description": "The path of the Markdown file. If it is not provided, the Markdown file will not be generated. The following placeholders can be used:\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\n- NAME: The name of the CV owner\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case\nThe default value is an empty string.\n- FULL_MONTH_NAME: Full name of the month\n- MONTH_ABBREVIATION: Abbreviation of the month\n- MONTH: Month as a number\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits\n- YEAR: Year as a number\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits\nThe default value is \"MONTH_ABBREVIATION YEAR\".\nThe default value is null.", "title": "Markdown Path", "oneOf": [ { + "format": "path", "type": "string" } ] @@ -1765,34 +1716,22 @@ "default": false, "description": "A boolean value to determine whether the HTML file will be generated. The default value is False.", "title": "Generate HTML Flag", - "oneOf": [ - { - "type": "boolean" - } - ] + "type": "boolean" }, "dont_generate_markdown": { "default": false, "description": "A boolean value to determine whether the Markdown file will be generated. The default value is False.", "title": "Generate Markdown Flag", - "oneOf": [ - { - "type": "boolean" - } - ] + "type": "boolean" }, "dont_generate_png": { "default": false, "description": "A boolean value to determine whether the PNG file will be generated. The default value is False.", "title": "Generate PNG Flag", - "oneOf": [ - { - "type": "boolean" - } - ] + "type": "boolean" } }, - "title": "RenderCVSettings", + "title": "RenderCommandSettings", "type": "object" }, "Sb2novThemeOptions": { @@ -1915,11 +1854,7 @@ "type": "boolean" }, "margins": { - "allOf": [ - { - "$ref": "#/$defs/Margins" - } - ], + "$ref": "#/$defs/Margins", "default": { "page": { "bottom": "2 cm", @@ -1947,8 +1882,7 @@ "vertical_between_name_and_connections": "0.3 cm" } }, - "description": "Page, section title, entry field, and highlights field margins.", - "title": "Margins" + "description": "Page, section title, entry field, and highlights field margins." } }, "required": [ @@ -2018,11 +1952,7 @@ "description": "RenderCV data model.", "properties": { "cv": { - "allOf": [ - { - "$ref": "#/$defs/CurriculumVitae" - } - ], + "$ref": "#/$defs/CurriculumVitae", "description": "The data of the CV.", "title": "Curriculum Vitae" },