rendercv/schema.json

1303 lines
38 KiB
JSON
Raw Normal View History

2023-10-19 18:02:14 +00:00
{
"$defs": {
2024-03-10 18:11:22 +00:00
"BulletEntry": {
"additionalProperties": false,
"description": "This class is the data model of `BulletEntry`.",
"properties": {
"bullet": {
"description": "The bullet of the BulletEntry.",
"title": "Bullet",
"type": "string"
}
},
"required": [
"bullet"
],
"title": "BulletEntry",
"type": "object"
},
2023-10-19 18:02:14 +00:00
"ClassicThemeOptions": {
2024-02-14 16:39:28 +00:00
"additionalProperties": false,
2024-02-17 18:45:10 +00:00
"description": "This class is the data model of the theme options for the classic theme.",
2023-10-19 18:02:14 +00:00
"properties": {
"theme": {
"const": "classic",
"title": "Theme"
},
2024-02-06 17:40:39 +00:00
"font_size": {
"default": "10pt",
2024-02-17 17:47:33 +00:00
"description": "The font size of the CV. The default value is 10pt.",
2024-02-06 17:40:39 +00:00
"enum": [
"10pt",
"11pt",
"12pt"
],
"title": "Font Size",
"type": "string"
},
"page_size": {
2024-02-17 17:47:33 +00:00
"default": "letterpaper",
"description": "The page size of the CV. It can be a4paper or letterpaper. The default value is letterpaper.",
2024-02-06 17:40:39 +00:00
"enum": [
"a4paper",
"letterpaper"
],
"title": "Page Size",
"type": "string"
},
2024-02-17 17:47:33 +00:00
"color": {
2023-10-19 18:02:14 +00:00
"default": "rgb(0,79,144)",
2024-02-17 17:47:33 +00:00
"description": "The primary color of the theme. \nThe color can be specified either with their [name](https://www.w3.org/TR/SVG11/types.html#ColorKeywords), hexadecimal value, RGB value, or HSL value. The default value is rgb(0,79,144).",
2023-10-19 18:02:14 +00:00
"examples": [
"Black",
"7fffd4",
"rgb(0,79,144)",
"hsl(270, 60%, 70%)"
],
"format": "color",
"title": "Primary Color",
"type": "string"
},
2024-02-17 17:47:33 +00:00
"disable_page_numbering": {
"default": false,
"description": "If this option is set to true, then the page numbering will be disabled. The default value is false.",
"title": "Disable Page Numbering",
"type": "boolean"
2023-10-19 18:02:14 +00:00
},
2024-02-17 17:51:52 +00:00
"page_numbering_style": {
2024-02-17 18:45:10 +00:00
"default": "NAME - Page PAGE_NUMBER of TOTAL_PAGES",
"description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.",
2024-02-17 17:51:52 +00:00
"title": "Page Numbering Style",
2023-11-20 19:13:05 +00:00
"type": "string"
},
2023-10-19 18:02:14 +00:00
"show_last_updated_date": {
"default": true,
2024-02-17 17:47:33 +00:00
"description": "If this option is set to true, then the last updated date will be shown in the header. The default value is true.",
2023-10-19 18:02:14 +00:00
"title": "Show Last Updated Date",
"type": "boolean"
},
2023-11-24 17:36:30 +00:00
"header_font_size": {
"default": "30 pt",
2024-02-17 17:47:33 +00:00
"description": "The font size of the header (the name of the person). The default value is 30 pt.",
2023-11-24 17:36:30 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Header Font Size",
"type": "string"
},
2024-02-17 18:09:37 +00:00
"text_alignment": {
"default": "justified",
"description": "The alignment of the text. The default value is justified.",
"enum": [
"left-aligned",
"justified"
],
"title": "Text Alignment",
"type": "string"
},
2023-10-19 18:02:14 +00:00
"margins": {
"allOf": [
{
2024-02-17 17:47:33 +00:00
"$ref": "#/$defs/Margins"
2023-10-19 18:02:14 +00:00
}
],
"default": {
2024-02-06 17:40:39 +00:00
"page": {
"bottom": "2 cm",
2024-02-17 18:45:10 +00:00
"left": "2 cm",
"right": "2 cm",
2024-02-06 17:40:39 +00:00
"top": "2 cm"
},
"section_title": {
"bottom": "0.2 cm",
2024-02-17 18:45:10 +00:00
"top": "0.3 cm"
2024-02-06 17:40:39 +00:00
},
2023-10-19 18:02:14 +00:00
"entry_area": {
2024-02-17 17:47:33 +00:00
"date_and_location_width": "4.1 cm",
2023-11-17 00:04:29 +00:00
"left_and_right": "0.2 cm",
2024-02-17 18:45:10 +00:00
"vertical_between": "0.2 cm"
2023-10-19 18:02:14 +00:00
},
"highlights_area": {
2023-11-29 16:44:30 +00:00
"left": "0.4 cm",
"top": "0.10 cm",
"vertical_between_bullet_points": "0.10 cm"
2023-10-19 18:02:14 +00:00
},
2024-02-06 17:40:39 +00:00
"header": {
2024-02-17 18:45:10 +00:00
"bottom": "0.3 cm",
2024-02-17 17:47:33 +00:00
"horizontal_between_connections": "0.5 cm",
2024-02-17 18:45:10 +00:00
"vertical_between_name_and_connections": "0.3 cm"
2023-10-19 18:02:14 +00:00
}
},
"description": "Page, section title, entry field, and highlights field margins.",
"title": "Margins"
2024-02-17 17:47:33 +00:00
},
2024-02-17 17:51:52 +00:00
"show_timespan_in": {
"default": [],
2024-02-17 18:45:10 +00:00
"description": "The time span will be shown in the date and location column in these sections. The input should be a list of section titles as strings (case-sensitive). The default value is an empty list, which means the time span will not be shown in any section.",
2024-02-17 17:51:52 +00:00
"items": {
"type": "string"
},
"title": "Show Time Span in These Sections",
"type": "array"
2023-10-19 18:02:14 +00:00
}
},
2024-02-06 17:40:39 +00:00
"required": [
"theme"
],
2023-10-19 18:02:14 +00:00
"title": "ClassicThemeOptions",
2024-02-14 16:39:28 +00:00
"type": "object"
2023-10-19 18:02:14 +00:00
},
"CurriculumVitae": {
2024-02-06 17:40:39 +00:00
"additionalProperties": false,
"description": "This class is the data model of the CV.",
2023-10-19 18:02:14 +00:00
"properties": {
"name": {
2024-02-20 19:22:47 +00:00
"default": null,
2023-10-19 18:02:14 +00:00
"description": "The name of the person.",
"title": "Name",
2024-02-20 19:22:47 +00:00
"allOf": [
{
"type": "string"
}
]
2023-10-19 18:02:14 +00:00
},
"label": {
"default": null,
"description": "The label of the person.",
"title": "Label",
"allOf": [
{
"type": "string"
}
]
},
"location": {
"default": null,
2024-03-10 17:13:49 +00:00
"description": "The location of the person.",
2023-10-19 18:02:14 +00:00
"title": "Location",
"allOf": [
{
"type": "string"
}
]
},
"email": {
"default": null,
2024-02-14 16:39:28 +00:00
"description": "The email of the person.",
2023-10-19 18:02:14 +00:00
"title": "Email",
"allOf": [
{
"format": "email",
"type": "string"
}
]
},
"phone": {
"default": null,
2024-02-14 16:39:28 +00:00
"description": "The phone number of the person.",
2023-10-19 18:02:14 +00:00
"title": "Phone",
"allOf": [
{
2024-02-06 17:40:39 +00:00
"format": "phone",
2023-10-19 18:02:14 +00:00
"maxLength": 64,
"minLength": 7,
"type": "string"
}
]
},
"website": {
"default": null,
2024-02-14 16:39:28 +00:00
"description": "The website of the person.",
2023-10-19 18:02:14 +00:00
"title": "Website",
"allOf": [
{
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"type": "string"
}
]
},
"social_networks": {
"default": null,
2024-02-14 16:39:28 +00:00
"description": "The social networks of the person.",
2023-10-19 18:02:14 +00:00
"title": "Social Networks",
"allOf": [
{
"items": {
"$ref": "#/$defs/SocialNetwork"
},
"type": "array"
}
]
},
2024-02-06 17:40:39 +00:00
"sections": {
2023-10-19 18:02:14 +00:00
"default": null,
2024-02-06 17:40:39 +00:00
"description": "The sections of the CV.",
"title": "Sections",
2024-02-18 19:40:47 +00:00
"allOf": [
{
"additionalProperties": {
2024-03-10 17:13:49 +00:00
"anyOf": [
{
"items": {
"$ref": "#/$defs/OneLineEntry"
2024-02-18 19:40:47 +00:00
},
2024-03-10 17:13:49 +00:00
"type": "array"
},
{
"items": {
"$ref": "#/$defs/NormalEntry"
2024-02-18 19:40:47 +00:00
},
2024-03-10 17:13:49 +00:00
"type": "array"
},
{
"items": {
"$ref": "#/$defs/ExperienceEntry"
2024-02-18 19:40:47 +00:00
},
2024-03-10 17:13:49 +00:00
"type": "array"
},
{
"items": {
"$ref": "#/$defs/EducationEntry"
2024-02-18 19:40:47 +00:00
},
2024-03-10 17:13:49 +00:00
"type": "array"
},
{
"items": {
"$ref": "#/$defs/PublicationEntry"
2024-02-18 19:40:47 +00:00
},
2024-03-10 18:11:22 +00:00
"type": "array"
},
{
"items": {
"$ref": "#/$defs/BulletEntry"
},
2024-03-10 17:13:49 +00:00
"type": "array"
},
{
"items": {
2024-02-18 19:40:47 +00:00
"type": "string"
2024-03-10 17:13:49 +00:00
},
"type": "array"
}
]
2024-02-18 19:40:47 +00:00
},
"type": "object"
}
]
2024-02-06 17:40:39 +00:00
}
},
"title": "CurriculumVitae",
"type": "object"
},
"EducationEntry": {
"additionalProperties": false,
"description": "This class is the data model of `EducationEntry`.",
"properties": {
"start_date": {
2024-02-14 16:39:28 +00:00
"default": "2000-01-01",
2024-02-06 17:40:39 +00:00
"description": "The start date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format.",
"examples": [
"2020-09-24"
],
"title": "Start Date",
"oneOf": [
{
"type": "integer"
},
2023-10-19 18:02:14 +00:00
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2023-10-19 18:02:14 +00:00
"type": "string"
2024-02-06 17:40:39 +00:00
},
2023-10-19 18:02:14 +00:00
{
2024-02-06 17:40:39 +00:00
"type": "null"
2023-10-19 18:02:14 +00:00
}
]
},
2024-02-06 17:40:39 +00:00
"end_date": {
2024-02-14 16:39:28 +00:00
"default": "2020-01-01",
2024-03-10 17:13:49 +00:00
"description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start_date.",
2024-02-06 17:40:39 +00:00
"examples": [
"2020-09-24",
"present"
],
"title": "End Date",
"oneOf": [
2023-10-19 18:02:14 +00:00
{
2024-02-06 17:40:39 +00:00
"const": "present"
},
2023-10-27 20:51:24 +00:00
{
2024-02-06 17:40:39 +00:00
"type": "integer"
},
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2024-02-06 17:40:39 +00:00
"type": "string"
},
{
"type": "null"
2023-10-27 20:51:24 +00:00
}
]
},
2024-02-06 17:40:39 +00:00
"date": {
2024-02-14 16:39:28 +00:00
"default": "Custom Date or 2020-01-01",
2024-03-10 17:13:49 +00:00
"description": "If the event is a one-day event, then this field can be filled in YYYY-MM-DD format. Also, this field can be used if you would like to use a custom date string (like \"Fall 2020\").",
2024-02-06 17:40:39 +00:00
"examples": [
"2020-09-24",
"My Custom Date"
],
"title": "Date",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
2023-10-19 18:02:14 +00:00
}
]
},
2024-02-06 17:40:39 +00:00
"highlights": {
2023-10-27 20:51:24 +00:00
"default": null,
2024-02-06 17:40:39 +00:00
"description": "The highlights of the event as a list of strings.",
"examples": [
"Did this.",
"Did that."
],
"title": "Highlights",
2023-10-27 20:51:24 +00:00
"allOf": [
{
"items": {
2024-02-06 17:40:39 +00:00
"type": "string"
2023-10-27 20:51:24 +00:00
},
"type": "array"
}
]
},
2024-02-06 17:40:39 +00:00
"location": {
2023-10-19 18:02:14 +00:00
"default": null,
2024-02-06 17:40:39 +00:00
"description": "The location of the event.",
"examples": [
2024-02-14 16:39:28 +00:00
"Istanbul, T\u00fcrkiye"
2024-02-06 17:40:39 +00:00
],
"title": "Location",
2023-10-19 18:02:14 +00:00
"allOf": [
{
2024-02-06 17:40:39 +00:00
"type": "string"
2023-10-19 18:02:14 +00:00
}
]
},
2024-02-06 17:40:39 +00:00
"institution": {
2024-03-10 17:13:49 +00:00
"description": "The institution name.",
2024-02-06 17:40:39 +00:00
"title": "Institution",
"type": "string"
},
"area": {
2024-03-10 17:13:49 +00:00
"description": "The area of study.",
2024-02-06 17:40:39 +00:00
"title": "Area",
"type": "string"
},
"degree": {
2024-02-14 16:39:28 +00:00
"default": "PhD",
2024-02-06 17:40:39 +00:00
"description": "The type of the degree.",
"examples": [
"BS",
"BA",
"PhD",
"MS"
],
"title": "Degree",
2023-10-19 18:02:14 +00:00
"allOf": [
{
2024-02-06 17:40:39 +00:00
"type": "string"
2023-10-19 18:02:14 +00:00
}
]
2024-02-06 17:40:39 +00:00
}
},
"required": [
"institution",
"area"
],
"title": "EducationEntry",
"type": "object"
},
2024-02-17 17:47:33 +00:00
"EntryAreaMargins": {
2024-02-17 18:45:10 +00:00
"description": "This class is a data model for the entry area margins.",
2024-02-17 17:47:33 +00:00
"properties": {
"left_and_right": {
"default": "0.2 cm",
"description": "The left margin of entry areas. The default value is 0.2 cm.",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Left Margin",
"type": "string"
},
"vertical_between": {
2024-02-17 18:45:10 +00:00
"default": "0.2 cm",
"description": "The vertical margin between entry areas. The default value is 0.2 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Vertical Margin Between Entry Areas",
"type": "string"
},
"date_and_location_width": {
"default": "4.1 cm",
"description": "The width of the date and location column. The default value is 4.1 cm.",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Date and Location Column Width",
"type": "string"
}
},
"title": "EntryAreaMargins",
"type": "object",
"additionalProperties": false
},
2024-02-06 17:40:39 +00:00
"ExperienceEntry": {
"additionalProperties": false,
"description": "This class is the data model of `ExperienceEntry`.",
"properties": {
"start_date": {
2024-02-14 16:39:28 +00:00
"default": "2000-01-01",
2024-02-06 17:40:39 +00:00
"description": "The start date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format.",
"examples": [
"2020-09-24"
],
"title": "Start Date",
"oneOf": [
2023-10-19 18:02:14 +00:00
{
2024-02-06 17:40:39 +00:00
"type": "integer"
},
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2024-02-06 17:40:39 +00:00
"type": "string"
},
{
"type": "null"
2023-10-19 18:02:14 +00:00
}
]
},
2024-02-06 17:40:39 +00:00
"end_date": {
2024-02-14 16:39:28 +00:00
"default": "2020-01-01",
2024-03-10 17:13:49 +00:00
"description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start_date.",
2023-10-19 18:02:14 +00:00
"examples": [
"2020-09-24",
"present"
],
2024-02-06 17:40:39 +00:00
"title": "End Date",
2023-10-19 18:02:14 +00:00
"oneOf": [
{
2024-02-06 17:40:39 +00:00
"const": "present"
2023-10-19 18:02:14 +00:00
},
{
2024-02-06 17:40:39 +00:00
"type": "integer"
2023-10-19 18:02:14 +00:00
},
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2023-11-03 20:35:50 +00:00
"type": "string"
2023-10-19 18:02:14 +00:00
},
{
"type": "null"
}
2024-02-06 17:40:39 +00:00
]
2023-10-19 18:02:14 +00:00
},
"date": {
2024-02-14 16:39:28 +00:00
"default": "Custom Date or 2020-01-01",
2024-03-10 17:13:49 +00:00
"description": "If the event is a one-day event, then this field can be filled in YYYY-MM-DD format. Also, this field can be used if you would like to use a custom date string (like \"Fall 2020\").",
2023-10-19 18:02:14 +00:00
"examples": [
"2020-09-24",
"My Custom Date"
2024-02-06 17:40:39 +00:00
],
"title": "Date",
2023-10-19 18:02:14 +00:00
"oneOf": [
2024-02-06 17:40:39 +00:00
{
"type": "integer"
},
2023-10-19 18:02:14 +00:00
{
"type": "string"
},
{
"type": "null"
}
2024-02-06 17:40:39 +00:00
]
2023-10-19 18:02:14 +00:00
},
"highlights": {
2024-02-06 17:40:39 +00:00
"default": null,
"description": "The highlights of the event as a list of strings.",
2023-10-19 18:02:14 +00:00
"examples": [
"Did this.",
"Did that."
],
"title": "Highlights",
"allOf": [
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"location": {
"default": null,
2024-02-06 17:40:39 +00:00
"description": "The location of the event.",
2023-10-19 18:02:14 +00:00
"examples": [
2024-02-14 16:39:28 +00:00
"Istanbul, T\u00fcrkiye"
2023-10-19 18:02:14 +00:00
],
"title": "Location",
"allOf": [
{
"type": "string"
}
]
},
2024-02-06 17:40:39 +00:00
"company": {
2024-03-10 17:13:49 +00:00
"description": "The company name.",
2024-02-06 17:40:39 +00:00
"title": "Company",
2023-10-19 18:02:14 +00:00
"type": "string"
},
2024-02-06 17:40:39 +00:00
"position": {
2024-03-10 17:13:49 +00:00
"description": "The position.",
2024-02-06 17:40:39 +00:00
"title": "Position",
2023-10-19 18:02:14 +00:00
"type": "string"
}
},
"required": [
2024-02-06 17:40:39 +00:00
"company",
"position"
2023-10-19 18:02:14 +00:00
],
2024-02-06 17:40:39 +00:00
"title": "ExperienceEntry",
"type": "object"
2023-10-19 18:02:14 +00:00
},
2024-02-17 17:47:33 +00:00
"HeaderMargins": {
2024-02-17 18:45:10 +00:00
"description": "This class is a data model for the header margins.",
2024-02-11 18:35:32 +00:00
"properties": {
2024-02-17 17:47:33 +00:00
"vertical_between_name_and_connections": {
2024-02-17 18:45:10 +00:00
"default": "0.3 cm",
"description": "The vertical margin between the name of the person and the connections. The default value is 0.3 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Vertical Margin Between the Name and Connections",
"type": "string"
},
"bottom": {
2024-02-17 18:45:10 +00:00
"default": "0.3 cm",
"description": "The bottom margin of the header, i.e., the vertical margin between the connections and the first section title. The default value is 0.3 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Bottom Margin",
"type": "string"
},
"horizontal_between_connections": {
"default": "0.5 cm",
"description": "The space between the connections (like phone, email, and website). The default value is 0.5 cm.",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Space Between Connections",
"type": "string"
2024-02-11 18:35:32 +00:00
}
},
2024-02-17 17:47:33 +00:00
"title": "HeaderMargins",
"type": "object",
"additionalProperties": false
2024-02-11 18:35:32 +00:00
},
2024-02-17 17:47:33 +00:00
"HighlightsAreaMargins": {
2024-02-17 18:45:10 +00:00
"description": "This class is a data model for the highlights area margins.",
2024-02-11 18:35:32 +00:00
"properties": {
2024-02-17 17:47:33 +00:00
"top": {
"default": "0.10 cm",
"description": "The top margin of highlights areas. The default value is 0.10 cm.",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Top Margin",
"type": "string"
2024-02-11 18:35:32 +00:00
},
2024-02-17 17:47:33 +00:00
"left": {
"default": "0.4 cm",
"description": "The left margin of highlights areas. The default value is 0.4 cm.",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Left Margin",
"type": "string"
},
"vertical_between_bullet_points": {
"default": "0.10 cm",
"description": "The vertical margin between bullet points. The default value is 0.10 cm.",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Vertical Margin Between Bullet Points",
"type": "string"
}
},
"title": "HighlightsAreaMargins",
"type": "object",
"additionalProperties": false
},
"Margins": {
2024-02-17 18:45:10 +00:00
"description": "This class is a data model for the margins.",
2024-02-17 17:47:33 +00:00
"properties": {
"page": {
"allOf": [
{
"$ref": "#/$defs/PageMargins"
}
],
"default": {
"top": "2 cm",
"bottom": "2 cm",
2024-02-17 18:45:10 +00:00
"left": "2 cm",
"right": "2 cm"
2024-02-17 17:47:33 +00:00
},
"description": "Page margins.",
"title": "Page Margins"
},
"section_title": {
"allOf": [
{
"$ref": "#/$defs/SectionTitleMargins"
}
],
"default": {
2024-02-17 18:45:10 +00:00
"top": "0.3 cm",
2024-02-17 17:47:33 +00:00
"bottom": "0.2 cm"
},
"description": "Section title margins.",
"title": "Section Title Margins"
},
"entry_area": {
"allOf": [
{
"$ref": "#/$defs/EntryAreaMargins"
}
],
"default": {
"left_and_right": "0.2 cm",
2024-02-17 18:45:10 +00:00
"vertical_between": "0.2 cm",
2024-02-17 17:47:33 +00:00
"date_and_location_width": "4.1 cm"
},
"description": "Entry area margins.",
"title": "Entry Area Margins"
},
"highlights_area": {
"allOf": [
{
"$ref": "#/$defs/HighlightsAreaMargins"
}
],
"default": {
"top": "0.10 cm",
"left": "0.4 cm",
"vertical_between_bullet_points": "0.10 cm"
},
"description": "Highlights area margins.",
"title": "Highlights Area Margins"
},
"header": {
"allOf": [
{
"$ref": "#/$defs/HeaderMargins"
}
],
"default": {
2024-02-17 18:45:10 +00:00
"vertical_between_name_and_connections": "0.3 cm",
"bottom": "0.3 cm",
2024-02-17 17:47:33 +00:00
"horizontal_between_connections": "0.5 cm"
},
"description": "Header margins.",
"title": "Header Margins"
}
},
"title": "Margins",
"type": "object",
"additionalProperties": false
},
"ModerncvThemeOptions": {
"additionalProperties": false,
2024-02-17 18:45:10 +00:00
"description": "This class is the data model of the theme options for the moderncv theme.",
2024-02-17 17:47:33 +00:00
"properties": {
"theme": {
"const": "moderncv",
"title": "Theme"
},
"font_size": {
"default": "10pt",
"description": "The font size of the CV. The default value is \"10pt\".",
"enum": [
"10pt",
"11pt",
"12pt"
2024-02-11 18:35:32 +00:00
],
"examples": [
"10pt",
"11pt",
"12pt"
],
"title": "Font Size",
"type": "string"
},
"page_size": {
2024-02-17 18:45:10 +00:00
"default": "letterpaper",
"description": "The page size of the CV. The default value is \"letterpaper\".",
2024-02-11 18:35:32 +00:00
"enum": [
"a4paper",
"letterpaper"
],
"examples": [
"a4paper",
"letterpaper"
],
"title": "Page Size",
"type": "string"
},
"color": {
"default": "blue",
"description": "The primary color of the CV. The default value is \"blue\".",
"examples": [
"blue",
"black",
"burgundy",
"green",
"grey",
"orange",
"purple",
"red"
],
"title": "Primary Color",
"oneOf": [
{
"const": "blue"
},
{
"const": "black"
},
{
"const": "burgundy"
},
{
"const": "green"
},
{
"const": "grey"
},
{
"const": "orange"
},
{
"const": "purple"
},
{
"const": "red"
}
]
},
"date_width": {
"default": "3.8 cm",
"description": "The width of the date column. The default value is \"3.8 cm\".",
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Date and Location Column Width",
"type": "string"
},
"content_scale": {
"default": 0.75,
"description": "The scale of the content with respect to the page size. The default value is \"0.75\".",
"title": "Content Scale",
"type": "number"
},
"show_only_years": {
"default": false,
"description": "If \"True\", only the years will be shown in the date column. The default value is \"False\".",
"title": "Show Only Years",
"type": "boolean"
},
"disable_page_numbers": {
"default": false,
"description": "If \"True\", the page numbers will be disabled. The default value is \"False\".",
"title": "Disable Page Numbers",
"type": "boolean"
}
},
"required": [
"theme"
],
"title": "ModerncvThemeOptions",
2024-02-14 16:39:28 +00:00
"type": "object"
2024-02-11 18:35:32 +00:00
},
2024-02-06 17:40:39 +00:00
"NormalEntry": {
"additionalProperties": false,
"description": "This class is the data model of `NormalEntry`.",
2023-10-19 18:02:14 +00:00
"properties": {
"start_date": {
2024-02-14 16:39:28 +00:00
"default": "2000-01-01",
2024-02-06 17:40:39 +00:00
"description": "The start date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format.",
2023-10-19 18:02:14 +00:00
"examples": [
"2020-09-24"
],
"title": "Start Date",
2024-02-06 17:40:39 +00:00
"oneOf": [
2023-10-19 18:02:14 +00:00
{
2024-02-06 17:40:39 +00:00
"type": "integer"
},
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2023-10-19 18:02:14 +00:00
"type": "string"
2024-02-06 17:40:39 +00:00
},
{
"type": "null"
2023-10-19 18:02:14 +00:00
}
]
},
"end_date": {
2024-02-14 16:39:28 +00:00
"default": "2020-01-01",
2024-03-10 17:13:49 +00:00
"description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start_date.",
2024-02-06 17:40:39 +00:00
"examples": [
"2020-09-24",
"present"
],
"title": "End Date",
2023-10-19 18:02:14 +00:00
"oneOf": [
{
2023-11-03 20:35:50 +00:00
"const": "present"
2023-10-19 18:02:14 +00:00
},
{
2024-02-06 17:40:39 +00:00
"type": "integer"
},
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2023-11-03 20:35:50 +00:00
"type": "string"
2023-10-19 18:02:14 +00:00
},
{
"type": "null"
}
2024-02-06 17:40:39 +00:00
]
2023-10-19 18:02:14 +00:00
},
"date": {
2024-02-14 16:39:28 +00:00
"default": "Custom Date or 2020-01-01",
2024-03-10 17:13:49 +00:00
"description": "If the event is a one-day event, then this field can be filled in YYYY-MM-DD format. Also, this field can be used if you would like to use a custom date string (like \"Fall 2020\").",
2023-10-19 18:02:14 +00:00
"examples": [
2024-02-06 17:40:39 +00:00
"2020-09-24",
"My Custom Date"
2023-10-19 18:02:14 +00:00
],
2024-02-06 17:40:39 +00:00
"title": "Date",
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "null"
}
]
2023-10-19 18:02:14 +00:00
},
"highlights": {
2024-02-06 17:40:39 +00:00
"default": null,
"description": "The highlights of the event as a list of strings.",
2023-10-19 18:02:14 +00:00
"examples": [
"Did this.",
"Did that."
],
"title": "Highlights",
"allOf": [
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"location": {
"default": null,
2024-02-06 17:40:39 +00:00
"description": "The location of the event.",
2023-10-19 18:02:14 +00:00
"examples": [
2024-02-14 16:39:28 +00:00
"Istanbul, T\u00fcrkiye"
2023-10-19 18:02:14 +00:00
],
"title": "Location",
"allOf": [
{
"type": "string"
}
]
},
2024-02-06 17:40:39 +00:00
"name": {
2024-03-10 17:13:49 +00:00
"description": "The name of the NormalEntry.",
2024-02-06 17:40:39 +00:00
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "NormalEntry",
"type": "object"
},
"OneLineEntry": {
"additionalProperties": false,
"description": "This class is the data model of `OneLineEntry`.",
"properties": {
2024-03-10 17:13:49 +00:00
"label": {
"description": "The label of the OneLineEntry.",
2024-02-06 17:40:39 +00:00
"title": "Name",
"type": "string"
},
"details": {
2024-03-10 17:13:49 +00:00
"description": "The details of the OneLineEntry.",
2024-02-06 17:40:39 +00:00
"title": "Details",
"type": "string"
}
},
"required": [
2024-03-10 17:13:49 +00:00
"label",
2024-02-06 17:40:39 +00:00
"details"
],
"title": "OneLineEntry",
"type": "object"
},
2024-02-17 17:47:33 +00:00
"PageMargins": {
2024-02-17 18:45:10 +00:00
"description": "This class is a data model for the page margins.",
2024-02-17 17:47:33 +00:00
"properties": {
"top": {
"default": "2 cm",
2024-02-17 18:45:10 +00:00
"description": "The top margin of the page with units. The default value is 2 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Top Margin",
"type": "string"
},
"bottom": {
"default": "2 cm",
2024-02-17 18:45:10 +00:00
"description": "The bottom margin of the page with units. The default value is 2 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Bottom Margin",
"type": "string"
},
"left": {
2024-02-17 18:45:10 +00:00
"default": "2 cm",
"description": "The left margin of the page with units. The default value is 2 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Left Margin",
"type": "string"
},
"right": {
2024-02-17 18:45:10 +00:00
"default": "2 cm",
"description": "The right margin of the page with units. The default value is 2 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Right Margin",
"type": "string"
}
},
"title": "PageMargins",
"type": "object",
"additionalProperties": false
},
2024-02-06 17:40:39 +00:00
"PublicationEntry": {
"additionalProperties": false,
"description": "This class is the data model of `PublicationEntry`.",
"properties": {
2023-10-19 18:02:14 +00:00
"title": {
2024-03-10 17:13:49 +00:00
"description": "The title of the publication.",
2023-10-19 18:02:14 +00:00
"title": "Title of the Publication",
"type": "string"
},
"authors": {
"description": "The authors of the publication in order as a list of strings.",
"items": {
"type": "string"
},
"title": "Authors",
"type": "array"
},
"doi": {
"default": null,
2023-10-19 18:02:14 +00:00
"description": "The DOI of the publication.",
"examples": [
"10.48550/arXiv.2310.03138"
],
"title": "DOI",
"allOf": [
{
"type": "string"
}
]
2023-10-19 18:02:14 +00:00
},
2024-02-06 17:40:39 +00:00
"date": {
2024-02-14 16:39:28 +00:00
"default": "2020-01-01",
2024-02-06 17:40:39 +00:00
"description": "The date of the publication in YYYY-MM-DD, YYYY-MM, or YYYY format.",
"examples": [
"2021-10-31",
"2010"
],
"title": "Publication Date",
"oneOf": [
{
2024-02-17 17:47:33 +00:00
"pattern": "\\d{4}(-\\d{2})?(-\\d{2})?",
2024-02-06 17:40:39 +00:00
"type": "string"
2023-10-19 18:02:14 +00:00
}
]
},
"journal": {
"default": null,
"description": "The journal or the conference name.",
"title": "Journal",
"allOf": [
{
"type": "string"
}
]
}
},
"required": [
"title",
"authors",
2024-02-06 17:40:39 +00:00
"date"
2023-10-19 18:02:14 +00:00
],
"title": "PublicationEntry",
2024-02-06 17:40:39 +00:00
"type": "object"
2023-10-19 18:02:14 +00:00
},
2024-02-17 17:47:33 +00:00
"Sb2novThemeOptions": {
"additionalProperties": false,
2024-02-17 18:45:10 +00:00
"description": "This class is the data model of the theme options for the sb2nov theme.",
2024-02-17 17:47:33 +00:00
"properties": {
"theme": {
"const": "sb2nov",
"title": "Theme"
},
2024-02-17 17:47:33 +00:00
"font_size": {
"default": "10pt",
"description": "The font size of the CV. The default value is 10pt.",
"enum": [
"10pt",
"11pt",
"12pt"
],
"title": "Font Size",
"type": "string"
},
"page_size": {
"default": "letterpaper",
"description": "The page size of the CV. It can be a4paper or letterpaper. The default value is letterpaper.",
"enum": [
"a4paper",
"letterpaper"
],
"title": "Page Size",
"type": "string"
},
"color": {
"default": "rgb(0,79,144)",
"description": "The primary color of the theme. \nThe color can be specified either with their [name](https://www.w3.org/TR/SVG11/types.html#ColorKeywords), hexadecimal value, RGB value, or HSL value. The default value is rgb(0,79,144).",
"examples": [
"Black",
"7fffd4",
"rgb(0,79,144)",
"hsl(270, 60%, 70%)"
],
"format": "color",
"title": "Primary Color",
"type": "string"
},
"disable_page_numbering": {
"default": false,
"description": "If this option is set to true, then the page numbering will be disabled. The default value is false.",
"title": "Disable Page Numbering",
"type": "boolean"
},
2024-02-17 17:51:52 +00:00
"page_numbering_style": {
2024-02-17 18:45:10 +00:00
"default": "NAME - Page PAGE_NUMBER of TOTAL_PAGES",
"description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.",
2024-02-17 17:51:52 +00:00
"title": "Page Numbering Style",
2024-02-17 17:47:33 +00:00
"type": "string"
},
"show_last_updated_date": {
"default": true,
"description": "If this option is set to true, then the last updated date will be shown in the header. The default value is true.",
"title": "Show Last Updated Date",
"type": "boolean"
},
"header_font_size": {
2024-02-17 17:51:52 +00:00
"default": "24 pt",
"description": "The font size of the header (the name of the person). The default value is 24 pt. Unfortunately, sb2nov does not support font sizes bigger than 24 pt.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Header Font Size",
"type": "string"
},
2024-02-17 18:09:37 +00:00
"text_alignment": {
"default": "justified",
"description": "The alignment of the text. The default value is justified.",
"enum": [
"left-aligned",
"justified"
],
"title": "Text Alignment",
"type": "string"
},
2024-02-17 17:47:33 +00:00
"margins": {
"allOf": [
{
"$ref": "#/$defs/Margins"
}
],
"default": {
"page": {
"bottom": "2 cm",
2024-02-17 18:45:10 +00:00
"left": "2 cm",
"right": "2 cm",
2024-02-17 17:47:33 +00:00
"top": "2 cm"
},
"section_title": {
"bottom": "0.2 cm",
2024-02-17 18:45:10 +00:00
"top": "0.3 cm"
2024-02-17 17:47:33 +00:00
},
"entry_area": {
"date_and_location_width": "4.1 cm",
"left_and_right": "0.2 cm",
2024-02-17 18:45:10 +00:00
"vertical_between": "0.2 cm"
2024-02-17 17:47:33 +00:00
},
"highlights_area": {
"left": "0.4 cm",
"top": "0.10 cm",
"vertical_between_bullet_points": "0.10 cm"
},
"header": {
2024-02-17 18:45:10 +00:00
"bottom": "0.3 cm",
2024-02-17 17:47:33 +00:00
"horizontal_between_connections": "0.5 cm",
2024-02-17 18:45:10 +00:00
"vertical_between_name_and_connections": "0.3 cm"
2024-02-17 17:47:33 +00:00
}
},
"description": "Page, section title, entry field, and highlights field margins.",
"title": "Margins"
}
},
"required": [
"theme"
],
"title": "Sb2novThemeOptions",
"type": "object"
},
"SectionTitleMargins": {
2024-02-17 18:45:10 +00:00
"description": "This class is a data model for the section title margins.",
2024-02-17 17:47:33 +00:00
"properties": {
"top": {
2024-02-17 18:45:10 +00:00
"default": "0.3 cm",
"description": "The top margin of section titles. The default value is 0.3 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Top Margin",
"type": "string"
},
"bottom": {
"default": "0.2 cm",
2024-02-17 18:45:10 +00:00
"description": "The bottom margin of section titles. The default value is 0.3 cm.",
2024-02-17 17:47:33 +00:00
"pattern": "\\d+\\.?\\d* *(cm|in|pt|mm|ex|em)",
"title": "Bottom Margin",
"type": "string"
}
},
"title": "SectionTitleMargins",
"type": "object",
"additionalProperties": false
},
2023-10-19 18:02:14 +00:00
"SocialNetwork": {
2024-02-06 17:40:39 +00:00
"additionalProperties": false,
"description": "This class is the data model of a social network.",
2023-10-19 18:02:14 +00:00
"properties": {
"network": {
"description": "The social network name.",
"enum": [
"LinkedIn",
"GitHub",
2023-10-23 16:27:44 +00:00
"Instagram",
2024-02-06 17:40:39 +00:00
"Orcid",
"Mastodon",
"Twitter"
2023-10-19 18:02:14 +00:00
],
"title": "Social Network",
"type": "string"
},
"username": {
"description": "The username of the social network. The link will be generated.",
"title": "Username",
"type": "string"
}
},
"required": [
"network",
"username"
],
"title": "SocialNetwork",
2024-02-06 17:40:39 +00:00
"type": "object"
2023-10-19 18:02:14 +00:00
}
},
2024-02-06 17:40:39 +00:00
"additionalProperties": false,
"description": "RenderCV data model.",
2023-10-19 18:02:14 +00:00
"properties": {
2024-02-06 17:40:39 +00:00
"cv": {
2023-10-19 18:02:14 +00:00
"allOf": [
{
2024-02-06 17:40:39 +00:00
"$ref": "#/$defs/CurriculumVitae"
2023-10-19 18:02:14 +00:00
}
],
2024-02-06 17:40:39 +00:00
"description": "The data of the CV.",
"title": "Curriculum Vitae"
},
"design": {
2024-02-09 19:14:17 +00:00
"default": {
"theme": "classic",
2024-02-09 19:14:17 +00:00
"font_size": "10pt",
2024-02-17 17:47:33 +00:00
"page_size": "letterpaper",
"color": "#004f90",
"disable_page_numbering": false,
2024-02-17 18:45:10 +00:00
"page_numbering_style": "NAME - Page PAGE_NUMBER of TOTAL_PAGES",
2024-02-09 19:14:17 +00:00
"show_last_updated_date": true,
"header_font_size": "30 pt",
2024-02-17 18:09:37 +00:00
"text_alignment": "justified",
2024-02-09 19:14:17 +00:00
"margins": {
"entry_area": {
2024-02-17 17:47:33 +00:00
"date_and_location_width": "4.1 cm",
2024-02-09 19:14:17 +00:00
"left_and_right": "0.2 cm",
2024-02-17 18:45:10 +00:00
"vertical_between": "0.2 cm"
2024-02-09 19:14:17 +00:00
},
"header": {
2024-02-17 18:45:10 +00:00
"bottom": "0.3 cm",
2024-02-17 17:47:33 +00:00
"horizontal_between_connections": "0.5 cm",
2024-02-17 18:45:10 +00:00
"vertical_between_name_and_connections": "0.3 cm"
2024-02-09 19:14:17 +00:00
},
"highlights_area": {
"left": "0.4 cm",
"top": "0.10 cm",
"vertical_between_bullet_points": "0.10 cm"
},
"page": {
"bottom": "2 cm",
2024-02-17 18:45:10 +00:00
"left": "2 cm",
"right": "2 cm",
2024-02-09 19:14:17 +00:00
"top": "2 cm"
},
"section_title": {
"bottom": "0.2 cm",
2024-02-17 18:45:10 +00:00
"top": "0.3 cm"
2024-02-09 19:14:17 +00:00
}
2024-02-17 17:47:33 +00:00
},
2024-02-17 17:51:52 +00:00
"show_timespan_in": []
2024-02-09 19:14:17 +00:00
},
2024-02-18 14:12:04 +00:00
"description": "The design information of the CV. The default is the classic theme.",
2024-02-17 17:47:33 +00:00
"discriminator": {
"mapping": {
"classic": "#/$defs/ClassicThemeOptions",
"moderncv": "#/$defs/ModerncvThemeOptions",
"sb2nov": "#/$defs/Sb2novThemeOptions"
},
"propertyName": "theme"
},
"oneOf": [
{
"$ref": "#/$defs/ClassicThemeOptions"
},
{
"$ref": "#/$defs/ModerncvThemeOptions"
},
{
"$ref": "#/$defs/Sb2novThemeOptions"
}
],
2024-02-06 17:40:39 +00:00
"title": "Design"
2023-10-19 18:02:14 +00:00
}
},
2024-02-06 17:40:39 +00:00
"required": [
2024-02-09 19:14:17 +00:00
"cv"
2024-02-06 17:40:39 +00:00
],
"title": "RenderCV",
2023-10-19 18:02:14 +00:00
"type": "object",
"$id": "https://raw.githubusercontent.com/sinaatalay/rendercv/main/schema.json",
"$schema": "http://json-schema.org/draft-07/schema#"
}