From 896d9f237d8dbff631778b6f309a75bd278a4767 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Loi=CC=88c=20Correnson?= <loic.correnson@cea.fr>
Date: Tue, 18 Feb 2020 13:11:01 +0100
Subject: [PATCH] [dome/jsdoc] doc page layouts
---
ivette/src/dome/doc/README.md | 10 +++++-----
.../dome/doc/template/static/styles/jsdoc-default.css | 6 +++---
ivette/src/dome/doc/template/tmpl/container.tmpl | 4 +++-
ivette/src/dome/doc/tutorials/glossary.md | 2 +-
ivette/src/dome/doc/tutorials/icons.md | 3 +++
ivette/src/dome/doc/tutorials/index.json | 3 ++-
ivette/src/dome/template/makefile | 2 +-
7 files changed, 18 insertions(+), 12 deletions(-)
create mode 100644 ivette/src/dome/doc/tutorials/icons.md
diff --git a/ivette/src/dome/doc/README.md b/ivette/src/dome/doc/README.md
index 1d046ec45e3..8559ab10dac 100644
--- a/ivette/src/dome/doc/README.md
+++ b/ivette/src/dome/doc/README.md
@@ -12,15 +12,15 @@ The **Dome** framework provides you with the following facilities:
- easy integration with any other React components from your own
- binary distribution for all supported platform (Windows, Linux and MacOS)
-# Tutorials
+## To Start With
- [Quick Start](tutorial-quickstart.html)
- [Live Editing](tutorial-hotreload.html)
- [Application Design](tutorial-application.html)
-- [Styling Components](tutorial-styling.html)
-- [System Services](tutorial-services.html)
+- [Application Development](tutorial-development.html)
-# References
+## References
-- [Icon Gallery](gallery-icons.html)
+- [Custom Hooks](tutorial-hooks.html)
+- [Icon Gallery](tutorial-icons.html)
- [Glossary](tutorial-glossary.html)
diff --git a/ivette/src/dome/doc/template/static/styles/jsdoc-default.css b/ivette/src/dome/doc/template/static/styles/jsdoc-default.css
index f12f3f6d62c..05743bc519b 100644
--- a/ivette/src/dome/doc/template/static/styles/jsdoc-default.css
+++ b/ivette/src/dome/doc/template/static/styles/jsdoc-default.css
@@ -131,11 +131,10 @@ article dl {
}
div.summary {
- margin-top: 10px ;
- margin-bottom: 10px ;
+ margin-top: 12px ;
+ margin-bottom: 12px ;
padding-left: 20px ;
padding-bottom: 10px ;
- border-bottom: thin solid #c0c0c0 ;
}
table.summary { }
@@ -211,6 +210,7 @@ footer {
padding: 6px;
margin-top: 12px;
margin-left: 20px;
+ border-top: thin solid #c0c0c0 ;
}
h1, h2, h3, h4 {
diff --git a/ivette/src/dome/doc/template/tmpl/container.tmpl b/ivette/src/dome/doc/template/tmpl/container.tmpl
index 6d77d043120..3fc3db4f08e 100644
--- a/ivette/src/dome/doc/template/tmpl/container.tmpl
+++ b/ivette/src/dome/doc/template/tmpl/container.tmpl
@@ -169,7 +169,8 @@
?>
<h3 class="subsection-title">Summary</h3>
- <table class="list-index">
+ <div class="summary">
+ <table class="summary">
<?js hasMembers && members.forEach(function(m) { ?>
<tr class="list-item">
<td class="list-title">
@@ -198,6 +199,7 @@
</tr>
<?js }); ?>
</table>
+ </div>
<?js } ?>
diff --git a/ivette/src/dome/doc/tutorials/glossary.md b/ivette/src/dome/doc/tutorials/glossary.md
index b8f8e0e09a6..1368e8e25b9 100644
--- a/ivette/src/dome/doc/tutorials/glossary.md
+++ b/ivette/src/dome/doc/tutorials/glossary.md
@@ -10,7 +10,7 @@
## Component Properties
- `id` an element identifier
-- `icon` an icon identifier, as listed in the [gallery](gallery-icons.html)
+- `icon` an icon identifier, as listed in the [icon gallery](tutorial-icons.html)
- `label` a short text used as the displayed title of a component
- `text` textual content to be printed on screen
- `title` a description for a component, usually provided in a tooltip box
diff --git a/ivette/src/dome/doc/tutorials/icons.md b/ivette/src/dome/doc/tutorials/icons.md
new file mode 100644
index 00000000000..ee71eb82740
--- /dev/null
+++ b/ivette/src/dome/doc/tutorials/icons.md
@@ -0,0 +1,3 @@
+<!-- Icon Gallery -->
+
+<!-- (Generated) -->
diff --git a/ivette/src/dome/doc/tutorials/index.json b/ivette/src/dome/doc/tutorials/index.json
index 991424831e0..981c5505336 100644
--- a/ivette/src/dome/doc/tutorials/index.json
+++ b/ivette/src/dome/doc/tutorials/index.json
@@ -5,5 +5,6 @@
"hooks": { "order": 4, "title": "Custom React Hooks" },
"hotreload": { "order": 5, "title": "Live Editing" },
"styling": { "order": 7, "title": "Styling Components" },
- "glossary": { "order": 8, "title": "Glossary" }
+ "icons": { "order": 8, "title": "Icon Gallery" },
+ "glossary": { "order": 9, "title": "Glossary" }
}
diff --git a/ivette/src/dome/template/makefile b/ivette/src/dome/template/makefile
index 60f33e88fe6..d2875074a8c 100644
--- a/ivette/src/dome/template/makefile
+++ b/ivette/src/dome/template/makefile
@@ -366,7 +366,7 @@ dome-doc: $(DOME_MK_BIN)/jsdoc $(DOME_MK_ICON_HTML)
$(DOME)/doc/template/gallery-head.html \
$(DOME)/doc/template/gallery-icons.html \
$(DOME)/doc/template/gallery-tail.html \
- > $(DOME_DOC)/gallery-icons.html
+ > $(DOME_DOC)/tutorial-icons.html
@echo "[Dome] $(DOME_DOC)/index.html"
# --- Doc binaries ---------------------------------------------------------
--
GitLab