Doc Twig UI blocks

This commit is contained in:
Eric Espie
2022-11-10 19:01:07 +01:00
parent cf84b8c08a
commit 43591e59e3
6 changed files with 324 additions and 0 deletions

View File

@@ -0,0 +1,177 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>UI Components &mdash; iTop UI iTop 3.1.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Alert" href="Alert/Alert.html" />
<link rel="prev" title="4. Adding new operations" href="../../TwigBaseTuto/Step4/Step4.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> iTop UI
<img src="../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">UI Components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Alert/Alert.html">Alert</a></li>
<li class="toctree-l2"><a class="reference internal" href="Button/Button.html">Button</a></li>
<li class="toctree-l2"><a class="reference internal" href="ButtonGroup/ButtonGroup.html">ButtonGroup</a></li>
<li class="toctree-l2"><a class="reference internal" href="CollapsibleSection/CollapsibleSection.html">CollapsibleSection</a></li>
<li class="toctree-l2"><a class="reference internal" href="DataTable/DataTable.html">DataTable</a></li>
<li class="toctree-l2"><a class="reference internal" href="Field/Field.html">Field</a></li>
<li class="toctree-l2"><a class="reference internal" href="FieldBadge/FieldBadge.html">FieldBadge</a></li>
<li class="toctree-l2"><a class="reference internal" href="FieldSet/FieldSet.html">FieldSet</a></li>
<li class="toctree-l2"><a class="reference internal" href="Form/Form.html">Form</a></li>
<li class="toctree-l2"><a class="reference internal" href="Input/FileSelect/FileSelect.html">FileSelect</a></li>
<li class="toctree-l2"><a class="reference internal" href="Input/Input.html">Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="Input/Select/Select.html">Select</a></li>
<li class="toctree-l2"><a class="reference internal" href="Input/Select/SelectOption.html">SelectOption</a></li>
<li class="toctree-l2"><a class="reference internal" href="Panel/Panel.html">Panel</a></li>
<li class="toctree-l2"><a class="reference internal" href="Spinner/Spinner.html">Spinner</a></li>
<li class="toctree-l2"><a class="reference internal" href="Title/Title.html">Title</a></li>
<li class="toctree-l2"><a class="reference internal" href="Toolbar/Toolbar.html">Toolbar</a></li>
<li class="toctree-l2"><a class="reference internal" href="Toolbar/ToolbarSpacer/ToolbarSpacer.html">ToolbarSpacer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Layout/Layout.html">UI Layouts</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li>UI Components</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="ui-components">
<span id="components"></span><h1>UI Components<a class="headerlink" href="#ui-components" title="Permalink to this headline"></a></h1>
<p>A UI component is a unitary block used to display information in iTop console.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Components:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Alert/Alert.html">Alert</a></li>
<li class="toctree-l1"><a class="reference internal" href="Button/Button.html">Button</a></li>
<li class="toctree-l1"><a class="reference internal" href="ButtonGroup/ButtonGroup.html">ButtonGroup</a></li>
<li class="toctree-l1"><a class="reference internal" href="CollapsibleSection/CollapsibleSection.html">CollapsibleSection</a></li>
<li class="toctree-l1"><a class="reference internal" href="DataTable/DataTable.html">DataTable</a></li>
<li class="toctree-l1"><a class="reference internal" href="Field/Field.html">Field</a></li>
<li class="toctree-l1"><a class="reference internal" href="FieldBadge/FieldBadge.html">FieldBadge</a></li>
<li class="toctree-l1"><a class="reference internal" href="FieldSet/FieldSet.html">FieldSet</a></li>
<li class="toctree-l1"><a class="reference internal" href="Form/Form.html">Form</a></li>
<li class="toctree-l1"><a class="reference internal" href="Input/FileSelect/FileSelect.html">FileSelect</a></li>
<li class="toctree-l1"><a class="reference internal" href="Input/Input.html">Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="Input/Select/Select.html">Select</a></li>
<li class="toctree-l1"><a class="reference internal" href="Input/Select/SelectOption.html">SelectOption</a></li>
<li class="toctree-l1"><a class="reference internal" href="Panel/Panel.html">Panel</a></li>
<li class="toctree-l1"><a class="reference internal" href="Spinner/Spinner.html">Spinner</a></li>
<li class="toctree-l1"><a class="reference internal" href="Title/Title.html">Title</a></li>
<li class="toctree-l1"><a class="reference internal" href="Toolbar/Toolbar.html">Toolbar</a></li>
<li class="toctree-l1"><a class="reference internal" href="Toolbar/ToolbarSpacer/ToolbarSpacer.html">ToolbarSpacer</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../../TwigBaseTuto/Step4/Step4.html" class="btn btn-neutral float-left" title="4. Adding new operations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Alert/Alert.html" class="btn btn-neutral float-right" title="Alert" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Combodo.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<!--
~ @copyright Copyright (C) 2010-2022 Combodo SARL
~ @license http://opensource.org/licenses/AGPL-3.0
-->
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
v: documentation/3.0
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Branches</dt>
<dd><a href="Component.html">documentation/3.0</a></dd>
<dd><a href="../../../latest/generated/Component/Component.html">documentation/latest</a></dd>
</dl>
</div>
</div><script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -0,0 +1,147 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>UI Layouts &mdash; iTop UI iTop 3.1.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Column" href="MultiColumn/Column/Column.html" />
<link rel="prev" title="ToolbarSpacer" href="../Component/Toolbar/ToolbarSpacer/ToolbarSpacer.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> iTop UI
<img src="../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../Component/Component.html">UI Components</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">UI Layouts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="MultiColumn/Column/Column.html">Column</a></li>
<li class="toctree-l2"><a class="reference internal" href="MultiColumn/MultiColumn.html">MultiColumn</a></li>
<li class="toctree-l2"><a class="reference internal" href="UIContentBlock.html">UIContentBlock</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">iTop UI</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li>UI Layouts</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="ui-layouts">
<span id="layouts"></span><h1>UI Layouts<a class="headerlink" href="#ui-layouts" title="Permalink to this headline"></a></h1>
<p>A UI block that serves as a layout for the page.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Components:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="MultiColumn/Column/Column.html">Column</a></li>
<li class="toctree-l1"><a class="reference internal" href="MultiColumn/MultiColumn.html">MultiColumn</a></li>
<li class="toctree-l1"><a class="reference internal" href="UIContentBlock.html">UIContentBlock</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../Component/Toolbar/ToolbarSpacer/ToolbarSpacer.html" class="btn btn-neutral float-left" title="ToolbarSpacer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="MultiColumn/Column/Column.html" class="btn btn-neutral float-right" title="Column" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Combodo.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<!--
~ @copyright Copyright (C) 2010-2022 Combodo SARL
~ @license http://opensource.org/licenses/AGPL-3.0
-->
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
v: documentation/3.0
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Branches</dt>
<dd><a href="Layout.html">documentation/3.0</a></dd>
<dd><a href="../../../latest/generated/Layout/Layout.html">documentation/latest</a></dd>
</dl>
</div>
</div><script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>