From b9bf6b606593dd0af2976963df3a9d9dcb3f8c5b Mon Sep 17 00:00:00 2001 From: Hanno Klein Date: Thu, 12 Sep 2024 12:26:20 +0200 Subject: [PATCH 1/3] Add documentation purposes with definitions --- .../main/resources/xsd/repositorytypes.xsd | 31 +++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/repository/src/main/resources/xsd/repositorytypes.xsd b/repository/src/main/resources/xsd/repositorytypes.xsd index 758e034..f2a8be4 100644 --- a/repository/src/main/resources/xsd/repositorytypes.xsd +++ b/repository/src/main/resources/xsd/repositorytypes.xsd @@ -826,14 +826,41 @@ + + + Brief summary of the element, typically highlighting its key function or purpose, restricted to one paragraph for conciseness. + + + + Detailed explanation of the element, clarifying its usage, functionality, or background. + + + + Sample or illustration demonstrating how the element is used in practice. + - For UI when different from canonical name; may - have multi-language displays + + For UI when different from canonical name; may have multi-language displays. + + + + + Descriptive label or title for the element, may be used for tables, figures, headings or brief annotations. + + + + + Short message or hint that appears when hovering over the element, usually explaining its function or use. + + + + Precise and formal explanation of the element, restricted to one sentence in length to ensure brevity. + From 8599c8aca50fe6f5aa83f88b34f2f41743c79eb6 Mon Sep 17 00:00:00 2001 From: Hanno Klein Date: Thu, 12 Sep 2024 13:19:02 +0200 Subject: [PATCH 2/3] Remove duplicate closing element --- repository/src/main/resources/xsd/repositorytypes.xsd | 1 - 1 file changed, 1 deletion(-) diff --git a/repository/src/main/resources/xsd/repositorytypes.xsd b/repository/src/main/resources/xsd/repositorytypes.xsd index f2a8be4..86c3f76 100644 --- a/repository/src/main/resources/xsd/repositorytypes.xsd +++ b/repository/src/main/resources/xsd/repositorytypes.xsd @@ -854,7 +854,6 @@ Short message or hint that appears when hovering over the element, usually explaining its function or use. - From a4ee542f57d1b76f360856c56be7374d564bac12 Mon Sep 17 00:00:00 2001 From: Hanno Klein Date: Thu, 12 Sep 2024 13:22:55 +0200 Subject: [PATCH 3/3] Correct XML syntax errors --- .../src/main/resources/xsd/repositorytypes.xsd | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/repository/src/main/resources/xsd/repositorytypes.xsd b/repository/src/main/resources/xsd/repositorytypes.xsd index 86c3f76..8d7fd85 100644 --- a/repository/src/main/resources/xsd/repositorytypes.xsd +++ b/repository/src/main/resources/xsd/repositorytypes.xsd @@ -825,36 +825,42 @@ Recommended annotation purposes - + Brief summary of the element, typically highlighting its key function or purpose, restricted to one paragraph for conciseness. - + + Detailed explanation of the element, clarifying its usage, functionality, or background. - + + Sample or illustration demonstrating how the element is used in practice. + For UI when different from canonical name; may have multi-language displays. + Descriptive label or title for the element, may be used for tables, figures, headings or brief annotations. + Short message or hint that appears when hovering over the element, usually explaining its function or use. +