Compare commits
138 Commits
feature/90
...
feature/fa
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d2434c64d4 | ||
|
|
3bfd3560a6 | ||
|
|
ae98a86e9b | ||
|
|
428b57e270 | ||
|
|
2fe05a3947 | ||
|
|
99b4aa65ff | ||
|
|
dc1476359c | ||
|
|
703f3b0b6b | ||
|
|
bc6d7ccf19 | ||
|
|
fb5704e470 | ||
|
|
354a15e8dc | ||
|
|
f0d28bf1b6 | ||
|
|
727414f165 | ||
|
|
f9560005f4 | ||
|
|
c7fc7ed2b9 | ||
|
|
d9fbfcc26a | ||
|
|
634650ff37 | ||
|
|
d357b3195d | ||
|
|
eae33807e1 | ||
|
|
63c8558523 | ||
|
|
9775b70703 | ||
|
|
c4ef26f92a | ||
|
|
43150860c4 | ||
|
|
5f309350df | ||
|
|
6e9c6eeb23 | ||
|
|
c02f3202d9 | ||
|
|
513b671c4e | ||
|
|
4a837fff64 | ||
|
|
d3529f7443 | ||
|
|
5fa85eb05a | ||
|
|
8edc7c7ce0 | ||
|
|
38dcc29569 | ||
|
|
5da54f2525 | ||
|
|
39c1286aa6 | ||
|
|
f4839ef88f | ||
|
|
df9872cfd8 | ||
|
|
2cf249f58a | ||
|
|
57d2e85a7b | ||
|
|
ccad70e8ee | ||
|
|
674d2a261e | ||
|
|
5530c3cef2 | ||
|
|
08d7e086a1 | ||
|
|
ddad4717ff | ||
|
|
0d35f20bf4 | ||
|
|
725bbbeb4f | ||
|
|
6108d86a2b | ||
|
|
f0205002bc | ||
|
|
4834998179 | ||
|
|
595174e38e | ||
|
|
fd49f6b2c4 | ||
|
|
e9c168a4d1 | ||
|
|
e931b5ef9b | ||
|
|
d62f05e7a9 | ||
|
|
56494bc97f | ||
|
|
497d77d89c | ||
|
|
0659639b53 | ||
|
|
67332837ad | ||
|
|
0957b55883 | ||
|
|
232b91bbfe | ||
|
|
4362ef7a2d | ||
|
|
1eae9ff876 | ||
|
|
4b69a52a64 | ||
|
|
31e72d5631 | ||
|
|
7a79293cb4 | ||
|
|
a490efe7fa | ||
|
|
15c92440fb | ||
|
|
7d8710770a | ||
|
|
344890f84e | ||
|
|
27c87236cf | ||
|
|
4b0a3a001c | ||
|
|
c00987d1e9 | ||
|
|
bf37bfbd2d | ||
|
|
deb3dcbb73 | ||
|
|
6e001141a8 | ||
|
|
2f0ad03070 | ||
|
|
94fbb91ad2 | ||
|
|
9a9856fb0d | ||
|
|
c22f7e07e0 | ||
|
|
9c89687ed4 | ||
|
|
7a82ac5580 | ||
|
|
96bf56b51c | ||
|
|
862e49ba4e | ||
|
|
b87afed08a | ||
|
|
541231ee5e | ||
|
|
185b927a9c | ||
|
|
607038dbc6 | ||
|
|
94d05c0b71 | ||
|
|
c173535104 | ||
|
|
b74b43727d | ||
|
|
9cf776e7a4 | ||
|
|
d006131dba | ||
|
|
c0e1f9dcc0 | ||
|
|
da7d3731dc | ||
|
|
8fb2faa53f | ||
|
|
eb08d679e1 | ||
|
|
b280b28450 | ||
|
|
fe8e71fb40 | ||
|
|
5c2f479977 | ||
|
|
0c045b6a62 | ||
|
|
6aad57f4b6 | ||
|
|
11afccb012 | ||
|
|
9c476d8609 | ||
|
|
86510502a4 | ||
|
|
d493def6d7 | ||
|
|
324fe50a86 | ||
|
|
48c6ff8bb6 | ||
|
|
d77b10978e | ||
|
|
3eec045b67 | ||
|
|
3b20dfcae5 | ||
|
|
4379e49f3b | ||
|
|
dd26b40f12 | ||
|
|
59b439ead0 | ||
|
|
471ec86c82 | ||
|
|
2a71a3f153 | ||
|
|
4e82e9a580 | ||
|
|
5a4cb9a133 | ||
|
|
3384ed23bc | ||
|
|
3c20a417ad | ||
|
|
8df9afdce2 | ||
|
|
27cdabe383 | ||
|
|
f46cf9ed2c | ||
|
|
4cf141b433 | ||
|
|
75aeb4245b | ||
|
|
e9d4ecc85c | ||
|
|
cd9c637244 | ||
|
|
f079a9bebb | ||
|
|
4f05ac25f5 | ||
|
|
560b104d64 | ||
|
|
23b67f9fd7 | ||
|
|
1fbb94e265 | ||
|
|
8b591a5c0a | ||
|
|
33bd83d680 | ||
|
|
f90799d046 | ||
|
|
6191719f50 | ||
|
|
d3580dd2c7 | ||
|
|
e246e79eeb | ||
|
|
9405eae922 | ||
|
|
05e15bd9c0 |
20
.doc/UI/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = ../../docs/UI
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)$@" $(SPHINXOPTS) $(O)
|
||||
73
.doc/UI/README.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Twig based UI blocks documentation
|
||||
|
||||
This documentation explains how to use UI blocks (new in 3.0) in twig based extensions.
|
||||
|
||||
# How to build UI Documentation
|
||||
|
||||
## Install sphinx
|
||||
|
||||
### Windows users
|
||||
|
||||
Install Python from https://www.python.org/downloads/windows/
|
||||
|
||||
Under `.doc/UI`, run
|
||||
|
||||
```
|
||||
pip install -U sphinx
|
||||
pip install sphinx-rtd-theme
|
||||
pip install myst-parser
|
||||
pip install sphinx-multiversion
|
||||
```
|
||||
|
||||
### Linux users
|
||||
|
||||
You should have Python installed.
|
||||
|
||||
Under `.doc/UI`, run
|
||||
|
||||
```
|
||||
sudo apt-get install python3-sphinx
|
||||
pip install sphinx-rtd-theme
|
||||
pip install myst-parser
|
||||
pip install sphinx-multiversion
|
||||
```
|
||||
|
||||
## Documentations
|
||||
|
||||
* sphinx https://www.sphinx-doc.org/en/master/
|
||||
* sphinx-multiversion https://holzhaus.github.io/sphinx-multiversion/master/index.html
|
||||
* Read the Docs https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
|
||||
* RST https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
|
||||
* MyST https://myst-parser.readthedocs.io/en/latest/
|
||||
|
||||
## Generating the documentation
|
||||
|
||||
### Generating the documentation source from the actual code
|
||||
|
||||
Under `.doc/UI`
|
||||
|
||||
```
|
||||
php bin/generate_uiblock.php
|
||||
```
|
||||
|
||||
When the source have not changed, just regenerate the documentation using the following methods.
|
||||
|
||||
### Regenerating the doc
|
||||
|
||||
#### Windows users
|
||||
|
||||
Under `.doc/UI`
|
||||
```
|
||||
make.bat html
|
||||
```
|
||||
|
||||
The documentation is generated into `.doc/UI/build/html`
|
||||
|
||||
#### Linux users
|
||||
|
||||
Under `.doc/UI`, run
|
||||
```
|
||||
make html
|
||||
```
|
||||
|
||||
The documentation is generated into `.doc/UI/build/html`
|
||||
551
.doc/UI/bin/generate_uiblock.php
Normal file
@@ -0,0 +1,551 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2021 Combodo SARL
|
||||
* @license http://opensource.org/licenses/AGPL-3.0
|
||||
*/
|
||||
|
||||
namespace Combodo\iTop\Documentation\UI;
|
||||
|
||||
use Exception;
|
||||
use ReflectionClass;
|
||||
use ReflectionException;
|
||||
use ReflectionMethod;
|
||||
use ReflectionNamedType;
|
||||
use utils;
|
||||
|
||||
chdir(__DIR__);
|
||||
|
||||
require_once '../../../approot.inc.php';
|
||||
require_once(APPROOT.'application/startup.inc.php');
|
||||
|
||||
function log($sMsg)
|
||||
{
|
||||
$sDate = date('Y-m-d H:i:s');
|
||||
echo "{$sDate} - {$sMsg}\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Echo an RST array of aParams filtered by aColumns
|
||||
*
|
||||
* @param array $aParams
|
||||
* @param array $aColumns
|
||||
*/
|
||||
function DisplayParamsArray(array $aParams, array $aColumns)
|
||||
{
|
||||
foreach ($aParams as $aParam) {
|
||||
foreach ($aColumns as $sColName => $iMax) {
|
||||
$iLen = strlen($aParam[$sColName]);
|
||||
if ($iLen > $iMax) {
|
||||
$aColumns[$sColName] = $iLen;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$sArrayLine = '+';
|
||||
foreach ($aColumns as $iMax) {
|
||||
$sArrayLine .= str_repeat('-', $iMax + 2).'+';
|
||||
}
|
||||
echo "$sArrayLine\n";
|
||||
foreach ($aParams as $aParam) {
|
||||
foreach ($aColumns as $sColName => $iMax) {
|
||||
echo '| '.str_pad($aParam[$sColName], $iMax).' ';
|
||||
}
|
||||
echo "|\n";
|
||||
echo "$sArrayLine\n";
|
||||
}
|
||||
echo "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate the syntax for the given aParams
|
||||
*
|
||||
* @param array $aParams
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
function DisplayParamsAsString(array $aParams): string
|
||||
{
|
||||
$aParamStr = [];
|
||||
foreach ($aParams as $aParam) {
|
||||
$sParam = $aParam['name'].':';
|
||||
switch ($aParam['type']) {
|
||||
case 'string':
|
||||
$sParam .= "'value'";
|
||||
break;
|
||||
|
||||
case 'array':
|
||||
$sParam .= "{name:value, name:value}";
|
||||
break;
|
||||
|
||||
case 'bool':
|
||||
$sParam .= "true";
|
||||
break;
|
||||
|
||||
default:
|
||||
$sParam .= "value";
|
||||
break;
|
||||
}
|
||||
$aParamStr[] = $sParam;
|
||||
}
|
||||
|
||||
return implode(', ', $aParamStr);
|
||||
}
|
||||
|
||||
/**
|
||||
* Echo the generated rst file for the given class
|
||||
*
|
||||
* @param string $sClass
|
||||
* @param string $sClassComment
|
||||
* @param string $sDir
|
||||
* @param string $sTag
|
||||
* @param bool $bHasSubBlocks
|
||||
* @param array $aDocTypes
|
||||
* @param array $aDocGeneralParams
|
||||
*/
|
||||
function output(string $sClass, string $sClassComment, string $sDir, string $sTag, bool $bHasSubBlocks, array $aDocTypes, array $aDocGeneralParams)
|
||||
{
|
||||
if ($bHasSubBlocks) {
|
||||
$sSyntax = <<<EOF
|
||||
{% $sTag Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% End$sTag %}
|
||||
EOF;
|
||||
} else {
|
||||
$sSyntax = <<<EOF
|
||||
{% $sTag Type {Parameters} %}
|
||||
EOF;
|
||||
}
|
||||
|
||||
$sYear = date('Y');
|
||||
|
||||
echo ".. Copyright (C) 2010-$sYear Combodo SARL\n";
|
||||
echo ".. http://opensource.org/licenses/AGPL-3.0\n";
|
||||
echo "\n";
|
||||
echo ".. _$sClass:\n";
|
||||
echo "\n";
|
||||
echo "$sClass\n";
|
||||
$sLine = str_repeat('=', strlen($sClass));
|
||||
echo "$sLine\n";
|
||||
echo "\n";
|
||||
echo "$sClassComment\n";
|
||||
echo "\n";
|
||||
echo "----\n";
|
||||
echo "\n";
|
||||
echo ".. include:: /manual/{$sDir}AdditionalDescription.rst\n";
|
||||
echo "\n";
|
||||
echo "----\n";
|
||||
echo "\n";
|
||||
echo "Twig Tag\n";
|
||||
echo "--------\n";
|
||||
echo "\n";
|
||||
echo ":Tag: **$sTag**\n";
|
||||
echo "\n";
|
||||
echo ":Syntax:\n";
|
||||
echo "\n";
|
||||
echo ".. code-block:: twig\n";
|
||||
echo "\n";
|
||||
echo "$sSyntax\n";
|
||||
echo "\n";
|
||||
echo ":Type:\n";
|
||||
echo "\n";
|
||||
$iMaxLength = 0;
|
||||
$iMaxComLength = 0;
|
||||
foreach ($aDocTypes as $sType => $aDoc) {
|
||||
$sComment = $aDoc['comment'];
|
||||
$sType = ":ref:`$sType <$sClass$sType>`";
|
||||
$iLength = strlen($sType);
|
||||
if ($iLength > $iMaxLength) {
|
||||
$iMaxLength = $iLength;
|
||||
}
|
||||
$iComLength = strlen($sComment);
|
||||
if ($iComLength > $iMaxComLength) {
|
||||
$iMaxComLength = $iComLength;
|
||||
}
|
||||
}
|
||||
$sArrayLine = '+'.str_repeat('-', $iMaxLength + 2).'+'.str_repeat('-', $iMaxComLength + 2).'+';
|
||||
echo "$sArrayLine\n";
|
||||
foreach ($aDocTypes as $sType => $aDoc) {
|
||||
$sComment = $aDoc['comment'];
|
||||
$sType = ":ref:`$sType <$sClass$sType>`";
|
||||
echo '| '.str_pad($sType, $iMaxLength).' | '.str_pad($sComment, $iMaxComLength)." |\n";
|
||||
echo "$sArrayLine\n";
|
||||
}
|
||||
echo "\n";
|
||||
|
||||
// Parameters for each type
|
||||
foreach ($aDocTypes as $sType => $aDoc) {
|
||||
$aParams = $aDoc['params'];
|
||||
if (!empty($aParams)) {
|
||||
echo ".. _$sClass$sType:\n";
|
||||
echo "\n";
|
||||
echo "$sClass $sType\n";
|
||||
echo str_repeat("^", strlen("$sClass $sType"));
|
||||
echo "\n";
|
||||
echo "\n";
|
||||
echo ":syntax:\n";
|
||||
echo "\n";
|
||||
echo ".. code-block:: twig\n";
|
||||
echo "\n";
|
||||
$sParameters = DisplayParamsAsString($aParams);
|
||||
if ($bHasSubBlocks) {
|
||||
$sSyntax = <<<EOF
|
||||
{% $sTag $sType {{$sParameters}} %}
|
||||
Content Goes Here
|
||||
{% End$sTag %}
|
||||
EOF;
|
||||
} else {
|
||||
$sSyntax = <<<EOF
|
||||
{% $sTag $sType {{$sParameters}} %}
|
||||
EOF;
|
||||
}
|
||||
echo "$sSyntax\n";
|
||||
echo "\n";
|
||||
echo ":parameters:\n";
|
||||
echo "\n";
|
||||
$aColumns = [
|
||||
'name' => 0,
|
||||
'type' => 0,
|
||||
'status' => 0,
|
||||
'default' => 0,
|
||||
'comment' => 0,
|
||||
];
|
||||
DisplayParamsArray($aParams, $aColumns);
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($aDocGeneralParams)) {
|
||||
echo "$sClass common parameters\n";
|
||||
echo str_repeat("^", strlen("$sClass common parameters"));
|
||||
echo "\n\n";
|
||||
$aColumns = [
|
||||
'name' => 0,
|
||||
'type' => 0,
|
||||
'comment' => 0,
|
||||
];
|
||||
usort($aDocGeneralParams, function ($a, $b) {
|
||||
return strcmp($a['name'], $b['name']);
|
||||
});
|
||||
DisplayParamsArray($aDocGeneralParams, $aColumns);
|
||||
}
|
||||
|
||||
echo "----\n";
|
||||
echo "\n";
|
||||
echo ".. include:: /manual/{$sDir}Footer.rst\n";
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Get parameters info from a method
|
||||
*
|
||||
* @param \ReflectionMethod $oMethod
|
||||
*
|
||||
* @return array
|
||||
* @throws \ReflectionException
|
||||
*/
|
||||
function GetMethodParameters(ReflectionMethod $oMethod): array
|
||||
{
|
||||
$aDocParams = [];
|
||||
$aParameters = $oMethod->getParameters();
|
||||
$sFullComment = $oMethod->getDocComment();
|
||||
foreach ($aParameters as $oParameter) {
|
||||
$sName = $oParameter->getName();
|
||||
$aDocParam['name'] = $sName;
|
||||
if ($oParameter->isOptional()) {
|
||||
$aDocParam['status'] = 'optional';
|
||||
$sDefault = $oParameter->getDefaultValue();
|
||||
$aDocParam['default'] = str_replace("\n", '', var_export($sDefault, true));
|
||||
} else {
|
||||
$aDocParam['status'] = 'mandatory';
|
||||
$aDocParam['default'] = '';
|
||||
}
|
||||
|
||||
$oParamType = $oParameter->getType();
|
||||
if ($oParamType instanceof ReflectionNamedType) {
|
||||
$sType = $oParamType->getName();
|
||||
$iPos = strrpos($sType, "\\");
|
||||
if ($iPos !== false) {
|
||||
$sType = substr($sType, $iPos + 1);
|
||||
}
|
||||
$aDocParam['type'] = $sType;
|
||||
} else {
|
||||
$aDocParam['type'] = '';
|
||||
}
|
||||
|
||||
// Get the comment for the param from method comment
|
||||
if ($sFullComment !== false) {
|
||||
if (preg_match("#^\s*\*\s*@param\s+\S*\s*.$sName(?<comment>.*)$#m", $sFullComment, $aMatches)) {
|
||||
$sComment = trim($aMatches['comment']);
|
||||
if (preg_match("#^{@see (?<class>\S+)::.(?<property>\S+)}#", $sComment, $aMatches)) {
|
||||
// Reference to a property of another class
|
||||
$sClassName = $aMatches['class'];
|
||||
$sProperty = $aMatches['property'];
|
||||
try {
|
||||
GetPropertyComment($sClassName, $sProperty, $sComment);
|
||||
}
|
||||
catch (ReflectionException $e) {
|
||||
// Try with the current name space
|
||||
$oLocalClass = new ReflectionClass($oMethod->class);
|
||||
$sNameSpace = $oLocalClass->getNamespaceName();
|
||||
$sClass = $sNameSpace.'\\'.$sClassName;
|
||||
try {
|
||||
GetPropertyComment($sClass, $sProperty, $sComment);
|
||||
}
|
||||
catch (ReflectionException $e) {
|
||||
// Search in the autoloader
|
||||
$sAutoloadFile = APPROOT.'lib/composer/autoload_classmap.php';
|
||||
$aTmpClassMap = include $sAutoloadFile;
|
||||
foreach (array_keys($aTmpClassMap) as $sClass) {
|
||||
if (utils::EndsWith($sClass, '\\'.$sClassName)) {
|
||||
try {
|
||||
GetPropertyComment($sClass, $sProperty, $sComment);
|
||||
break;
|
||||
}
|
||||
catch (ReflectionException $e) {
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$sComment = '';
|
||||
}
|
||||
} else {
|
||||
$sComment = '';
|
||||
}
|
||||
$aDocParam['comment'] = $sComment;
|
||||
$aDocParams[] = $aDocParam;
|
||||
}
|
||||
|
||||
return $aDocParams;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the comment for a class property (variable)
|
||||
*
|
||||
* @param $sClass
|
||||
* @param $sProperty
|
||||
* @param $sComment
|
||||
*
|
||||
* @throws \ReflectionException when class or property does not exist
|
||||
*/
|
||||
function GetPropertyComment($sClass, $sProperty, &$sComment): void
|
||||
{
|
||||
$oTargetClass = new ReflectionClass($sClass);
|
||||
$oProperty = $oTargetClass->getProperty($sProperty);
|
||||
$sComment = $oProperty->getDocComment();
|
||||
if (preg_match("#/\*\*\s*@var\s+\S+(\s+$sProperty)?\s+(?<comment>.*)\*/#", $sComment, $aMatches)) {
|
||||
$sComment = trim($aMatches['comment']);
|
||||
}
|
||||
}
|
||||
|
||||
function GetMethodComment(ReflectionMethod $oMethod, string $sParamName)
|
||||
{
|
||||
$sComment = $oMethod->getDocComment();
|
||||
if (strpos($sComment, $sParamName) !== false) {
|
||||
return $sComment;
|
||||
}
|
||||
|
||||
//echo "- comment for $sParamName not found in ".$oMethod->class.":".$oMethod->name."\n";
|
||||
|
||||
// Try to find the comment in the parent class
|
||||
$oReflectionClass = new ReflectionClass($oMethod->class);
|
||||
$oReflectionParentClass = $oReflectionClass->getParentClass();
|
||||
if ($oReflectionParentClass === false) {
|
||||
$aReflectionParentClasses = $oReflectionClass->getInterfaces();
|
||||
foreach ($aReflectionParentClasses as $oReflectionParentClass) {
|
||||
try {
|
||||
$oParentMethod = $oReflectionParentClass->getMethod($oMethod->name);
|
||||
}
|
||||
catch (ReflectionException $e) {
|
||||
continue;
|
||||
}
|
||||
$sComment = GetMethodComment($oParentMethod, $sParamName);
|
||||
if (!empty($sComment)) {
|
||||
return $sComment;
|
||||
}
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
try {
|
||||
$oParentMethod = $oReflectionParentClass->getMethod($oMethod->name);
|
||||
}
|
||||
catch (ReflectionException $e) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return GetMethodComment($oParentMethod, $sParamName);
|
||||
}
|
||||
|
||||
/////////////////////////////
|
||||
/// Main
|
||||
///
|
||||
|
||||
if (!utils::IsModeCLI()) {
|
||||
echo "Only CLI mode is allowed\n";
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$sUIBlock = utils::ReadParam('uiblock', '', true);
|
||||
|
||||
$sSourceDir = '../source';
|
||||
|
||||
$sInterface = "Combodo\\iTop\\Application\\UI\\Base\\iUIBlockFactory";
|
||||
$aFactoryClasses = utils::GetClassesForInterface($sInterface, $sUIBlock.'UIBlockFactory');
|
||||
|
||||
|
||||
foreach ($aFactoryClasses as $sFactoryClass) {
|
||||
try {
|
||||
$sTag = call_user_func([$sFactoryClass, 'GetTwigTagName']);
|
||||
$sBlockClassName = call_user_func([$sFactoryClass, 'GetUIBlockClassName']);
|
||||
$bHasSubBlocks = is_subclass_of($sBlockClassName, "Combodo\\iTop\\Application\\UI\\Base\\Layout\\UIContentBlock") || $sBlockClassName == "Combodo\\iTop\\Application\\UI\\Base\\Layout\\UIContentBlock";
|
||||
|
||||
$oReflectionClassFactory = new ReflectionClass($sFactoryClass);
|
||||
$oReflectionClassUIBlock = new ReflectionClass($sBlockClassName);
|
||||
$sClassName = $oReflectionClassUIBlock->getShortName();
|
||||
|
||||
$aMethods = $oReflectionClassFactory->getMethods(ReflectionMethod::IS_PUBLIC);
|
||||
|
||||
$aDocTypes = [];
|
||||
foreach ($aMethods as $oMethod) {
|
||||
$sMethodName = $oMethod->name;
|
||||
if (utils::StartsWith($sMethodName, 'Make')) {
|
||||
$oMethod = $oReflectionClassFactory->getMethod($sMethodName);
|
||||
$sFullComment = $oMethod->getDocComment();
|
||||
if ($sFullComment !== false) {
|
||||
// Remove the first line
|
||||
$sComment = $sFullComment;
|
||||
$sComment = substr($sComment, strpos($sComment, "\n") + 1);
|
||||
$sComment = trim(substr($sComment, strpos($sComment, "*") + 1));
|
||||
// Remove the last lines
|
||||
$sComment = substr($sComment, 0, strpos($sComment, "\n"));
|
||||
} else {
|
||||
$sComment = 'No comment';
|
||||
}
|
||||
$sType = substr($sMethodName, strlen('Make'));
|
||||
$aDocType['comment'] = $sComment;
|
||||
|
||||
$aDocType['params'] = GetMethodParameters($oMethod);
|
||||
$aDocTypes[$sType] = $aDocType;
|
||||
}
|
||||
}
|
||||
|
||||
// Setters and Adders
|
||||
$aMethods = $oReflectionClassUIBlock->getMethods(ReflectionMethod::IS_PUBLIC);
|
||||
$aDocGeneralParams = [];
|
||||
foreach ($aMethods as $oMethod) {
|
||||
if (!$oMethod->isStatic() && $oMethod->getNumberOfParameters() == 1) {
|
||||
$sName = '';
|
||||
if (utils::StartsWith($oMethod->getName(), 'Set')) {
|
||||
$sName = substr($oMethod->getName(), 3); // remove 'Set' to get the variable name
|
||||
}
|
||||
if (utils::StartsWith($oMethod->getName(), 'Add')) {
|
||||
$sName = $oMethod->getName();
|
||||
}
|
||||
if (!empty($sName)) {
|
||||
// Get the param name
|
||||
$aParams = GetMethodParameters($oMethod)[0];
|
||||
$aParams['name'] = $sName;
|
||||
$aDocGeneralParams[] = $aParams;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Class comment
|
||||
$sFullClassComment = $oReflectionClassUIBlock->getDocComment();
|
||||
$aComments = preg_split("@\n@", $sFullClassComment);
|
||||
$aClassComments = [];
|
||||
// remove first line
|
||||
array_shift($aComments);
|
||||
while ($sComment = array_shift($aComments)) {
|
||||
if (utils::StartsWith($sComment, " * @")) {
|
||||
break;
|
||||
}
|
||||
$sComment = trim(preg_replace("@^ \*@", '', $sComment));
|
||||
if (strlen($sComment) > 0) {
|
||||
$aClassComments[] = $sComment;
|
||||
}
|
||||
}
|
||||
|
||||
$sClassComment = implode("\n", $aClassComments);
|
||||
|
||||
if (empty($sClassComment)) {
|
||||
$sClassComment = "Class $sClassName";
|
||||
}
|
||||
|
||||
$sDir = str_replace("Combodo\\iTop\\Application\\UI\\Base\\", '', $sBlockClassName);
|
||||
$sDir = str_replace("\\", '/', $sDir);
|
||||
|
||||
ob_start();
|
||||
output($sClassName, $sClassComment, $sDir, $sTag, $bHasSubBlocks, $aDocTypes, $aDocGeneralParams);
|
||||
$sContent = ob_get_contents();
|
||||
ob_end_clean();
|
||||
|
||||
$sFilename = $sSourceDir.'/generated/'.$sDir.'.rst';
|
||||
@mkdir(dirname($sFilename), 0775, true);
|
||||
file_put_contents($sFilename, $sContent);
|
||||
|
||||
// Check that manual files exists
|
||||
$sAdditionalDescription = $sSourceDir.'/manual/'.$sDir.'AdditionalDescription.rst';
|
||||
@mkdir(dirname($sAdditionalDescription), 0775, true);
|
||||
$sYear = date('Y');
|
||||
if (!is_file($sAdditionalDescription)) {
|
||||
file_put_contents($sAdditionalDescription, <<<EOF
|
||||
.. Copyright (C) 2010-$sYear Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Output
|
||||
------
|
||||
|
||||
No output provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/$sDir.png
|
||||
|
||||
|
||||
EOF
|
||||
);
|
||||
}
|
||||
$sFooter = $sSourceDir.'/manual/'.$sDir.'Footer.rst';
|
||||
@mkdir(dirname($sFooter), 0775, true);
|
||||
if (!is_file($sFooter)) {
|
||||
file_put_contents($sFooter, <<<EOF
|
||||
.. Copyright (C) 2010-$sYear Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
No examples provided yet
|
||||
|
||||
.. example of image
|
||||
.. image:: /manual/$sDir.png
|
||||
|
||||
EOF
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
echo "Generated $sFilename\n";
|
||||
}
|
||||
catch (Exception $e) {
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
// Rebuild doc
|
||||
$sRootDir = dirname(__DIR__);
|
||||
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
|
||||
echo "Windows build\n";
|
||||
echo shell_exec("$sRootDir/make.bat html");
|
||||
} else {
|
||||
echo "Linux build\n";
|
||||
shell_exec("$sRootDir/make html");
|
||||
}
|
||||
|
||||
|
||||
|
||||
35
.doc/UI/make.bat
Normal file
@@ -0,0 +1,35 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-multiversion
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=..\..\docs\UI
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% %SOURCEDIR% %BUILDDIR%/%1 %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
BIN
.doc/UI/source/TwigBase/MVC.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
29
.doc/UI/source/TwigBase/TwigBase.rst
Normal file
@@ -0,0 +1,29 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Twig Base Presentation
|
||||
======================
|
||||
|
||||
This feature is intended to help extension creators to design forms in a *modern* way.
|
||||
|
||||
The **Twig Base** feature is based on MVC structure:
|
||||
|
||||
.. image:: MVC.png
|
||||
|
||||
When creating an extension following this structure, some parts have to be done:
|
||||
|
||||
:Model:
|
||||
Optional part to define the specific data model for the extension
|
||||
|
||||
:Service:
|
||||
Recommended part to produce the data to be displayed
|
||||
|
||||
:Controller:
|
||||
Mandatory part to gather the data from the *Service* and display using the *View*.
|
||||
The *Controller* contains an automatic routing mechanism to be selected by the *operation* parameter.
|
||||
|
||||
:View:
|
||||
Mandatory part to display the data given by the *Controller*
|
||||
|
||||
:End point:
|
||||
Mandatory part receiving the request and calling the *Controller*
|
||||
BIN
.doc/UI/source/TwigBase/twig base.pptx
Normal file
70
.doc/UI/source/TwigBaseTuto/Step1/Step1.rst
Normal file
@@ -0,0 +1,70 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Step1:
|
||||
|
||||
1. Creating the structure
|
||||
=========================
|
||||
|
||||
Create a module using the `helper to create a new extension <https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Adatamodel#creating_your_own_extension>`_ you'll get the following structure::
|
||||
|
||||
my-module
|
||||
├── assets
|
||||
│ ├── css
|
||||
│ ├── img
|
||||
│ └── js
|
||||
├── doc
|
||||
├── src
|
||||
│ ├── Controller
|
||||
│ ├── Helper
|
||||
│ ├── Hook
|
||||
│ ├── Model
|
||||
│ └── Service
|
||||
└── vendor
|
||||
|
||||
``src/Controller``
|
||||
|
||||
Contains all the PHP to control the display of the different pages of the module.
|
||||
|
||||
``src/Service``
|
||||
|
||||
Contains the PHP used to generate the data to be displayed.
|
||||
|
||||
Create a folder ``templates`` for the *Twig* templates used for the presentation::
|
||||
|
||||
my-module
|
||||
├── assets
|
||||
│ ├── css
|
||||
│ ├── img
|
||||
│ └── js
|
||||
├── doc
|
||||
├── src
|
||||
│ ├── Controller
|
||||
│ ├── Helper
|
||||
│ ├── Hook
|
||||
│ ├── Model
|
||||
│ └── Service
|
||||
├── templates
|
||||
└── vendor
|
||||
|
||||
|
||||
If your module is for iTop version 3.0 and above, you can put all the dictionaries into a dedicated folder ``dictionaries``::
|
||||
|
||||
my-module
|
||||
├── assets
|
||||
│ ├── css
|
||||
│ ├── img
|
||||
│ └── js
|
||||
├── dictionaries
|
||||
├── doc
|
||||
├── src
|
||||
│ ├── Controller
|
||||
│ ├── Helper
|
||||
│ ├── Hook
|
||||
│ ├── Model
|
||||
│ └── Service
|
||||
├── templates
|
||||
└── vendor
|
||||
|
||||
|
||||
|
||||
BIN
.doc/UI/source/TwigBaseTuto/Step2/Setup.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
.doc/UI/source/TwigBaseTuto/Step2/Step2.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
124
.doc/UI/source/TwigBaseTuto/Step2/Step2.rst
Normal file
@@ -0,0 +1,124 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Step2:
|
||||
|
||||
2. Hello World!
|
||||
===============
|
||||
|
||||
The controller
|
||||
--------------
|
||||
|
||||
Create a controller into ``my-module/src/Controller``, let's call it ``MyModuleController`` extending ``Combodo\iTop\Application\TwigBase\Controller\Controller``
|
||||
|
||||
.. code-block:: php
|
||||
:linenos:
|
||||
:caption: src/Controller/MyModuleController.php
|
||||
|
||||
<?php
|
||||
|
||||
namespace MyCompany\iTop\MyModule\Controller;
|
||||
use Combodo\iTop\Application\TwigBase\Controller\Controller;
|
||||
|
||||
class MyModuleController extends Controller
|
||||
{
|
||||
}
|
||||
|
||||
Let's add a *Hello World* operation
|
||||
|
||||
.. code-block:: php
|
||||
:linenos:
|
||||
:caption: src/Controller/MyModuleController.php
|
||||
|
||||
<?php
|
||||
|
||||
class MyModuleController extends Controller
|
||||
{
|
||||
public function OperationHelloWorld()
|
||||
{
|
||||
$this->DisplayPage();
|
||||
}
|
||||
}
|
||||
|
||||
This will just display the Twig template corresponding to this operation.
|
||||
Here the operation is **HelloWorld** without space.
|
||||
The name of the method is built from the operation name by adding *Operation* at the beginning: ``OperationHelloWorld``.
|
||||
|
||||
Calling the method ``DisplayPage()`` will render the template named after the operation: ``HelloWorld.html.twig`` it will be located in the folder ``my-module/templates``.
|
||||
|
||||
The template
|
||||
------------
|
||||
|
||||
Let's create the template ``my-module/templates/HelloWorld.html.twig`` with a nice title.
|
||||
|
||||
.. code-block:: twig
|
||||
:linenos:
|
||||
:caption: templates/HelloWorld.html.twig
|
||||
|
||||
{% UITitle ForPage {sTitle:'Hello World!'} %}{% EndUITitle %}
|
||||
|
||||
Twig syntax can be found `Here <https://twig.symfony.com/doc/3.x/>`_.
|
||||
|
||||
For more information on specific iTop Twig tags you can check :ref:`Components` and :ref:`Layouts`, *note that UI blocks are new in iTop 3.0 and cannot be used in iTop 2.7*
|
||||
|
||||
The end point
|
||||
-------------
|
||||
|
||||
Then create landing page for your module ``my-module/index.php``
|
||||
|
||||
.. code-block:: php
|
||||
:linenos:
|
||||
:caption: index.php
|
||||
|
||||
<?php
|
||||
|
||||
namespace MyCompany\iTop\MyModule;
|
||||
|
||||
use MyCompany\iTop\MyModule\Controller\MyModuleController;
|
||||
|
||||
require_once(APPROOT.'application/startup.inc.php');
|
||||
|
||||
$oUpdateController = new MyModuleController(MODULESROOT.'my-module/templates', 'my-module');
|
||||
$oUpdateController->SetDefaultOperation('HelloWorld');
|
||||
$oUpdateController->HandleOperation();
|
||||
|
||||
Create an instance of the controller indicating the templates path and the module name.
|
||||
The default operation is set to the operation we want when entering the module.
|
||||
The method ``HandleOperation()`` will call the method corresponding to the specified operation.
|
||||
|
||||
Now you have to build the autoloader by running ``composer dump-autoload`` into the module folder ``my-module``.
|
||||
|
||||
The next operation is the `setup <https://www.itophub.io/wiki/page?id=latest%3Ainstall%3Ainstall_wizard>`_. You will be able to select your module.
|
||||
|
||||
.. image:: Setup.png
|
||||
|
||||
For more comfort during the development of your module, you can `install the toolkit <https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Adatamodel#installing_the_toolkit>`_ and update your iTop with symlinks.
|
||||
|
||||
if you go to your module page ``https://localhost/itop/pages/exec.php?exec_module=my-module&exec_page=index.php`` you should see:
|
||||
|
||||
.. image:: Step2.png
|
||||
|
||||
You will notice that if you work with an iTop from an official package (not the sources from ``https://github.com/Combodo/iTop``, when you modify the twig template, the result does not change.
|
||||
|
||||
In this case, you'll have to add the following parameter to your iTop configuration:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
|
||||
/**
|
||||
*
|
||||
* Configuration file, generated by the iTop configuration wizard
|
||||
*
|
||||
* The file is used in MetaModel::LoadConfig() which does all the necessary initialization job
|
||||
*
|
||||
*/
|
||||
$MySettings = array(
|
||||
// developer_mode.enabled: If true then unlocks dev env functionalities, see \utils::IsDevelopmentEnvironment
|
||||
'developer_mode.enabled' => true,
|
||||
|
||||
// ...
|
||||
);
|
||||
|
||||
|
||||
|
||||
BIN
.doc/UI/source/TwigBaseTuto/Step3/Hello2.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
.doc/UI/source/TwigBaseTuto/Step3/Hello3.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
93
.doc/UI/source/TwigBaseTuto/Step3/Step3.rst
Normal file
@@ -0,0 +1,93 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Step3:
|
||||
|
||||
3. Passing variables to templates
|
||||
=================================
|
||||
|
||||
We have seen in :ref:`Step2` how to create a static template. Let's send some variables to have a more dynamic display.
|
||||
|
||||
.. code-block:: php
|
||||
:linenos:
|
||||
:caption: src/Controller/MyModuleController.php
|
||||
|
||||
<?php
|
||||
|
||||
namespace MyCompany\iTop\MyModule\Controller;
|
||||
use Combodo\iTop\Application\TwigBase\Controller\Controller;
|
||||
use UserRights;
|
||||
|
||||
class MyModuleController extends Controller
|
||||
{
|
||||
public function OperationHelloWorld()
|
||||
{
|
||||
$aParams['sName'] = UserRights::GetUser();
|
||||
$aParams['sDate'] = date("r");
|
||||
$this->DisplayPage($aParams);
|
||||
}
|
||||
}
|
||||
|
||||
The ``DisplayPage()`` method accept an array of parameters. This array is transformed into variables for the Twig template.
|
||||
|
||||
Here two variables are created: ``sName`` and ``sDate``, we can use them in the template.
|
||||
|
||||
.. code-block:: twig
|
||||
:linenos:
|
||||
:caption: templates/HelloWorld.html.twig
|
||||
|
||||
{% UITitle ForPage {sTitle:'Hello ' ~ sName ~ '!'} %}{% EndUITitle %}
|
||||
{% UIContentBlock Standard {DataAttributes: {role: 'date'}} %}
|
||||
We are currently {{ sDate }}
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
The output is then
|
||||
|
||||
.. image:: Hello2.png
|
||||
|
||||
The variables can be of any type, for example you can give an array as a variable:
|
||||
|
||||
.. code-block:: php
|
||||
:linenos:
|
||||
:caption: src/Controller/MyModuleController.php
|
||||
|
||||
<?php
|
||||
|
||||
namespace MyCompany\iTop\MyModule\Controller;
|
||||
use Combodo\iTop\Application\TwigBase\Controller\Controller;
|
||||
use UserRights;
|
||||
|
||||
class MyModuleController extends Controller
|
||||
{
|
||||
public function OperationHelloWorld()
|
||||
{
|
||||
$aParams['sName'] = UserRights::GetUser();
|
||||
$aParams['sDate'] = date("r");
|
||||
$aParams['aQuarter'] = ['January', 'February', 'March'];
|
||||
$this->DisplayPage($aParams);
|
||||
}
|
||||
}
|
||||
|
||||
Here ``aQuarter`` is an array containing some months, we can use it in a selector:
|
||||
|
||||
.. code-block:: twig
|
||||
:linenos:
|
||||
:caption: templates/HelloWorld.html.twig
|
||||
|
||||
{% UITitle ForPage {sTitle:'Hello ' ~ sName ~ '!'} %}{% EndUITitle %}
|
||||
{% UIContentBlock Standard {DataAttributes: {role: 'date'}} %}
|
||||
We are currently {{ sDate }}
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
{% UIForm Standard {sId:'my-form'} %}
|
||||
Select Month:
|
||||
{% UISelect ForSelect {sName:'month'} %}
|
||||
{% for index,sMonth in aQuarter %}
|
||||
{% UISelectOption ForSelectOption {sValue: index, sLabel: sMonth, bSelected:false} %}
|
||||
{% endfor %}
|
||||
{% EndUISelect %}
|
||||
{% EndUIForm %}
|
||||
|
||||
The output is:
|
||||
|
||||
.. image:: Hello3.png
|
||||
BIN
.doc/UI/source/TwigBaseTuto/Step4/SelectMonth.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
78
.doc/UI/source/TwigBaseTuto/Step4/Step4.rst
Normal file
@@ -0,0 +1,78 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Step4:
|
||||
|
||||
4. Adding new operations
|
||||
========================
|
||||
|
||||
We currently have only one operation ``HelloWorld``. Generally multiple operations are needed, let's add a new one.
|
||||
|
||||
In the previous part :ref:`Step3` we have created a form, it will be used to call the operation ``SelectMonth``.
|
||||
|
||||
Modify the form to add an hidden input to set the operation and add a submit button:
|
||||
|
||||
.. code-block:: twig
|
||||
:lineno-start: 6
|
||||
:caption: templates/HelloWorld.html.twig
|
||||
|
||||
{% UIForm Standard {sId:'myform'} %}
|
||||
Select Month:
|
||||
{% UISelect ForSelect {sName:'month'} %}
|
||||
{% for index,sMonth in aQuarter %}
|
||||
{% UISelectOption ForSelectOption {sValue: index, sLabel: sMonth, bSelected:false} %}
|
||||
{% endfor %}
|
||||
{% EndUISelect %}
|
||||
{% UIInput ForHidden {sName:'operation', sValue:'SelectMonth'} %}
|
||||
{% UIContentBlock Standard {DataAttributes: {role: 'actions'}} %}
|
||||
{% UIButton ForPrimaryAction {sLabel:'Ok', bIsSubmit:true} %}
|
||||
{% EndUIContentBlock %}
|
||||
{% EndUIForm %}
|
||||
|
||||
The output of this template is:
|
||||
|
||||
.. image:: form.png
|
||||
|
||||
Now add the operation in the controller:
|
||||
|
||||
.. code-block:: php
|
||||
:linenos:
|
||||
:caption: src/Controller/MyModuleController.php
|
||||
|
||||
<?php
|
||||
|
||||
// ...
|
||||
|
||||
class MyModuleController extends Controller
|
||||
{
|
||||
// ...
|
||||
|
||||
public function OperationSelectMonth()
|
||||
{
|
||||
$aMonths = ['January', 'February', 'March'];
|
||||
$iMonth = utils::ReadParam('month', 0);
|
||||
$aParams['sSelectedMonth'] = $aMonths[$iMonth];
|
||||
$this->DisplayPage($aParams);
|
||||
}
|
||||
}
|
||||
|
||||
*Disclaimer: The code is for tutorial only, don't use it in production as no check is done on the entries*
|
||||
|
||||
The corresponding template must be created ``templates/SelectMonth.html.twig``
|
||||
|
||||
.. code-block:: twig
|
||||
:linenos:
|
||||
:caption: templates/SelectMonth.html.twig
|
||||
|
||||
{% UITitle ForPage {sTitle:'Selected month'} %}{% EndUITitle %}
|
||||
|
||||
{% UIContentBlock Standard {DataAttributes: {role: 'Information'}} %}
|
||||
The selected month is {{ sSelectedMonth }}
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
The output of this operation is:
|
||||
|
||||
.. image:: SelectMonth.png
|
||||
|
||||
|
||||
|
||||
BIN
.doc/UI/source/TwigBaseTuto/Step4/form.png
Normal file
|
After Width: | Height: | Size: 27 KiB |
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
namespace MyCompany\iTop\MyModule\Controller;
|
||||
|
||||
use Combodo\iTop\Application\TwigBase\Controller\Controller;
|
||||
use UserRights;
|
||||
use utils;
|
||||
|
||||
class MyModuleController extends Controller
|
||||
{
|
||||
public function OperationHelloWorld()
|
||||
{
|
||||
$aParams['sName'] = UserRights::GetUser();
|
||||
$aParams['sDate'] = date("r");
|
||||
$aParams['aQuarter'] = ['January', 'February', 'March'];
|
||||
$this->DisplayPage($aParams);
|
||||
}
|
||||
|
||||
// ...
|
||||
public function OperationSelectMonth()
|
||||
{
|
||||
$aMonths = ['January', 'February', 'March'];
|
||||
$iMonth = utils::ReadParam('month', 0);
|
||||
$aParams['sSelectedMonth'] = $aMonths[$iMonth];
|
||||
$this->DisplayPage($aParams);
|
||||
}
|
||||
}
|
||||
14
.doc/UI/source/TwigBaseTuto/TwigBaseTuto.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
Twig Base Tutorial
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Tutorial:
|
||||
|
||||
Step1/Step1
|
||||
Step2/Step2
|
||||
Step3/Step3
|
||||
Step4/Step4
|
||||
17
.doc/UI/source/_static/css/ui-doc.css
Normal file
@@ -0,0 +1,17 @@
|
||||
/*!
|
||||
* @copyright Copyright (C) 2010-2021 Combodo SARL
|
||||
* @license http://opensource.org/licenses/AGPL-3.0
|
||||
*/
|
||||
|
||||
.wy-nav-content {
|
||||
max-width: 1024px;
|
||||
min-height: 100%;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.rst-content .code-block-caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
18
.doc/UI/source/_templates/layout.html
Normal file
@@ -0,0 +1,18 @@
|
||||
{%- extends "!layout.html" %}
|
||||
{% block document %}
|
||||
{% if current_version and latest_version and current_version.name != 'latest' and current_version != latest_version %}
|
||||
<!--
|
||||
~ @copyright Copyright (C) 2010-2022 Combodo SARL
|
||||
~ @license http://opensource.org/licenses/AGPL-3.0
|
||||
-->
|
||||
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention!</p>
|
||||
<p>
|
||||
Vous consultez une ancienne version de cette documentation.
|
||||
Si vous voulez lire la plus récente, c'est par là <a href="{{ vpathto(latest_version.name) }}">{{latest_version.name}}</a>.
|
||||
</p>
|
||||
</div>
|
||||
{% endif %}
|
||||
{{ super() }}
|
||||
{% endblock %}%
|
||||
58
.doc/UI/source/_templates/sphinx_rtd_theme/__init__.py
Normal file
@@ -0,0 +1,58 @@
|
||||
"""
|
||||
Sphinx Read the Docs theme.
|
||||
|
||||
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
|
||||
"""
|
||||
|
||||
from os import path
|
||||
from sys import version_info as python_version
|
||||
|
||||
from sphinx import version_info as sphinx_version
|
||||
from sphinx.locale import _
|
||||
from sphinx.util.logging import getLogger
|
||||
|
||||
|
||||
__version__ = '0.5.1'
|
||||
__version_full__ = __version__
|
||||
|
||||
logger = getLogger(__name__)
|
||||
|
||||
|
||||
def get_html_theme_path():
|
||||
"""Return list of HTML theme paths."""
|
||||
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
|
||||
return cur_dir
|
||||
|
||||
|
||||
def config_initiated(app, config):
|
||||
theme_options = config.html_theme_options or {}
|
||||
if theme_options.get('canonical_url'):
|
||||
logger.warning(
|
||||
_('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.')
|
||||
)
|
||||
|
||||
|
||||
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
|
||||
def setup(app):
|
||||
if python_version[0] < 3:
|
||||
logger.warning("Python 2 is deprecated with sphinx_rtd_theme, update to Python 3")
|
||||
app.require_sphinx('1.6')
|
||||
if sphinx_version <= (2, 0, 0):
|
||||
logger.warning("Sphinx 1.x is deprecated with sphinx_rtd_theme, update to Sphinx 2.x or greater")
|
||||
if not app.config.html_experimental_html5_writer:
|
||||
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
|
||||
else:
|
||||
if app.config.html4_writer:
|
||||
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
|
||||
|
||||
# Register the theme that can be referenced without adding a theme path
|
||||
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
|
||||
|
||||
if sphinx_version >= (1, 8, 0):
|
||||
# Add Sphinx message catalog for newer versions of Sphinx
|
||||
# See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog
|
||||
rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale')
|
||||
app.add_message_catalog('sphinx', rtd_locale_path)
|
||||
app.connect('config-inited', config_initiated)
|
||||
|
||||
return {'parallel_read_safe': True, 'parallel_write_safe': True}
|
||||
75
.doc/UI/source/_templates/sphinx_rtd_theme/breadcrumbs.html
Normal file
@@ -0,0 +1,75 @@
|
||||
{%- if meta is defined and meta is not none %}
|
||||
{%- set check_meta = True %}
|
||||
{%- else %}
|
||||
{%- set check_meta = False %}
|
||||
{%- endif %}
|
||||
|
||||
{%- if check_meta and 'github_url' in meta %}
|
||||
{%- set display_github = True %}
|
||||
{%- endif %}
|
||||
|
||||
{%- if check_meta and 'bitbucket_url' in meta %}
|
||||
{%- set display_bitbucket = True %}
|
||||
{%- endif %}
|
||||
|
||||
{%- if check_meta and 'gitlab_url' in meta %}
|
||||
{%- set display_gitlab = True %}
|
||||
{%- endif %}
|
||||
|
||||
{%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
|
||||
|
||||
<div role="navigation" aria-label="{{ _('Breadcrumbs') }}">
|
||||
<ul class="wy-breadcrumbs">
|
||||
{%- block breadcrumbs %}
|
||||
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> »</li>
|
||||
{%- for doc in parents %}
|
||||
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li>
|
||||
{%- endfor %}
|
||||
<li>{{ title }}</li>
|
||||
{%- endblock %}
|
||||
{%- block breadcrumbs_aside %}
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
{%- if hasdoc(pagename) and display_vcs_links %}
|
||||
{%- if display_github %}
|
||||
{%- if check_meta and 'github_url' in meta %}
|
||||
<!-- User defined GitHub URL -->
|
||||
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||
{%- else %}
|
||||
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||
{%- endif %}
|
||||
{%- elif display_bitbucket %}
|
||||
{%- if check_meta and 'bitbucket_url' in meta %}
|
||||
<!-- User defined Bitbucket URL -->
|
||||
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||
{%- else %}
|
||||
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?mode={{ theme_vcs_pageview_mode or "view" }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||
{%- endif %}
|
||||
{%- elif display_gitlab %}
|
||||
{%- if check_meta and 'gitlab_url' in meta %}
|
||||
<!-- User defined GitLab URL -->
|
||||
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||
{%- else %}
|
||||
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||
{%- endif %}
|
||||
{%- elif show_source and source_url_prefix %}
|
||||
<a href="{{ source_url_prefix }}{{ pagename }}{{ page_source_suffix }}">{{ _('View page source') }}</a>
|
||||
{%- elif show_source and has_source and sourcename %}
|
||||
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
</li>
|
||||
{%- endblock %}
|
||||
</ul>
|
||||
|
||||
{%- if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Breadcrumbs') }}">
|
||||
{%- if prev %}
|
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
{%- endif %}
|
||||
</div>
|
||||
{%- endif %}
|
||||
<hr/>
|
||||
</div>
|
||||
61
.doc/UI/source/_templates/sphinx_rtd_theme/footer.html
Normal file
@@ -0,0 +1,61 @@
|
||||
<footer>
|
||||
{%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
|
||||
{%- if prev %}
|
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
{%- endif %}
|
||||
</div>
|
||||
{%- endif %}
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
{%- block contentinfo %}
|
||||
<p>
|
||||
{%- if show_copyright %}
|
||||
{%- if hasdoc('copyright') %}
|
||||
{%- trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
|
||||
{%- else %}
|
||||
{%- trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
{%- if build_id and build_url %}
|
||||
<span class="build">
|
||||
{#- Translators: Build is a noun, not a verb -#}
|
||||
{%- trans %}Build{% endtrans -%}
|
||||
<a href="{{ build_url }}">{{ build_id }}</a>.
|
||||
</span>
|
||||
{%- elif commit %}
|
||||
<span class="commit">
|
||||
{#- Translators: the phrase "revision" comes from Git, referring to a commit #}
|
||||
{%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
|
||||
</span>
|
||||
{%- endif %}
|
||||
{%- if last_updated %}
|
||||
<span class="lastupdated">
|
||||
{%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
|
||||
</span>
|
||||
{%- endif -%}
|
||||
|
||||
</p>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
|
||||
{% if show_sphinx %}
|
||||
{%- set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
|
||||
{%- set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
|
||||
{#- Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
|
||||
{%- trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
|
||||
{#- Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documenation #}
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
|
||||
{#- Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #}
|
||||
{%- trans %}provided by {{ readthedocs_web }}{% endtrans %}.
|
||||
{% endif %}
|
||||
|
||||
{%- block extrafooter %} {% endblock %}
|
||||
|
||||
</footer>
|
||||
241
.doc/UI/source/_templates/sphinx_rtd_theme/layout.html
Normal file
@@ -0,0 +1,241 @@
|
||||
{# TEMPLATE VAR SETTINGS #}
|
||||
{%- set url_root = pathto('', 1) %}
|
||||
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
|
||||
{%- if not embedded and docstitle %}
|
||||
{%- set titlesuffix = " — "|safe + docstitle|e %}
|
||||
{%- else %}
|
||||
{%- set titlesuffix = "" %}
|
||||
{%- endif %}
|
||||
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
|
||||
{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%}
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
{{- metatags }}
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
{%- block htmltitle %}
|
||||
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
|
||||
{%- endblock -%}
|
||||
|
||||
{#- CSS #}
|
||||
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
|
||||
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
|
||||
{%- for css in css_files %}
|
||||
{%- if css|attr("rel") %}
|
||||
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
|
||||
{%- else %}
|
||||
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
|
||||
{%- endif %}
|
||||
{%- endfor %}
|
||||
|
||||
{%- for cssfile in extra_css_files %}
|
||||
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
||||
{%- endfor -%}
|
||||
|
||||
{#- FAVICON #}
|
||||
{%- if favicon %}
|
||||
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
|
||||
{%- endif -%}
|
||||
|
||||
{#- CANONICAL URL (deprecated) #}
|
||||
{%- if theme_canonical_url and not pageurl %}
|
||||
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
|
||||
{%- endif -%}
|
||||
|
||||
{#- CANONICAL URL #}
|
||||
{%- if pageurl %}
|
||||
<link rel="canonical" href="{{ pageurl|e }}" />
|
||||
{%- endif -%}
|
||||
|
||||
{#- JAVASCRIPTS #}
|
||||
{%- block scripts %}
|
||||
<!--[if lt IE 9]>
|
||||
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
|
||||
<![endif]-->
|
||||
{%- if not embedded %}
|
||||
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
|
||||
{%- if sphinx_version >= "1.8.0" -%}
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="{{ url_root }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
|
||||
{%- for scriptfile in script_files %}
|
||||
{{ js_tag(scriptfile) }}
|
||||
{%- endfor %}
|
||||
{%- else %}
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'{{ url_root }}',
|
||||
VERSION:'{{ release|e }}',
|
||||
LANGUAGE:'{{ language }}',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
|
||||
HAS_SOURCE: {{ has_source|lower }},
|
||||
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
|
||||
};
|
||||
</script>
|
||||
{%- for scriptfile in script_files %}
|
||||
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
|
||||
{%- endfor %}
|
||||
{%- endif %}
|
||||
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
|
||||
|
||||
{#- OPENSEARCH #}
|
||||
{%- if use_opensearch %}
|
||||
<link rel="search" type="application/opensearchdescription+xml"
|
||||
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
|
||||
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
|
||||
{%- block linktags %}
|
||||
{%- if hasdoc('about') %}
|
||||
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
|
||||
{%- endif %}
|
||||
{%- if hasdoc('genindex') %}
|
||||
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
|
||||
{%- endif %}
|
||||
{%- if hasdoc('search') %}
|
||||
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
|
||||
{%- endif %}
|
||||
{%- if hasdoc('copyright') %}
|
||||
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
|
||||
{%- endif %}
|
||||
{%- if next %}
|
||||
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
|
||||
{%- endif %}
|
||||
{%- if prev %}
|
||||
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
{%- block extrahead %} {% endblock %}
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
{%- block extrabody %} {% endblock %}
|
||||
<div class="wy-grid-for-nav">
|
||||
{#- SIDE NAV, TOGGLES ON MOBILE #}
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
|
||||
{%- block sidebartitle %}
|
||||
|
||||
{%- if logo and theme_logo_only %}
|
||||
<a href="{{ pathto(master_doc) }}">
|
||||
{%- else %}
|
||||
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
|
||||
{%- endif %}
|
||||
|
||||
{%- if logo %}
|
||||
{#- Not strictly valid HTML, but it's the only way to display/scale
|
||||
it properly, without weird scripting or heaps of work
|
||||
#}
|
||||
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="{{ _('Logo') }}"/>
|
||||
{%- endif %}
|
||||
</a>
|
||||
|
||||
{%- if theme_display_version %}
|
||||
{%- set nav_version = version %}
|
||||
{%- if READTHEDOCS and current_version %}
|
||||
{%- set nav_version = current_version %}
|
||||
{%- endif %}
|
||||
{%- if nav_version %}
|
||||
<div class="version">
|
||||
{{ nav_version }}
|
||||
</div>
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
{%- include "searchbox.html" %}
|
||||
|
||||
{%- endblock %}
|
||||
</div>
|
||||
|
||||
{%- block navigation %}
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Main') }}">
|
||||
{%- block menu %}
|
||||
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
|
||||
collapse=theme_collapse_navigation|tobool,
|
||||
includehidden=theme_includehidden|tobool,
|
||||
titles_only=theme_titles_only|tobool) %}
|
||||
{%- if toctree %}
|
||||
{{ toctree }}
|
||||
{%- else %}
|
||||
<!-- Local TOC -->
|
||||
<div class="local-toc">{{ toc }}</div>
|
||||
{%- endif %}
|
||||
{%- endblock %}
|
||||
</div>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
||||
<nav class="wy-nav-top" aria-label="{{ _('Top') }}">
|
||||
{%- block mobile_nav %}
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
|
||||
{%- endblock %}
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
{%- block content %}
|
||||
{%- if theme_style_external_links|tobool %}
|
||||
<div class="rst-content style-external-links">
|
||||
{%- else %}
|
||||
<div class="rst-content">
|
||||
{%- endif %}
|
||||
{% include "breadcrumbs.html" %}
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
{%- block document %}
|
||||
<div itemprop="articleBody">
|
||||
{% block body %}{% endblock %}
|
||||
</div>
|
||||
{%- if self.comments()|trim %}
|
||||
<div class="articleComments">
|
||||
{%- block comments %}{% endblock %}
|
||||
</div>
|
||||
{%- endif%}
|
||||
</div>
|
||||
{%- endblock %}
|
||||
{% include "footer.html" %}
|
||||
</div>
|
||||
{%- endblock %}
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
{% include "versions.html" -%}
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
|
||||
});
|
||||
</script>
|
||||
|
||||
{#- Do not conflict with RTD insertion of analytics script #}
|
||||
{%- if not READTHEDOCS %}
|
||||
{%- if theme_analytics_id %}
|
||||
<!-- Theme Analytics -->
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', '{{ theme_analytics_id }}', 'auto');
|
||||
{%- if theme_analytics_anonymize_ip|tobool %}
|
||||
ga('set', 'anonymizeIp', true);
|
||||
{%- endif %}
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
|
||||
{%- endif %}
|
||||
{%- endif %}
|
||||
|
||||
{%- block footer %} {% endblock %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,142 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Tom Kunze <transifex.com@tomabrafix.de>, 2019
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Tom Kunze <transifex.com@tomabrafix.de>, 2019\n"
|
||||
"Language-Team: German (https://www.transifex.com/readthedocs/teams/101354/de/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: de\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Auf GitHub bearbeiten"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Auf Bitbucket bearbeiten"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Auf GitLab bearbeiten"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Quelltext anzeigen"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Weiter"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Zurück"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Build"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Zuletzt aktualisiert am %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Erstellt mit %(sphinx_web)s mit einem"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "bereitgestellt von %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "%(docstitle)s durchsuchen"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Über diese Dokumentation"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Index"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Suche"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Copyright"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Bitte aktiviere JavaScript, um die Suchfunktion zu nutzen."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Suchergebnisse"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Es wurden keine mit deiner Suchanfrage übereinstimmenden Dokumente gefunden."
|
||||
" Achte darauf, dass alle Wörter richtig geschrieben sind und dass genug "
|
||||
"Kategorien ausgewählt sind."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Dokumentation durchsuchen"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versionen"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "Auf Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Projektübersicht"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Builds"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Dokumentation"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Kostenloses Dokumentationen-Hosting zur Verfügung gestellt von"
|
||||
@@ -0,0 +1,164 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 15:43-0600\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language: en\n"
|
||||
"Language-Team: en <LL@li.org>\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=utf-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:20
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:22
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr ""
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr ""
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr ""
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr ""
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr ""
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words "
|
||||
"are spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr ""
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr ""
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Documentation Home"
|
||||
#~ msgstr ""
|
||||
|
||||
@@ -0,0 +1,162 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2019
|
||||
# Leonardo J. Caballero G. <leonardocaballero@gmail.com>, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Leonardo J. Caballero G. <leonardocaballero@gmail.com>, 2020\n"
|
||||
"Language-Team: Spanish (https://www.transifex.com/readthedocs/teams/101354/es/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: es\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Editar en GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Editar en Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Editar en GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Ver código fuente de la página"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Siguiente"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Anterior"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Construido"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Revisión"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Actualizado por última vez en %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Construido con %(sphinx_web)s usando un"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "tema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "proporcionado por %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Buscar en %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Sobre esta documentación"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Índice"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Búsqueda"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Derechos de autor"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logotipo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
"Por favor, active JavaScript para habilitar la funcionalidad de búsqueda."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Resultados de la búsqueda"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Su búsqueda no coincide con ningún documento. Por favor, asegúrese de que "
|
||||
"todas las palabras estén correctamente escritas y que usted haya "
|
||||
"seleccionado las suficientes categorías."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Buscar documentos"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versiones"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Descargas"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "En Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Página de Proyecto"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Construcciones"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Documentos"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Alojamiento gratuito de documentos proporcionado por"
|
||||
|
||||
#~ msgid "Documentation Home"
|
||||
#~ msgstr "Inicio de Documentación"
|
||||
@@ -0,0 +1,153 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2020
|
||||
# Ivar Smolin <okul@linux.ee>, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Ivar Smolin <okul@linux.ee>, 2020\n"
|
||||
"Language-Team: Estonian (https://www.transifex.com/readthedocs/teams/101354/et/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: et\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Muuda GitHubis"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Muuda Bitbucketis"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Muuda GitLabis"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Vaata lehe lähtekoodi"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Järgmine"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Eelmine"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Ehitus"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Redaktsioon"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Viimati uuendatud %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Ehitatud %(sphinx_web)s'iga,"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "kujundusteema"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Otsi dokumendist %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Nende dokumentide kirjeldused"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Indeks"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Otsing"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Autoriõigus"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Otsimisfunktsiooni lubamiseks aktiveeri palun JavaScript"
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Otsingu tulemused"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Sinu otsingule ei vastanud ükski dokument. Palun veendu, et kõik sisestatud "
|
||||
"sõnad on õigesti kirjutatud ja sa oled valikud piisaval hulgal kategooriaid."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Otsi dokumente"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versioonid"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Allalaadimised"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "Saidil Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Projekti kodu"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Ehitused"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Dokumendid"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Dokumentatsiooni majutab tasuta"
|
||||
|
||||
#~ msgid "Documentation Home"
|
||||
#~ msgstr "Dokumentatsiooni kodu"
|
||||
@@ -0,0 +1,153 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Radina Matic <radina.matic@gmail.com>, 2020
|
||||
# Anthony <aj@ohess.org>, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Anthony <aj@ohess.org>, 2020\n"
|
||||
"Language-Team: French (https://www.transifex.com/readthedocs/teams/101354/fr/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: fr\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Éditer sur GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Éditer sur Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Éditer sur GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Afficher la source de la page"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Suivant"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Précédent"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Compilation"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Révision"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Dernière mise à jour le %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Compilé avec %(sphinx_web)s en utilisant un"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "thème"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "fourni par %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Rechercher dans %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "À propos de cette documentation"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Index"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Rechercher"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Droits d'auteur"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Activez JavaScript pour accéder à la fonction de recherche."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Résultats de la recherche"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Votre recherche ne correspond à aucun document. Assurez-vous que tous les "
|
||||
"mots sont correctement orthographiés et que vous avez sélectionné "
|
||||
"suffisamment de catégories."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Rechercher docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versions"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Téléchargements"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Accueil du projet"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Compilations"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Docs"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Hébergement gratuit de documents fourni par"
|
||||
@@ -0,0 +1,156 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Jesse Tan, 2019
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Jesse Tan, 2019\n"
|
||||
"Language-Team: Dutch (https://www.transifex.com/readthedocs/teams/101354/nl/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: nl\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Bewerk op GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Bewerk op BitBucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Bewerk op GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Bekijk paginabron"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Volgende"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Vorige"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Bouwresultaat"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Revisie"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Laatste update op %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Gebouwd met %(sphinx_web)s met een"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "thema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "geleverd door %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Zoek binnen %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Over deze documenten"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Index"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Zoek"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Copyright"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Zet JavaScript aan om de zoekfunctie mogelijk te maken."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Zoekresultaten"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Zoekpoging vond geen documenten. Zorg ervoor dat alle woorden correct zijn "
|
||||
"gespeld en dat voldoende categorieën zijn geselecteerd."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Zoek in documentatie"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versies"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Downloads"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "Op Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Project Home"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Bouwresultaten"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Documentatie"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Gratis hosting voor documentatie verzorgd door"
|
||||
@@ -0,0 +1,158 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Rafael Fontenelle <rffontenelle@gmail.com>, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Rafael Fontenelle <rffontenelle@gmail.com>, 2020\n"
|
||||
"Language-Team: Portuguese (Brazil) (https://www.transifex.com/readthedocs/teams/101354/pt_BR/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: pt_BR\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Editar no GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Editar no Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Editar no GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Ver código-fonte da página"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Próximo"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Anterior"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Compilação"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Revisão"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Última atualização em %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Compilado com %(sphinx_web)s usando um"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "tema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "fornecido por %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Pesquisar em %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Sobre esses documentos"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Índice"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Pesquisar"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Copyright"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
"Por favor, ative JavaScript para habilitar a funcionalidade de pesquisa."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Resultados da pesquisa"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"A sua pesquisa não encontrou nenhum documento correspondente. Verifique se "
|
||||
"todas as palavras estão escritas corretamente e se você selecionou "
|
||||
"categorias suficientes."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Pesquisar documentos"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versões"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Downloads"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "No Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Página inicial"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Compilações"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Docs"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Hospedagem de documentos livres fornecida por"
|
||||
@@ -0,0 +1,157 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Dmitry Shachnev <mitya57@gmail.com>, 2019
|
||||
# lvv83 <vlozhkin83@gmail.com>, 2019
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: lvv83 <vlozhkin83@gmail.com>, 2019\n"
|
||||
"Language-Team: Russian (https://www.transifex.com/readthedocs/teams/101354/ru/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: ru\n"
|
||||
"Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) || (n%100>=11 && n%100<=14)? 2 : 3);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Редактировать на GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Редактировать на BitBucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Редактировать на GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Просмотреть исходный код страницы"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Следующая"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Предыдущая"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Сборка"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Ревизия"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Последний раз обновлено %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Собрано при помощи %(sphinx_web)s с использованием"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "темы,"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "предоставленной %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Поиск в %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Об этих документах"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Алфавитный указатель"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Поиск"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Авторские права"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Логотип"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "Активируйте JavaScript, чтобы использовать функционал поиска."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Результаты поиска"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"По Вашему запросу не найдено результатов. Пожалуйста, проверьте, что все "
|
||||
"слова написаны правильно, и Вы выбрали нужные категории."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Поиск в документации"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Версии"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Загрузки"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "На Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Домашняя страница проекта"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Сборки"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Документация"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Бесплатный хостинг документов, предоставленный"
|
||||
154
.doc/UI/source/_templates/sphinx_rtd_theme/locale/sphinx.pot
Normal file
@@ -0,0 +1,154 @@
|
||||
# Translations template for sphinx_rtd_theme.
|
||||
# Copyright (C) 2021 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.5.0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=utf-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:20
|
||||
#, python-format
|
||||
msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:22
|
||||
#, python-format
|
||||
msgid "© Copyright %(copyright)s."
|
||||
msgstr ""
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr ""
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr ""
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr ""
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr ""
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words "
|
||||
"are spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr ""
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr ""
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr ""
|
||||
|
||||
@@ -0,0 +1,156 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Daniel Holmberg <daniel.holmberg97@gmail.com>, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: Daniel Holmberg <daniel.holmberg97@gmail.com>, 2020\n"
|
||||
"Language-Team: Swedish (https://www.transifex.com/readthedocs/teams/101354/sv/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: sv\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "Editera på GitHub"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Editera på Bitbucket"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "Editera på GitLab"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Visa sidkälla"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Nästa"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Tillbaka"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Bygg"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Ändra"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Senast uppdaterad %(last_updated)s."
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "Gjord med %(sphinx_web)s med hjälp av"
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "tema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "erhållet av %(readthedocs_web)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "Sök i %(docstitle)s"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Om dessa dokument"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Index"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Sök"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Upphovsrätt"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
"Var vänlig och aktivera JavaScript för att möjliggöra sökfunktionaliteten."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Sökresultat"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Din sökning gav inga träffar. Var vänlig och se till att alla ord är rätt "
|
||||
"stavade och att du har valt tillräckligt många kategorier."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Sök i dokumentationen"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Versioner"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "Nerladdningar"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "På Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Projekt Hem"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "Dokumentation"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Gratis dokumentations hysning erhållen av"
|
||||
|
||||
#~ msgid "Documentation Home"
|
||||
#~ msgstr "Dokumentation Hem"
|
||||
@@ -0,0 +1,146 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# BouRock, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: BouRock, 2020\n"
|
||||
"Language-Team: Turkish (https://www.transifex.com/readthedocs/teams/101354/tr/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: tr\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "GitHub'da Düzenle"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "Bitbucket'ta Düzenle"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "GitLab'ta Düzenle"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "Sayfa kaynağını görüntüle"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "Sonraki"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "Önceki"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "Oluşturma"
|
||||
|
||||
#. the phrase "revision" comes from Git, referring to a commit
|
||||
#: sphinx_rtd_theme/footer.html:35
|
||||
msgid "Revision"
|
||||
msgstr "Gözden geçirme"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "Son olarak %(last_updated)s tarihinde güncellendi."
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "tema"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "kullanılarak %(readthedocs_web)s tarafından sağlanmasıyla oluşturuldu"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "%(docstitle)s içinde ara"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "Bu belgeler hakkında"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "Dizin"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "Arama"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "Telif hakkı"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr ""
|
||||
"Arama işlevselliğini etkinleştirmek için lütfen JavaScript'i etkinleştirin."
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "Arama Sonuçları"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr ""
|
||||
"Aramanız hiçbir belgeyle eşleşmedi. Lütfen tüm kelimelerin doğru "
|
||||
"yazıldığından ve yeterli kategori seçtiğinizden emin olun."
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "Belgeleri arayın"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "Sürümler"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "İndirmeler"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "Read the Docs Üzerinde"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "Proje Ana Sayfa"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "Oluşturmalar"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "Ücretsiz belge barındırmayı sağlayan"
|
||||
@@ -0,0 +1,150 @@
|
||||
# English translations for sphinx_rtd_theme.
|
||||
# Copyright (C) 2019 ORGANIZATION
|
||||
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||
# project.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||
#
|
||||
# Translators:
|
||||
# Anthony <aj@ohess.org>, 2020
|
||||
# 王赛 <wangsai@bootcss.com>, 2020
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||
"POT-Creation-Date: 2021-01-04 13:48-0800\n"
|
||||
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||
"Last-Translator: 王赛 <wangsai@bootcss.com>, 2020\n"
|
||||
"Language-Team: Chinese (China) (https://www.transifex.com/readthedocs/teams/101354/zh_CN/)\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.8.0\n"
|
||||
"Language: zh_CN\n"
|
||||
"Plural-Forms: nplurals=1; plural=0;\n"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:45 sphinx_rtd_theme/breadcrumbs.html:47
|
||||
msgid "Edit on GitHub"
|
||||
msgstr "在 GitHub 上修改"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:52 sphinx_rtd_theme/breadcrumbs.html:54
|
||||
msgid "Edit on Bitbucket"
|
||||
msgstr "在 Bitbucket 上修改"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:59 sphinx_rtd_theme/breadcrumbs.html:61
|
||||
msgid "Edit on GitLab"
|
||||
msgstr "在 GitLab 上修改"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:64 sphinx_rtd_theme/breadcrumbs.html:66
|
||||
msgid "View page source"
|
||||
msgstr "查看页面源码"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:76 sphinx_rtd_theme/footer.html:5
|
||||
msgid "Next"
|
||||
msgstr "下一页"
|
||||
|
||||
#: sphinx_rtd_theme/breadcrumbs.html:79 sphinx_rtd_theme/footer.html:8
|
||||
msgid "Previous"
|
||||
msgstr "上一页"
|
||||
|
||||
#. Build is a noun, not a verb
|
||||
#: sphinx_rtd_theme/footer.html:29
|
||||
msgid "Build"
|
||||
msgstr "构建"
|
||||
|
||||
#: sphinx_rtd_theme/footer.html:40
|
||||
#, python-format
|
||||
msgid "Last updated on %(last_updated)s."
|
||||
msgstr "最后更新时间 %(last_updated)s。"
|
||||
|
||||
#. the variable "sphinx_web" is a link to the Sphinx project documentation
|
||||
#. with
|
||||
#. the text "Sphinx"
|
||||
#: sphinx_rtd_theme/footer.html:52
|
||||
#, python-format
|
||||
msgid "Built with %(sphinx_web)s using a"
|
||||
msgstr "利用 %(sphinx_web)s 构建,使用了 "
|
||||
|
||||
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
|
||||
#. generated documenation
|
||||
#: sphinx_rtd_theme/footer.html:54
|
||||
msgid "theme"
|
||||
msgstr "主题"
|
||||
|
||||
#. this is always used as "provided by Read the Docs", and should not imply
|
||||
#. Read the Docs is an author of the generated documentation.
|
||||
#: sphinx_rtd_theme/footer.html:56
|
||||
#, python-format
|
||||
msgid "provided by %(readthedocs_web)s"
|
||||
msgstr "由 %(readthedocs_web)s开发"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:85
|
||||
#, python-format
|
||||
msgid "Search within %(docstitle)s"
|
||||
msgstr "在 %(docstitle)s中搜索"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:93
|
||||
msgid "About these documents"
|
||||
msgstr "关于此文档"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:96
|
||||
msgid "Index"
|
||||
msgstr "索引"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:99 sphinx_rtd_theme/search.html:11
|
||||
msgid "Search"
|
||||
msgstr "搜索"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:102
|
||||
msgid "Copyright"
|
||||
msgstr "版权所有"
|
||||
|
||||
#: sphinx_rtd_theme/layout.html:134
|
||||
msgid "Logo"
|
||||
msgstr "Logo"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:31
|
||||
msgid "Please activate JavaScript to enable the search functionality."
|
||||
msgstr "请启用 JavaScript 以便使用搜索功能"
|
||||
|
||||
#. Search is a noun, not a verb
|
||||
#: sphinx_rtd_theme/search.html:39
|
||||
msgid "Search Results"
|
||||
msgstr "搜索结果"
|
||||
|
||||
#: sphinx_rtd_theme/search.html:41
|
||||
msgid ""
|
||||
"Your search did not match any documents. Please make sure that all words are"
|
||||
" spelled correctly and that you've selected enough categories."
|
||||
msgstr "您的搜索没有匹配到任何文档。请确保所有单词拼写正确,并选择了足够多的类别。"
|
||||
|
||||
#: sphinx_rtd_theme/searchbox.html:4
|
||||
msgid "Search docs"
|
||||
msgstr "在文档中搜索"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:11
|
||||
msgid "Versions"
|
||||
msgstr "版本列表"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:17
|
||||
msgid "Downloads"
|
||||
msgstr "下载链接"
|
||||
|
||||
#. The phrase "Read the Docs" is not translated
|
||||
#: sphinx_rtd_theme/versions.html:24
|
||||
msgid "On Read the Docs"
|
||||
msgstr "托管于 Read the Docs"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:26
|
||||
msgid "Project Home"
|
||||
msgstr "项目首页"
|
||||
|
||||
#: sphinx_rtd_theme/versions.html:29
|
||||
msgid "Builds"
|
||||
msgstr "构建"
|
||||
|
||||
#~ msgid "Docs"
|
||||
#~ msgstr "文档"
|
||||
|
||||
#~ msgid "Free document hosting provided by"
|
||||
#~ msgstr "此文档免费托管于"
|
||||
22
.doc/UI/source/_templates/sphinx_rtd_theme/page.html
Normal file
@@ -0,0 +1,22 @@
|
||||
{% extends "!page.html" %}
|
||||
{% block body %}
|
||||
{% if current_version and latest_version and current_version != latest_version %}
|
||||
<!--
|
||||
~ @copyright Copyright (C) 2010-2022 Combodo SARL
|
||||
~ @license http://opensource.org/licenses/AGPL-3.0
|
||||
-->
|
||||
|
||||
<p>
|
||||
<strong>
|
||||
{% if current_version.is_released %}
|
||||
You're reading an old version of this documentation.
|
||||
If you want up-to-date information, please have a look at <a href="{{ vpathto(latest_version.name) }}">{{latest_version.name}}</a>.
|
||||
{% else %}
|
||||
You're reading the documentation for a development version.
|
||||
For the latest released version, please have a look at <a href="{{ vpathto(latest_version.name) }}">{{latest_version.name}}</a>.
|
||||
{% endif %}
|
||||
</strong>
|
||||
</p>
|
||||
{% endif %}
|
||||
{{ super() }}
|
||||
{% endblock %}%
|
||||
56
.doc/UI/source/_templates/sphinx_rtd_theme/search.html
Normal file
@@ -0,0 +1,56 @@
|
||||
{#
|
||||
basic/search.html
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Template for the search page.
|
||||
|
||||
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
|
||||
:license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
|
||||
#}
|
||||
{%- extends "layout.html" %}
|
||||
{% set title = _('Search') %}
|
||||
{% set display_vcs_links = False %}
|
||||
{%- block scripts %}
|
||||
{{ super() }}
|
||||
<script type="text/javascript" src="{{ pathto('_static/searchtools.js', 1) }}"></script>
|
||||
<script type="text/javascript" src="{{ pathto('_static/language_data.js', 1) }}"></script>
|
||||
{%- endblock %}
|
||||
{% block footer %}
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
|
||||
</script>
|
||||
{# this is used when loading the search index using $.ajax fails,
|
||||
such as on Chrome for documents on localhost #}
|
||||
<script type="text/javascript" id="searchindexloader"></script>
|
||||
{{ super() }}
|
||||
{% endblock %}
|
||||
{% block body %}
|
||||
<noscript>
|
||||
<div id="fallback" class="admonition warning">
|
||||
<p class="last">
|
||||
{% trans trimmed %}Please activate JavaScript to enable the search
|
||||
functionality.{% endtrans %}
|
||||
</p>
|
||||
</div>
|
||||
</noscript>
|
||||
|
||||
{% if search_performed %}
|
||||
{# Translators: Search is a noun, not a verb #}
|
||||
<h2>{{ _('Search Results') }}</h2>
|
||||
{% if not search_results %}
|
||||
<p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
<div id="search-results">
|
||||
{% if search_results %}
|
||||
<ul>
|
||||
{% for href, caption, context in search_results %}
|
||||
<li>
|
||||
<a href="{{ pathto(item.href) }}">{{ caption }}</a>
|
||||
<p class="context">{{ context|e }}</p>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -0,0 +1,9 @@
|
||||
{%- if 'singlehtml' not in builder %}
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" 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>
|
||||
{%- endif %}
|
||||
@@ -0,0 +1 @@
|
||||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
|
After Width: | Height: | Size: 434 KiB |
@@ -0,0 +1 @@
|
||||
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
||||
@@ -0,0 +1 @@
|
||||
!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}t.length>0&&($(".wy-menu-vertical .current").removeClass("current"),t.addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l1").parent().addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l2").addClass("current"),t.closest("li.toctree-l3").addClass("current"),t.closest("li.toctree-l4").addClass("current"),t.closest("li.toctree-l5").addClass("current"),t[0].scrollIntoView())}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current");var t=e.find("> ul li");t.length&&(t.removeClass("current"),e.toggleClass("current"))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t<e.length&&!window.requestAnimationFrame;++t)window.requestAnimationFrame=window[e[t]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[t]+"CancelAnimationFrame"]||window[e[t]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,t){var i=(new Date).getTime(),o=Math.max(0,16-(i-n)),r=window.setTimeout((function(){e(i+o)}),o);return n=i+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()}).call(window)},function(n,e){n.exports=jQuery},function(n,e,t){}]);
|
||||
20
.doc/UI/source/_templates/sphinx_rtd_theme/theme.conf
Normal file
@@ -0,0 +1,20 @@
|
||||
[theme]
|
||||
inherit = basic
|
||||
stylesheet = css/theme.css
|
||||
pygments_style = default
|
||||
|
||||
[options]
|
||||
canonical_url =
|
||||
analytics_id =
|
||||
analytics_anonymize_ip = False
|
||||
collapse_navigation = True
|
||||
sticky_navigation = True
|
||||
navigation_depth = 4
|
||||
includehidden = True
|
||||
titles_only =
|
||||
logo_only =
|
||||
display_version = True
|
||||
prev_next_buttons_location = bottom
|
||||
style_external_links = False
|
||||
style_nav_header_background =
|
||||
vcs_pageview_mode =
|
||||
27
.doc/UI/source/_templates/sphinx_rtd_theme/versions.html
Normal file
@@ -0,0 +1,27 @@
|
||||
{%- if current_version %}
|
||||
<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: {{ current_version.name }}
|
||||
<span class="fa fa-caret-down"></span>
|
||||
</span>
|
||||
<div class="rst-other-versions">
|
||||
{%- if versions.tags %}
|
||||
<dl>
|
||||
<dt>Tags</dt>
|
||||
{%- for item in versions.tags %}
|
||||
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
|
||||
{%- endfor %}
|
||||
</dl>
|
||||
{%- endif %}
|
||||
{%- if versions.branches %}
|
||||
<dl>
|
||||
<dt>Branches</dt>
|
||||
{%- for item in versions.branches %}
|
||||
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
|
||||
{%- endfor %}
|
||||
</dl>
|
||||
{%- endif %}
|
||||
</div>
|
||||
</div>
|
||||
{%- endif %}
|
||||
32
.doc/UI/source/_templates/versions.html
Normal file
@@ -0,0 +1,32 @@
|
||||
{%- if current_version %}
|
||||
<!--
|
||||
~ @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: {{ current_version.name }}
|
||||
<span class="fa fa-caret-down"></span>
|
||||
</span>
|
||||
<div class="rst-other-versions">
|
||||
{%- if versions.tags %}
|
||||
<dl>
|
||||
<dt>Tags</dt>
|
||||
{%- for item in versions.tags %}
|
||||
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
|
||||
{%- endfor %}
|
||||
</dl>
|
||||
{%- endif %}
|
||||
{%- if versions.branches %}
|
||||
<dl>
|
||||
<dt>Branches</dt>
|
||||
{%- for item in versions.branches %}
|
||||
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
|
||||
{%- endfor %}
|
||||
</dl>
|
||||
{%- endif %}
|
||||
</div>
|
||||
</div>
|
||||
{%- endif %}
|
||||
82
.doc/UI/source/conf.py
Normal file
@@ -0,0 +1,82 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'iTop UI'
|
||||
copyright = '2022, Combodo'
|
||||
author = 'Combodo'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = 'iTop 3.1.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['sphinx.ext.autosectionlabel', 'myst_parser', 'sphinx_multiversion']
|
||||
|
||||
autosectionlabel_prefix_document = True
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
#source_suffix = ['.rst', '.md']
|
||||
#source_suffix = '.rst'
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
'.txt': 'markdown',
|
||||
'.md': 'markdown',
|
||||
}
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
highlight_language = 'php'
|
||||
|
||||
highlight_options = {
|
||||
'php': {'startinline': True}
|
||||
}
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
html_logo = "img/itop-logo.png"
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
html_css_files = [
|
||||
'css/ui-doc.css',
|
||||
]
|
||||
|
||||
master_doc = 'index'
|
||||
|
||||
html_copy_source = False
|
||||
284
.doc/UI/source/generated/Component/Alert/Alert.rst
Normal file
@@ -0,0 +1,284 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Alert:
|
||||
|
||||
Alert
|
||||
=====
|
||||
|
||||
Alerts are the main component to give feedback to the user or communicate page specific to system wide messages.
|
||||
Alerts are a rectangular component displaying a title and a message.
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Alert/AlertAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIAlert**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Neutral <AlertNeutral>` | Make a basis Alert component |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`ForInformation <AlertForInformation>` | Make an Alert component for informational messages |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`ForSuccess <AlertForSuccess>` | Make an Alert component for successful messages |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`ForWarning <AlertForWarning>` | Make an Alert component for warning messages |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`ForDanger <AlertForDanger>` | Make an Alert component for danger messages |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`ForFailure <AlertForFailure>` | Make an Alert component for failure messages |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`WithBrandingPrimaryColor <AlertWithBrandingPrimaryColor>` | Make an Alert component with primary color scheme |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`WithBrandingSecondaryColor <AlertWithBrandingSecondaryColor>` | Make an Alert component with secondary color scheme |
|
||||
+---------------------------------------------------------------------+-----------------------------------------------------+
|
||||
|
||||
.. _AlertNeutral:
|
||||
|
||||
Alert Neutral
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert Neutral {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertForInformation:
|
||||
|
||||
Alert ForInformation
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert ForInformation {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertForSuccess:
|
||||
|
||||
Alert ForSuccess
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert ForSuccess {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertForWarning:
|
||||
|
||||
Alert ForWarning
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert ForWarning {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertForDanger:
|
||||
|
||||
Alert ForDanger
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert ForDanger {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertForFailure:
|
||||
|
||||
Alert ForFailure
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert ForFailure {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertWithBrandingPrimaryColor:
|
||||
|
||||
Alert WithBrandingPrimaryColor
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert WithBrandingPrimaryColor {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
.. _AlertWithBrandingSecondaryColor:
|
||||
|
||||
Alert WithBrandingSecondaryColor
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIAlert WithBrandingSecondaryColor {sTitle:'value', sContent:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIAlert %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sTitle | string | optional | '' | Title of the alert |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sContent | string | optional | '' | The raw HTML content, must be already sanitized |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
| sId | string | optional | NULL | id of the html block |
|
||||
+----------+--------+----------+------+-------------------------------------------------+
|
||||
|
||||
Alert common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| Color | string | Color of the alert (check CSS classes ibo-is-<color> for colors) |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| Content | string | The raw HTML content, must be already sanitized |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| IsClosable | bool | Indicates if the user can remove the alert from the screen |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| IsCollapsible | bool | Indicates if the user can collapse the alert to display only the title |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| OpenedByDefault | bool | Indicates if the alert is collapsed or not by default |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
| Title | string | Title of the alert |
|
||||
+-----------------------------+----------+------------------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Alert/AlertFooter.rst
|
||||
480
.doc/UI/source/generated/Component/Button/Button.rst
Normal file
@@ -0,0 +1,480 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Button:
|
||||
|
||||
Button
|
||||
======
|
||||
|
||||
Class Button
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Button/ButtonAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButton**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Neutral <ButtonNeutral>` | Make a basis Button component for any purpose |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForPrimaryAction <ButtonForPrimaryAction>` | Make a Button component for a primary action, should be used to tell the user this is the main choice |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForSecondaryAction <ButtonForSecondaryAction>` | Make a Button component for a secondary action, should be used to tell the user this is an second hand choice |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForPositiveAction <ButtonForPositiveAction>` | Make a Button component for a success action, should be used to tell the user he/she going to make a positive action/choice |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForDestructiveAction <ButtonForDestructiveAction>` | Make a Button component for a destructive action, should be used to tell the user he/she going to make something that cannot be |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AlternativeNeutral <ButtonAlternativeNeutral>` | Make a basis Button component for any purpose |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForAlternativePrimaryAction <ButtonForAlternativePrimaryAction>` | Make a Button component for an alternative primary action, should be used to avoid the user to consider this action as the first |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForAlternativeSecondaryAction <ButtonForAlternativeSecondaryAction>` | Make a Button component for an alternative secondary action, should be used to avoid the user to focus on this |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForAlternativeValidationAction <ButtonForAlternativeValidationAction>` | Make a Button component for a validation action, should be used to avoid the user to focus on this |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForAlternativeDestructiveAction <ButtonForAlternativeDestructiveAction>` | Make a Button component for a destructive action, should be used to avoid the user to focus on this |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForCancel <ButtonForCancel>` | Make a Button component for a cancel, should be used only for UI navigation, not destructive action |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`IconAction <ButtonIconAction>` | @param string $sIconClasses |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`LinkNeutral <ButtonLinkNeutral>` | Make a link Button component to open an URL instead of triggering a form action |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`IconLink <ButtonIconLink>` | @param string $sIconClasses |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DestructiveIconLink <ButtonDestructiveIconLink>` | @param string $sIconClasses |
|
||||
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _ButtonNeutral:
|
||||
|
||||
Button Neutral
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton Neutral {sLabel:'value', sName:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
| sName | string | optional | NULL | See {@link Button::$sName} |
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+----------------------------+
|
||||
|
||||
.. _ButtonForPrimaryAction:
|
||||
|
||||
Button ForPrimaryAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForPrimaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForSecondaryAction:
|
||||
|
||||
Button ForSecondaryAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForSecondaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForPositiveAction:
|
||||
|
||||
Button ForPositiveAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForPositiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForDestructiveAction:
|
||||
|
||||
Button ForDestructiveAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForDestructiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonAlternativeNeutral:
|
||||
|
||||
Button AlternativeNeutral
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton AlternativeNeutral {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForAlternativePrimaryAction:
|
||||
|
||||
Button ForAlternativePrimaryAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForAlternativePrimaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForAlternativeSecondaryAction:
|
||||
|
||||
Button ForAlternativeSecondaryAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForAlternativeSecondaryAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForAlternativeValidationAction:
|
||||
|
||||
Button ForAlternativeValidationAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForAlternativeValidationAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForAlternativeDestructiveAction:
|
||||
|
||||
Button ForAlternativeDestructiveAction
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForAlternativeDestructiveAction {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+-------+---------------------+
|
||||
|
||||
.. _ButtonForCancel:
|
||||
|
||||
Button ForCancel
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton ForCancel {sLabel:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sLabel | string | optional | NULL | |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sName | string | optional | NULL | See Button::$sName |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sValue | string | optional | NULL | See Button::$sValue |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| bIsSubmit | bool | optional | false | See Button::$sType |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+----------+-------+---------------------+
|
||||
|
||||
.. _ButtonIconAction:
|
||||
|
||||
Button IconAction
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton IconAction {sIconClasses:'value', sTooltipText:'value', sName:'value', sValue:'value', bIsSubmit:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sIconClasses | string | mandatory | | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sTooltipText | string | optional | '' | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sName | string | optional | NULL | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sValue | string | optional | NULL | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| bIsSubmit | bool | optional | false | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+-------+--+
|
||||
|
||||
.. _ButtonLinkNeutral:
|
||||
|
||||
Button LinkNeutral
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton LinkNeutral {sURL:'value', sLabel:'value', sIconClasses:'value', sTarget:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sURL | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sLabel | string | optional | '' | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sIconClasses | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTarget | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
|
||||
.. _ButtonIconLink:
|
||||
|
||||
Button IconLink
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton IconLink {sIconClasses:'value', sTooltipText:'value', sURL:'value', sTarget:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sIconClasses | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTooltipText | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sURL | string | optional | '' | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTarget | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
|
||||
.. _ButtonDestructiveIconLink:
|
||||
|
||||
Button DestructiveIconLink
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButton DestructiveIconLink {sIconClasses:'value', sTooltipText:'value', sURL:'value', sName:'value', sTarget:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sIconClasses | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTooltipText | string | mandatory | | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sURL | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sName | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sTarget | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+------+--+
|
||||
|
||||
Button common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| ActionType | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Color | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IconClass | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsDisabled | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| JsCode | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Label | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| OnClickJsCode | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Tooltip | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Button/ButtonFooter.rst
|
||||
@@ -0,0 +1,88 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _ButtonGroup:
|
||||
|
||||
ButtonGroup
|
||||
===========
|
||||
|
||||
Class ButtonGroup
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/ButtonGroup/ButtonGroupAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIButtonGroup**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButtonGroup Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ButtonWithOptionsMenu <ButtonGroupButtonWithOptionsMenu>` | Make a button that has a primary action ($oButton) but also an options menu ($oMenu) on the side |
|
||||
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _ButtonGroupButtonWithOptionsMenu:
|
||||
|
||||
ButtonGroup ButtonWithOptionsMenu
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIButtonGroup ButtonWithOptionsMenu {oButton:value, oMenu:value} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+---------+-------------+-----------+--+--+
|
||||
| oButton | Button | mandatory | | |
|
||||
+---------+-------------+-----------+--+--+
|
||||
| oMenu | PopoverMenu | mandatory | | |
|
||||
+---------+-------------+-----------+--+--+
|
||||
|
||||
ButtonGroup common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddButton | Button | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddButtons | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddExtraBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Buttons | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/ButtonGroup/ButtonGroupFooter.rst
|
||||
@@ -0,0 +1,96 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _CollapsibleSection:
|
||||
|
||||
CollapsibleSection
|
||||
==================
|
||||
|
||||
Class CollapsibleSection
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/CollapsibleSection/CollapsibleSectionAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UICollapsibleSection**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UICollapsibleSection Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUICollapsibleSection %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------------------------------------------+-----------------------+
|
||||
| :ref:`Standard <CollapsibleSectionStandard>` | @param string $sTitle |
|
||||
+----------------------------------------------+-----------------------+
|
||||
|
||||
.. _CollapsibleSectionStandard:
|
||||
|
||||
CollapsibleSection Standard
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UICollapsibleSection Standard {sTitle:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUICollapsibleSection %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
CollapsibleSection common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| OpenedByDefault | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/CollapsibleSection/CollapsibleSectionFooter.rst
|
||||
32
.doc/UI/source/generated/Component/Component.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Components:
|
||||
|
||||
UI Components
|
||||
=============
|
||||
|
||||
A UI component is a unitary block used to display information in iTop console.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Components:
|
||||
|
||||
Alert/Alert
|
||||
Button/Button
|
||||
ButtonGroup/ButtonGroup
|
||||
CollapsibleSection/CollapsibleSection
|
||||
DataTable/DataTable
|
||||
Field/Field
|
||||
FieldBadge/FieldBadge
|
||||
FieldSet/FieldSet
|
||||
Form/Form
|
||||
Input/FileSelect/FileSelect
|
||||
Input/Input
|
||||
Input/Select/Select
|
||||
Input/Select/SelectOption
|
||||
Panel/Panel
|
||||
Spinner/Spinner
|
||||
Title/Title
|
||||
Toolbar/Toolbar
|
||||
Toolbar/ToolbarSpacer/ToolbarSpacer
|
||||
249
.doc/UI/source/generated/Component/DataTable/DataTable.rst
Normal file
@@ -0,0 +1,249 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _DataTable:
|
||||
|
||||
DataTable
|
||||
=========
|
||||
|
||||
Class DataTable
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/DataTable/DataTableAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIDataTable**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
| :ref:`ForResult <DataTableForResult>` | @param \WebPage $oPage |
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
| :ref:`ForObject <DataTableForObject>` | @param \WebPage $oPage |
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
| :ref:`ForRendering <DataTableForRendering>` | Make a basis Panel component |
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
| :ref:`ForRenderingObject <DataTableForRenderingObject>` | @param string $sListId |
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
| :ref:`ForStaticData <DataTableForStaticData>` | @param string $sTitle |
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
| :ref:`ForForm <DataTableForForm>` | @param string $sRef |
|
||||
+---------------------------------------------------------+------------------------------+
|
||||
|
||||
.. _DataTableForResult:
|
||||
|
||||
DataTable ForResult
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable ForResult {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oPage | WebPage | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
.. _DataTableForObject:
|
||||
|
||||
DataTable ForObject
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable ForObject {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oPage | WebPage | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
.. _DataTableForRendering:
|
||||
|
||||
DataTable ForRendering
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable ForRendering {sListId:'value', oSet:value, aExtraParams:value} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
.. _DataTableForRenderingObject:
|
||||
|
||||
DataTable ForRenderingObject
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable ForRenderingObject {sListId:'value', oSet:value, aExtraParams:value} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| sListId | string | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| oSet | DBObjectSet | mandatory | | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
| aExtraParams | | optional | array () | |
|
||||
+--------------+-------------+-----------+----------+--+
|
||||
|
||||
.. _DataTableForStaticData:
|
||||
|
||||
DataTable ForStaticData
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable ForStaticData {sTitle:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sId:'value', aExtraParams:{name:value, name:value}, sFilter:'value', aOptions:{name:value, name:value}} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aColumns | array | mandatory | | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aData | array | mandatory | | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aExtraParams | array | optional | array () | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| sFilter | string | optional | '' | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
| aOptions | array | optional | array () | |
|
||||
+--------------+--------+-----------+----------+--+
|
||||
|
||||
.. _DataTableForForm:
|
||||
|
||||
DataTable ForForm
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIDataTable ForForm {sRef:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sFilter:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIDataTable %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+----------+--------+-----------+----------+--+
|
||||
| sRef | string | mandatory | | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
| aColumns | array | mandatory | | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
| aData | array | optional | array () | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
| sFilter | string | optional | '' | |
|
||||
+----------+--------+-----------+----------+--+
|
||||
|
||||
DataTable common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AjaxData | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AjaxUrl | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DisplayColumns | | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| InitDisplayData | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| JSRefresh | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Options | | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| ResultColumns | | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/DataTable/DataTableFooter.rst
|
||||
220
.doc/UI/source/generated/Component/Field/Field.rst
Normal file
@@ -0,0 +1,220 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Field:
|
||||
|
||||
Field
|
||||
=====
|
||||
|
||||
Class Field
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Field/FieldAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIField**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIField Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`FromParams <FieldFromParams>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`FromObject <FieldFromObject>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`Large <FieldLarge>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`Small <FieldSmall>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`Standard <FieldStandard>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
|
||||
.. _FieldFromParams:
|
||||
|
||||
Field FromParams
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIField FromParams {aParams:value} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+---------+--+-----------+--+--+
|
||||
| aParams | | mandatory | | |
|
||||
+---------+--+-----------+--+--+
|
||||
|
||||
.. _FieldFromObject:
|
||||
|
||||
Field FromObject
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIField FromObject {sLabel:'value', oInput:value, sLayout:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+---------+---------+-----------+------+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+---------+---------+-----------+------+--+
|
||||
| oInput | UIBlock | mandatory | | |
|
||||
+---------+---------+-----------+------+--+
|
||||
| sLayout | string | optional | NULL | |
|
||||
+---------+---------+-----------+------+--+
|
||||
|
||||
.. _FieldLarge:
|
||||
|
||||
Field Large
|
||||
^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIField Large {sLabel:'value', sValueHtml:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+------------+--------+-----------+----+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+------------+--------+-----------+----+--+
|
||||
| sValueHtml | string | optional | '' | |
|
||||
+------------+--------+-----------+----+--+
|
||||
|
||||
.. _FieldSmall:
|
||||
|
||||
Field Small
|
||||
^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIField Small {sLabel:'value', sValueHtml:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+------------+--------+-----------+----+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+------------+--------+-----------+----+--+
|
||||
| sValueHtml | string | optional | '' | |
|
||||
+------------+--------+-----------+----+--+
|
||||
|
||||
.. _FieldStandard:
|
||||
|
||||
Field Standard
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIField Standard {sLabel:'value', sLayout:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIField %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+---------+--------+----------+---------+--+
|
||||
| sLabel | string | optional | '' | |
|
||||
+---------+--------+----------+---------+--+
|
||||
| sLayout | string | optional | 'small' | |
|
||||
+---------+--------+----------+---------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+---------+--------+----------+---------+--+
|
||||
|
||||
Field common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AttCode | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AttLabel | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AttType | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Comments | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| InputId | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| InputType | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsMandatory | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsReadOnly | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsSlave | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Label | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Layout | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| MustChange | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| MustPrompt | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Value | UIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| ValueId | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| ValueRaw | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Field/FieldFooter.rst
|
||||
94
.doc/UI/source/generated/Component/FieldBadge/FieldBadge.rst
Normal file
@@ -0,0 +1,94 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _FieldBadge:
|
||||
|
||||
FieldBadge
|
||||
==========
|
||||
|
||||
Class FieldBadge
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldBadge/FieldBadgeAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIFieldBadge**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFieldBadge Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldBadge %}
|
||||
|
||||
:Type:
|
||||
|
||||
+--------------------------------------+-----------------------+
|
||||
| :ref:`ForField <FieldBadgeForField>` | @param string $sValue |
|
||||
+--------------------------------------+-----------------------+
|
||||
|
||||
.. _FieldBadgeForField:
|
||||
|
||||
FieldBadge ForField
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFieldBadge ForField {sValue:'value', oStyle:value} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldBadge %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+----------+-----------+--+--+
|
||||
| sValue | string | mandatory | | |
|
||||
+--------+----------+-----------+--+--+
|
||||
| oStyle | ormStyle | mandatory | | |
|
||||
+--------+----------+-----------+--+--+
|
||||
|
||||
FieldBadge common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldBadge/FieldBadgeFooter.rst
|
||||
94
.doc/UI/source/generated/Component/FieldSet/FieldSet.rst
Normal file
@@ -0,0 +1,94 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _FieldSet:
|
||||
|
||||
FieldSet
|
||||
========
|
||||
|
||||
Class FieldSet
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldSet/FieldSetAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIFieldSet**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFieldSet Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------------+------------------------+
|
||||
| :ref:`Standard <FieldSetStandard>` | @param string $sLegend |
|
||||
+------------------------------------+------------------------+
|
||||
|
||||
.. _FieldSetStandard:
|
||||
|
||||
FieldSet Standard
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFieldSet Standard {sLegend:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIFieldSet %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+---------+--------+-----------+------+--+
|
||||
| sLegend | string | mandatory | | |
|
||||
+---------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+---------+--------+-----------+------+--+
|
||||
|
||||
FieldSet common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/FieldSet/FieldSetFooter.rst
|
||||
96
.doc/UI/source/generated/Component/Form/Form.rst
Normal file
@@ -0,0 +1,96 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Form:
|
||||
|
||||
Form
|
||||
====
|
||||
|
||||
Class Form
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Form/FormAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIForm**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIForm Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIForm %}
|
||||
|
||||
:Type:
|
||||
|
||||
+--------------------------------+-------------------------+
|
||||
| :ref:`Standard <FormStandard>` | @param string|null $sId |
|
||||
+--------------------------------+-------------------------+
|
||||
|
||||
.. _FormStandard:
|
||||
|
||||
Form Standard
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIForm Standard {sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIForm %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
Form common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| Action | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| OnSubmitJsCode | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Form/FormFooter.rst
|
||||
@@ -0,0 +1,86 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _FileSelect:
|
||||
|
||||
FileSelect
|
||||
==========
|
||||
|
||||
Class FileSelect
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/FileSelect/FileSelectAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIFileSelect**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFileSelect Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+--------------------------------------+----------------------+
|
||||
| :ref:`Standard <FileSelectStandard>` | @param string $sName |
|
||||
+--------------------------------------+----------------------+
|
||||
|
||||
.. _FileSelectStandard:
|
||||
|
||||
FileSelect Standard
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIFileSelect Standard {sName:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------+--------+-----------+------+--+
|
||||
| sName | string | mandatory | | |
|
||||
+-------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------+--------+-----------+------+--+
|
||||
|
||||
FileSelect common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| ButtonText | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| FileName | | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| ShowFilename | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/FileSelect/FileSelectFooter.rst
|
||||
150
.doc/UI/source/generated/Component/Input/Input.rst
Normal file
@@ -0,0 +1,150 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Input:
|
||||
|
||||
Input
|
||||
=====
|
||||
|
||||
Class Input
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/InputAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIInput**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIInput Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`ForHidden <InputForHidden>` | No comment |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`Standard <InputStandard>` | No comment |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`ForInputWithLabel <InputForInputWithLabel>` | @see Field component that is better adapter when dealing with a standard iTop form |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------------------+
|
||||
|
||||
.. _InputForHidden:
|
||||
|
||||
Input ForHidden
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIInput ForHidden {sName:'value', sValue:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sName | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sValue | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
.. _InputStandard:
|
||||
|
||||
Input Standard
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIInput Standard {sType:'value', sName:'value', sValue:'value', sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sType | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sName | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sValue | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
.. _InputForInputWithLabel:
|
||||
|
||||
Input ForInputWithLabel
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIInput ForInputWithLabel {sLabel:'value', sInputName:'value', sInputValue:'value', sInputId:'value', sInputType:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------------+--------+-----------+--------+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-------------+--------+-----------+--------+--+
|
||||
| sInputName | string | mandatory | | |
|
||||
+-------------+--------+-----------+--------+--+
|
||||
| sInputValue | string | optional | NULL | |
|
||||
+-------------+--------+-----------+--------+--+
|
||||
| sInputId | string | optional | NULL | |
|
||||
+-------------+--------+-----------+--------+--+
|
||||
| sInputType | string | optional | 'type' | |
|
||||
+-------------+--------+-----------+--------+--+
|
||||
|
||||
Input common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsChecked | | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsDisabled | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsReadonly | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Label | | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Name | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Placeholder | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Type | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Value | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/InputFooter.rst
|
||||
133
.doc/UI/source/generated/Component/Input/Select/Select.rst
Normal file
@@ -0,0 +1,133 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Select:
|
||||
|
||||
Select
|
||||
======
|
||||
|
||||
Class Select
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/Select/SelectAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UISelect**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISelect Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUISelect %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------------------------------+------------------------------------+
|
||||
| :ref:`ForSelect <SelectForSelect>` | Create a default Select input |
|
||||
+------------------------------------------------------+------------------------------------+
|
||||
| :ref:`ForSelectWithLabel <SelectForSelectWithLabel>` | Create a Select input with a label |
|
||||
+------------------------------------------------------+------------------------------------+
|
||||
|
||||
.. _SelectForSelect:
|
||||
|
||||
Select ForSelect
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISelect ForSelect {sName:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUISelect %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------+--------+-----------+------+-------------------------+
|
||||
| sName | string | mandatory | | Input name for the form |
|
||||
+-------+--------+-----------+------+-------------------------+
|
||||
| sId | string | optional | NULL | ID of the block |
|
||||
+-------+--------+-----------+------+-------------------------+
|
||||
|
||||
.. _SelectForSelectWithLabel:
|
||||
|
||||
Select ForSelectWithLabel
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISelect ForSelectWithLabel {sName:'value', sLabel:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUISelect %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+-----------------------------------------------------+
|
||||
| sName | string | mandatory | | Input name for the form |
|
||||
+--------+--------+-----------+------+-----------------------------------------------------+
|
||||
| sLabel | string | mandatory | | Label to display with the input (null for no label) |
|
||||
+--------+--------+-----------+------+-----------------------------------------------------+
|
||||
| sId | string | optional | NULL | ID of the block |
|
||||
+--------+--------+-----------+------+-----------------------------------------------------+
|
||||
|
||||
Select common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddOption | SelectOption | Select option UIBlock |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| Description | string | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| IsLabelBefore | bool | If true the label will be positioned before the input |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| IsMultiple | bool | Allow multiple selection |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| Label | string | Label to display with the input (null for no label) |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| Name | string | Input name for the form |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
| SubmitOnChange | bool | if true submit the form as soon as a change is detected |
|
||||
+-----------------------------+--------------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/Select/SelectFooter.rst
|
||||
@@ -0,0 +1,92 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _SelectOption:
|
||||
|
||||
SelectOption
|
||||
============
|
||||
|
||||
Class SelectOption
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/Select/SelectOptionAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UISelectOption**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISelectOption Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+------------------------------------------------------+------------+
|
||||
| :ref:`ForSelectOption <SelectOptionForSelectOption>` | No comment |
|
||||
+------------------------------------------------------+------------+
|
||||
|
||||
.. _SelectOptionForSelectOption:
|
||||
|
||||
SelectOption ForSelectOption
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISelectOption ForSelectOption {sValue:'value', sLabel:'value', bSelected:true, sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sValue | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sLabel | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| bSelected | bool | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
SelectOption common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Disabled | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Label | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Selected | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| Value | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Input/Select/SelectOptionFooter.rst
|
||||
320
.doc/UI/source/generated/Component/Panel/Panel.rst
Normal file
@@ -0,0 +1,320 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Panel:
|
||||
|
||||
Panel
|
||||
=====
|
||||
|
||||
Class Panel
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Panel/PanelAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIPanel**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`Neutral <PanelNeutral>` | Make a basis Panel component |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`ForInformation <PanelForInformation>` | Make a Panel component for informational messages |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`ForSuccess <PanelForSuccess>` | Make a Panel component for successful messages |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`ForWarning <PanelForWarning>` | Make a Panel component for warning messages |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`ForDanger <PanelForDanger>` | Make a Panel component for danger messages |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`ForFailure <PanelForFailure>` | Make a Panel component for failure messages |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`WithBrandingPrimaryColor <PanelWithBrandingPrimaryColor>` | Make a Panel component with primary color scheme |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`WithBrandingSecondaryColor <PanelWithBrandingSecondaryColor>` | Make a Panel component with secondary color scheme |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`ForClass <PanelForClass>` | Make a Panel component with the specific $sClass color scheme |
|
||||
+---------------------------------------------------------------------+---------------------------------------------------------------+
|
||||
|
||||
.. _PanelNeutral:
|
||||
|
||||
Panel Neutral
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel Neutral {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelForInformation:
|
||||
|
||||
Panel ForInformation
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel ForInformation {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelForSuccess:
|
||||
|
||||
Panel ForSuccess
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel ForSuccess {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelForWarning:
|
||||
|
||||
Panel ForWarning
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel ForWarning {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelForDanger:
|
||||
|
||||
Panel ForDanger
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel ForDanger {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelForFailure:
|
||||
|
||||
Panel ForFailure
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel ForFailure {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelWithBrandingPrimaryColor:
|
||||
|
||||
Panel WithBrandingPrimaryColor
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel WithBrandingPrimaryColor {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelWithBrandingSecondaryColor:
|
||||
|
||||
Panel WithBrandingSecondaryColor
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel WithBrandingSecondaryColor {sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--+
|
||||
|
||||
.. _PanelForClass:
|
||||
|
||||
Panel ForClass
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIPanel ForClass {sClass:'value', sTitle:'value', sSubTitle:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIPanel %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
| sClass | string | mandatory | | Class of the object the panel is for |
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
| sTitle | string | mandatory | | |
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
| sSubTitle | string | optional | NULL | |
|
||||
+-----------+--------+-----------+------+--------------------------------------+
|
||||
|
||||
Panel common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddMainBlock | iUIBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddMainBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddSubTitleBlock | iUIBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddSubTitleBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddTitleBlock | iUIBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddTitleBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddToolbarBlock | iUIBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| AddToolbarBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| CSSColorClass | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| ColorFromClass | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| ColorFromColorSemantic | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| ColorFromOrmStyle | ormStyle | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| IsCollapsible | bool | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| IsHeaderVisibleOnScroll | bool | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| MainBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| SubTitle | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| SubTitleBlock | iUIContentBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| Title | string | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| TitleBlock | iUIContentBlock | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
| ToolBlocks | array | |
|
||||
+-----------------------------+-----------------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Panel/PanelFooter.rst
|
||||
78
.doc/UI/source/generated/Component/Spinner/Spinner.rst
Normal file
@@ -0,0 +1,78 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Spinner:
|
||||
|
||||
Spinner
|
||||
=======
|
||||
|
||||
Class Spinner
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Spinner/SpinnerAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UISpinner**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISpinner Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------------------------+------------+
|
||||
| :ref:`Standard <SpinnerStandard>` | No comment |
|
||||
+-----------------------------------+------------+
|
||||
|
||||
.. _SpinnerStandard:
|
||||
|
||||
Spinner Standard
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UISpinner Standard {sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
Spinner common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Spinner/SpinnerFooter.rst
|
||||
173
.doc/UI/source/generated/Component/Title/Title.rst
Normal file
@@ -0,0 +1,173 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Title:
|
||||
|
||||
Title
|
||||
=====
|
||||
|
||||
Class Title
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Title/TitleAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UITitle**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UITitle Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------------------------------------+------------+
|
||||
| :ref:`ForPage <TitleForPage>` | No comment |
|
||||
+-----------------------------------------------+------------+
|
||||
| :ref:`ForPageWithIcon <TitleForPageWithIcon>` | No comment |
|
||||
+-----------------------------------------------+------------+
|
||||
| :ref:`Neutral <TitleNeutral>` | No comment |
|
||||
+-----------------------------------------------+------------+
|
||||
| :ref:`Standard <TitleStandard>` | No comment |
|
||||
+-----------------------------------------------+------------+
|
||||
|
||||
.. _TitleForPage:
|
||||
|
||||
Title ForPage
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UITitle ForPage {sTitle:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
.. _TitleForPageWithIcon:
|
||||
|
||||
Title ForPageWithIcon
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UITitle ForPageWithIcon {sTitle:'value', sIconUrl:'value', sIconCoverMethod:'value', bIsMedallion:true, sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sIconUrl | string | mandatory | | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sIconCoverMethod | string | optional | 'contain' | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| bIsMedallion | bool | optional | true | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+------------------+--------+-----------+-----------+--+
|
||||
|
||||
.. _TitleNeutral:
|
||||
|
||||
Title Neutral
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UITitle Neutral {sTitle:'value', iLevel:value, sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+--------+-----------+------+--+
|
||||
| sTitle | string | mandatory | | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| iLevel | int | optional | 1 | |
|
||||
+--------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+--------+-----------+------+--+
|
||||
|
||||
.. _TitleStandard:
|
||||
|
||||
Title Standard
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UITitle Standard {oTitle:value, iLevel:value, sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUITitle %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+---------+-----------+------+--+
|
||||
| oTitle | UIBlock | mandatory | | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| iLevel | int | optional | 1 | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+---------+-----------+------+--+
|
||||
|
||||
Title common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Title/TitleFooter.rst
|
||||
138
.doc/UI/source/generated/Component/Toolbar/Toolbar.rst
Normal file
@@ -0,0 +1,138 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Toolbar:
|
||||
|
||||
Toolbar
|
||||
=======
|
||||
|
||||
Class Toolbar
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIToolbar**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIToolbar Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIToolbar %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`ForAction <ToolbarForAction>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`Standard <ToolbarStandard>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
| :ref:`ForButton <ToolbarForButton>` | No comment |
|
||||
+-------------------------------------+------------+
|
||||
|
||||
.. _ToolbarForAction:
|
||||
|
||||
Toolbar ForAction
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIToolbar ForAction {sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIToolbar %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
.. _ToolbarStandard:
|
||||
|
||||
Toolbar Standard
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIToolbar Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
|
||||
Content Goes Here
|
||||
{% EndUIToolbar %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
.. _ToolbarForButton:
|
||||
|
||||
Toolbar ForButton
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIToolbar ForButton {sId:'value', aContainerClasses:{name:value, name:value}} %}
|
||||
Content Goes Here
|
||||
{% EndUIToolbar %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
Toolbar common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarFooter.rst
|
||||
@@ -0,0 +1,78 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _ToolbarSpacer:
|
||||
|
||||
ToolbarSpacer
|
||||
=============
|
||||
|
||||
Class ButtonToolbarSpacer
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIToolbarSpacer**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIToolbarSpacer Type {Parameters} %}
|
||||
|
||||
:Type:
|
||||
|
||||
+-----------------------------------------+-------------------------+
|
||||
| :ref:`Standard <ToolbarSpacerStandard>` | @param string|null $sId |
|
||||
+-----------------------------------------+-------------------------+
|
||||
|
||||
.. _ToolbarSpacerStandard:
|
||||
|
||||
ToolbarSpacer Standard
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIToolbarSpacer Standard {sId:'value'} %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
ToolbarSpacer common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+--------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Component/Toolbar/ToolbarSpacer/ToolbarSpacerFooter.rst
|
||||
17
.doc/UI/source/generated/Layout/Layout.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. Copyright (C) 2010-2021 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Layouts:
|
||||
|
||||
UI Layouts
|
||||
==========
|
||||
|
||||
A UI block that serves as a layout for the page.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Components:
|
||||
|
||||
MultiColumn/Column/Column
|
||||
MultiColumn/MultiColumn
|
||||
UIContentBlock
|
||||
115
.doc/UI/source/generated/Layout/MultiColumn/Column/Column.rst
Normal file
@@ -0,0 +1,115 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _Column:
|
||||
|
||||
Column
|
||||
======
|
||||
|
||||
Class Column
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/Column/ColumnAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIColumn**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIColumn Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:Type:
|
||||
|
||||
+----------------------------------+------------+
|
||||
| :ref:`Standard <ColumnStandard>` | No comment |
|
||||
+----------------------------------+------------+
|
||||
| :ref:`ForBlock <ColumnForBlock>` | No comment |
|
||||
+----------------------------------+------------+
|
||||
|
||||
.. _ColumnStandard:
|
||||
|
||||
Column Standard
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIColumn Standard {sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
.. _ColumnForBlock:
|
||||
|
||||
Column ForBlock
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIColumn ForBlock {oBlock:value, sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIColumn %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+--------+---------+-----------+------+--+
|
||||
| oBlock | UIBlock | mandatory | | |
|
||||
+--------+---------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+--------+---------+-----------+------+--+
|
||||
|
||||
Column common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/Column/ColumnFooter.rst
|
||||
94
.doc/UI/source/generated/Layout/MultiColumn/MultiColumn.rst
Normal file
@@ -0,0 +1,94 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _MultiColumn:
|
||||
|
||||
MultiColumn
|
||||
===========
|
||||
|
||||
Class MultiColumn
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/MultiColumnAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIMultiColumn**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIMultiColumn Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIMultiColumn %}
|
||||
|
||||
:Type:
|
||||
|
||||
+---------------------------------------+------------+
|
||||
| :ref:`Standard <MultiColumnStandard>` | No comment |
|
||||
+---------------------------------------+------------+
|
||||
|
||||
.. _MultiColumnStandard:
|
||||
|
||||
MultiColumn Standard
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIMultiColumn Standard {sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIMultiColumn %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-----+--------+----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-----+--------+----------+------+--+
|
||||
|
||||
MultiColumn common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddColumn | Column | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/MultiColumn/MultiColumnFooter.rst
|
||||
141
.doc/UI/source/generated/Layout/UIContentBlock.rst
Normal file
@@ -0,0 +1,141 @@
|
||||
.. Copyright (C) 2010-2022 Combodo SARL
|
||||
.. http://opensource.org/licenses/AGPL-3.0
|
||||
|
||||
.. _UIContentBlock:
|
||||
|
||||
UIContentBlock
|
||||
==============
|
||||
|
||||
Class UIContentBlock
|
||||
Base block containing sub-blocks
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/UIContentBlockAdditionalDescription.rst
|
||||
|
||||
----
|
||||
|
||||
Twig Tag
|
||||
--------
|
||||
|
||||
:Tag: **UIContentBlock**
|
||||
|
||||
:Syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock Type {Parameters} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:Type:
|
||||
|
||||
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Standard <UIContentBlockStandard>` | Make an empty UIContentBlock which can be used to embed anything or to surround another block with specific CSS classes. |
|
||||
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForCode <UIContentBlockForCode>` | Used to display a block of code like <pre> but allows line break. |
|
||||
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ForPreformatted <UIContentBlockForPreformatted>` | Used to display a block of preformatted text in a <pre> tag. |
|
||||
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _UIContentBlockStandard:
|
||||
|
||||
UIContentBlock Standard
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock Standard {sId:'value', aContainerClasses:{name:value, name:value}} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
| aContainerClasses | array | optional | array () | |
|
||||
+-------------------+--------+----------+----------+--+
|
||||
|
||||
.. _UIContentBlockForCode:
|
||||
|
||||
UIContentBlock ForCode
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock ForCode {sCode:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------+--------+-----------+------+--+
|
||||
| sCode | string | mandatory | | |
|
||||
+-------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------+--------+-----------+------+--+
|
||||
|
||||
.. _UIContentBlockForPreformatted:
|
||||
|
||||
UIContentBlock ForPreformatted
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:syntax:
|
||||
|
||||
.. code-block:: twig
|
||||
|
||||
{% UIContentBlock ForPreformatted {sCode:'value', sId:'value'} %}
|
||||
Content Goes Here
|
||||
{% EndUIContentBlock %}
|
||||
|
||||
:parameters:
|
||||
|
||||
+-------+--------+-----------+------+--+
|
||||
| sCode | string | mandatory | | |
|
||||
+-------+--------+-----------+------+--+
|
||||
| sId | string | optional | NULL | |
|
||||
+-------+--------+-----------+------+--+
|
||||
|
||||
UIContentBlock common parameters
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClass | string | CSS class to add to the generated html block |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddCssFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddDeferredBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddHtml | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddJsFileRelPath | string | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleCssFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddMultipleJsFilesRelPaths | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| AddSubBlock | iUIBlock | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| CSSClasses | array | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DataAttributes | array | Array of data attributes in the format ['name' => 'value'] |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| DeferredBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| HasForcedDiv | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| IsHidden | bool | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
| SubBlocks | array | |
|
||||
+-----------------------------+----------+------------------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
.. include:: /manual/Layout/UIContentBlockFooter.rst
|
||||
BIN
.doc/UI/source/img/itop-logo-square.png
Normal file
|
After Width: | Height: | Size: 2.2 KiB |