elmau
/
zaz
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add parameter

This commit is contained in:
Mauricio Baeza 2021-02-06 22:05:20 -06:00
parent 79f316edaa
commit ea1c7f2a01
6 changed files with 304 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
doc/build/doctrees/main/config.doctree vendored
View File

Binary file not shown.

95
doc/build/html/_sources/main/config.rst.txt vendored
View File

@ -300,5 +300,100 @@ Example:
)
Functions
^^^^^^^^^
Only for Add-in extension (`TYPE_EXTENSION = 2`). Can be multi language.
The key of dictionary, is the same name of your function. Used exactly you used in your code.
**FUNCTIONS**
* Dictionary of dictionaries
* **displayname** = Show in function wizard, multi language.
* **description** = Show in function wizard, multi language.
* **parameters** = Each parameters in your function.
* **key** = Is the exactly name for parameter in your code function.
* **displayname** = Show in function wizard, multi language.
* **description** = Show in function wizard, multi language.
Example:
.. code-block:: python
FUNCTIONS = {
'test': {
'displayname': {'en': 'test', 'es': 'prueba'},
'description': {'en': 'My test', 'es': 'Mi prueba'},
'parameters': {
'value': {
'displayname': {'en': 'value', 'es': 'valor'},
'description': {'en': 'The value', 'es': 'El valor'},
},
},
},
}
Default program
^^^^^^^^^^^^^^^
Open automaticaly when install and test.
**PROGRAM**
* String
* --calc
* --writer
* --draw
* --impress
Example:
.. code-block:: python
PROGRAM = '--calc'
File test
^^^^^^^^^
Open automaticaly when install and test.
* String
Example:
.. code-block:: python
FILE_TEST = '/home/mau/example.ods'
Paths
^^^^^
Paths for install and test. `idlc`, `include` and `remerge` only used en `TYPE_EXTENSION` 2 or 3. `idlc` and path `include` is installed with LibreOffice SDK.
**PATHS**
* Dictionary
* **idlc** for generate files urd.
* **include** path with files idl.
* **remerge** for generate files rdb.
* **soffice** for open LibreOffice.
* **install** for install extension.
Example:
.. code-block:: python
PATHS = {
'idlc': '/usr/lib/libreoffice/sdk/bin/idlc',
'include': '/usr/share/idl/libreoffice',
'regmerge': '/usr/lib/libreoffice/program/regmerge',
'soffice': ('soffice', PROGRAM, FILE_TEST),
'install': ('unopkg', 'add', '-v', '-f', '-s'),
}
.. _Semantic Versioning: https://semver.org/

113
doc/build/html/main/config.html vendored
View File

@ -322,6 +322,119 @@
</pre></div>
</div>
</div>
<div class="section" id="functions">
<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h3>
<p>Only for Add-in extension (<cite>TYPE_EXTENSION = 2</cite>). Can be multi language.</p>
<p>The key of dictionary, is the same name of your function. Used exactly you used in your code.</p>
<p><strong>FUNCTIONS</strong></p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>Dictionary of dictionaries</dt><dd><ul>
<li><p><strong>displayname</strong> = Show in function wizard, multi language.</p></li>
<li><p><strong>description</strong> = Show in function wizard, multi language.</p></li>
<li><dl class="simple">
<dt><strong>parameters</strong> = Each parameters in your function.</dt><dd><ul>
<li><dl class="simple">
<dt><strong>key</strong> = Is the exactly name for parameter in your code function.</dt><dd><ul>
<li><p><strong>displayname</strong> = Show in function wizard, multi language.</p></li>
<li><p><strong>description</strong> = Show in function wizard, multi language.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</dd>
</dl>
</li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">FUNCTIONS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;test&#39;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;displayname&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;test&#39;</span><span class="p">,</span> <span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="s1">&#39;prueba&#39;</span><span class="p">},</span>
<span class="s1">&#39;description&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;My test&#39;</span><span class="p">,</span> <span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="s1">&#39;Mi prueba&#39;</span><span class="p">},</span>
<span class="s1">&#39;parameters&#39;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;displayname&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;value&#39;</span><span class="p">,</span> <span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="s1">&#39;valor&#39;</span><span class="p">},</span>
<span class="s1">&#39;description&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;The value&#39;</span><span class="p">,</span> <span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="s1">&#39;El valor&#39;</span><span class="p">},</span>
<span class="p">},</span>
<span class="p">},</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="default-program">
<h3>Default program<a class="headerlink" href="#default-program" title="Permalink to this headline"></a></h3>
<p>Open automaticaly when install and test.</p>
<p><strong>PROGRAM</strong></p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>String</dt><dd><ul>
<li><p>–calc</p></li>
<li><p>–writer</p></li>
<li><p>–draw</p></li>
<li><p>–impress</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">PROGRAM</span> <span class="o">=</span> <span class="s1">&#39;--calc&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="file-test">
<h3>File test<a class="headerlink" href="#file-test" title="Permalink to this headline"></a></h3>
<p>Open automaticaly when install and test.</p>
<blockquote>
<div><ul class="simple">
<li><p>String</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">FILE_TEST</span> <span class="o">=</span> <span class="s1">&#39;/home/mau/example.ods&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="paths">
<h3>Paths<a class="headerlink" href="#paths" title="Permalink to this headline"></a></h3>
<p>Paths for install and test. <cite>idlc</cite>, <cite>include</cite> and <cite>remerge</cite> only used en <cite>TYPE_EXTENSION</cite> 2 or 3. <cite>idlc</cite> and path <cite>include</cite> is installed with LibreOffice SDK.</p>
<p><strong>PATHS</strong></p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>Dictionary</dt><dd><ul>
<li><p><strong>idlc</strong> for generate files urd.</p></li>
<li><p><strong>include</strong> path with files idl.</p></li>
<li><p><strong>remerge</strong> for generate files rdb.</p></li>
<li><p><strong>soffice</strong> for open LibreOffice.</p></li>
<li><p><strong>install</strong> for install extension.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">PATHS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;idlc&#39;</span><span class="p">:</span> <span class="s1">&#39;/usr/lib/libreoffice/sdk/bin/idlc&#39;</span><span class="p">,</span>
<span class="s1">&#39;include&#39;</span><span class="p">:</span> <span class="s1">&#39;/usr/share/idl/libreoffice&#39;</span><span class="p">,</span>
<span class="s1">&#39;regmerge&#39;</span><span class="p">:</span> <span class="s1">&#39;/usr/lib/libreoffice/program/regmerge&#39;</span><span class="p">,</span>
<span class="s1">&#39;soffice&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;soffice&#39;</span><span class="p">,</span> <span class="n">PROGRAM</span><span class="p">,</span> <span class="n">FILE_TEST</span><span class="p">),</span>
<span class="s1">&#39;install&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;unopkg&#39;</span><span class="p">,</span> <span class="s1">&#39;add&#39;</span><span class="p">,</span> <span class="s1">&#39;-v&#39;</span><span class="p">,</span> <span class="s1">&#39;-f&#39;</span><span class="p">,</span> <span class="s1">&#39;-s&#39;</span><span class="p">),</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>

2
doc/build/html/searchindex.js vendored
View File

@ -1 +1 @@
Search.setIndex({docnames:["index","main/config","main/intro"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","main/config.rst","main/intro.rst"],objects:{},objnames:{},objtypes:{},terms:{"2021":2,"extensi\u00f3n":1,"final":2,"function":2,"new":[1,2],"opci\u00f3n":1,"public":1,"true":1,FOR:1,For:1,Ons:1,The:1,With:2,absolut:1,add:[1,2],addin:[1,2],addonmenu:1,all:1,along:1,alt:1,ani:1,applic:1,argument:1,base:1,basic:2,befor:1,blank:1,bmp:1,bool:1,calc:[1,2],can:[1,2],clone:2,code:1,com:[],compon:[1,2],compress:2,conf:1,configur:0,content:0,context:1,copi:[1,2],correctli:1,cours:2,creat:[1,2],ctrl:1,cuat:2,current:1,descript:1,detail:1,develop:[1,2],dictionari:1,directori:2,displai:1,display_nam:1,distribut:1,domain:2,don:2,done:2,download:2,each:1,edit:1,either:1,elmau:[1,2],even:1,exampl:1,extens:0,extensionnam:1,file:[1,2],first:0,fit:1,folder:1,forget:2,format:1,foundat:1,free:1,from:2,gener:[1,2],git:2,gitlab:[],gnu:1,gran:1,great:1,have:1,hope:1,http:[1,2],i18n:1,imag:1,impli:1,index:0,info:[1,2],inform:[],instal:[0,1],integ:1,intern:1,introduct:0,invers:1,keyboard:1,label:1,languag:1,later:1,lib:1,libreoffic:[1,2],libreofric:[],license_:1,license_en:1,like:1,link:1,local:2,logo:1,look:1,macro:[1,2],make:2,manag:1,mauriciobaeza:[],menu_main:1,merchant:1,modifi:1,modul:0,more:1,move:[1,2],multi:1,myfirstextens:2,myfirstextension_v0:2,mygreatextens:1,name_16:1,name_26:1,net:[1,2],nombr:1,normal:1,now:2,officemenubar:1,one:1,onli:1,option1:1,option:1,org:1,overview:0,oxt:2,page:[0,1],paramet:0,part:1,particular:1,pass:1,path_pygettext:1,pleas:1,png:1,possibl:1,pot:[1,2],project:[1,2],properti:1,prueba:1,publish:1,purpos:1,python3:1,python:2,rapid:2,receiv:1,recomend:2,recommend:1,redistribut:1,rel:1,repositori:2,requir:0,same:1,script:2,sdk:2,search:0,see:1,semant:1,set:1,shift:1,shortcut:1,should:1,show:1,softwar:1,sourc:2,space:1,start:[1,2],string:1,successfulli:2,sucesfulli:2,support:2,t_shift_mod1_mod2:1,term:1,test:[1,2],testext:[],text:1,thi:[1,2],titl:1,too:1,tool:1,toolbar:1,tupl:1,two:1,type_extens:1,under:1,uniqu:1,unopkg:2,url:1,use:1,use_local:1,used:[1,2],useful:1,user:2,usr:1,valu:1,vim:1,want:1,warranti:1,what:1,when:1,where:1,without:1,writer:1,www:1,you:[1,2],your:1,yournam:1,zaz:[1,2]},titles:["Welcome to ZAZ\u2019s documentation!","Configuration","Introduction"],titleterms:{"new":[],author:1,configur:1,creat:[],current:[],document:0,domain:1,extens:[1,2],first:2,icon:1,indic:0,inform:1,instal:2,introduct:2,licens:1,local:1,main:1,menu:1,name:1,overview:2,paramet:1,parent:1,path:1,pygettext:1,requir:2,tabl:0,type:1,version:1,welcom:0,zaz:0}})
Search.setIndex({docnames:["index","main/config","main/intro"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","main/config.rst","main/intro.rst"],objects:{},objnames:{},objtypes:{},terms:{"2021":2,"extensi\u00f3n":1,"final":2,"function":2,"new":[1,2],"opci\u00f3n":1,"public":1,"true":1,FOR:1,For:1,Ons:1,The:1,Used:1,With:2,absolut:1,add:[1,2],addin:[1,2],addonmenu:1,all:1,along:1,alt:1,ani:1,applic:1,argument:1,automaticali:1,base:1,basic:2,befor:1,bin:1,blank:1,bmp:1,bool:1,calc:[1,2],can:[1,2],clone:2,code:1,com:[],compon:[1,2],compress:2,conf:1,configur:0,content:0,context:1,copi:[1,2],correctli:1,cours:2,creat:[1,2],ctrl:1,cuat:2,current:1,descript:1,detail:1,develop:[1,2],dictionari:1,directori:2,displai:1,display_nam:1,displaynam:1,distribut:1,domain:2,don:2,done:2,download:2,draw:1,each:1,edit:1,either:1,elmau:[1,2],even:1,exactli:1,exampl:1,extens:0,extensionnam:1,file:2,file_test:1,first:0,fit:1,folder:1,forget:2,format:1,foundat:1,free:1,from:2,gener:[1,2],git:2,gitlab:[],gnu:1,gran:1,great:1,have:1,home:1,hope:1,http:[1,2],i18n:1,idl:1,idlc:1,imag:1,impli:1,impress:1,includ:1,index:0,info:[1,2],inform:[],instal:[0,1],integ:1,intern:1,introduct:0,invers:1,kei:1,keyboard:1,label:1,languag:1,later:1,lib:1,libreoffic:[1,2],libreofric:[],license_:1,license_en:1,like:1,link:1,local:2,logo:1,look:1,macro:[1,2],make:2,manag:1,mau:1,mauriciobaeza:[],menu_main:1,merchant:1,modifi:1,modul:0,more:1,move:[1,2],multi:1,myfirstextens:2,myfirstextension_v0:2,mygreatextens:1,name_16:1,name_26:1,net:[1,2],nombr:1,normal:1,now:2,ods:1,officemenubar:1,one:1,onli:1,open:1,option1:1,option:1,org:1,overview:0,oxt:2,page:[0,1],paramet:0,part:1,particular:1,pass:1,path_pygettext:1,pleas:1,png:1,possibl:1,pot:[1,2],project:[1,2],properti:1,prueba:1,publish:1,purpos:1,python3:1,python:2,rapid:2,rdb:1,receiv:1,recomend:2,recommend:1,redistribut:1,regmerg:1,rel:1,remerg:1,repositori:2,requir:0,same:1,script:2,sdk:[1,2],search:0,see:1,semant:1,set:1,share:1,shift:1,shortcut:1,should:1,show:1,soffic:1,softwar:1,sourc:2,space:1,start:[1,2],string:1,successfulli:2,sucesfulli:2,support:2,t_shift_mod1_mod2:1,term:1,test:2,testext:[],text:1,thi:[1,2],titl:1,too:1,tool:1,toolbar:1,tupl:1,two:1,type_extens:1,under:1,uniqu:1,unopkg:[1,2],urd:1,url:1,use:1,use_local:1,used:[1,2],useful:1,user:2,usr:1,valor:1,valu:1,vim:1,want:1,warranti:1,what:1,when:1,where:1,without:1,wizard:1,writer:1,www:1,you:[1,2],your:1,yournam:1,zaz:[1,2]},titles:["Welcome to ZAZ\u2019s documentation!","Configuration","Introduction"],titleterms:{"default":1,"function":1,"new":[],author:1,configur:1,creat:[],current:[],document:0,domain:1,extens:[1,2],file:1,first:2,icon:1,indic:0,inform:1,instal:2,introduct:2,licens:1,local:1,main:1,menu:1,name:1,overview:2,paramet:1,parent:1,path:1,program:1,pygettext:1,requir:2,tabl:0,test:1,type:1,version:1,welcom:0,zaz:0}})

95
doc/source/main/config.rst
View File

@ -300,5 +300,100 @@ Example:
)
Functions
^^^^^^^^^
Only for Add-in extension (`TYPE_EXTENSION = 2`). Can be multi language.
The key of dictionary, is the same name of your function. Used exactly you used in your code.
**FUNCTIONS**
* Dictionary of dictionaries
* **displayname** = Show in function wizard, multi language.
* **description** = Show in function wizard, multi language.
* **parameters** = Each parameters in your function.
* **key** = Is the exactly name for parameter in your code function.
* **displayname** = Show in function wizard, multi language.
* **description** = Show in function wizard, multi language.
Example:
.. code-block:: python
FUNCTIONS = {
'test': {
'displayname': {'en': 'test', 'es': 'prueba'},
'description': {'en': 'My test', 'es': 'Mi prueba'},
'parameters': {
'value': {
'displayname': {'en': 'value', 'es': 'valor'},
'description': {'en': 'The value', 'es': 'El valor'},
},
},
},
}
Default program
^^^^^^^^^^^^^^^
Open automaticaly when install and test.
**PROGRAM**
* String
* --calc
* --writer
* --draw
* --impress
Example:
.. code-block:: python
PROGRAM = '--calc'
File test
^^^^^^^^^
Open automaticaly when install and test.
* String
Example:
.. code-block:: python
FILE_TEST = '/home/mau/example.ods'
Paths
^^^^^
Paths for install and test. `idlc`, `include` and `remerge` only used en `TYPE_EXTENSION` 2 or 3. `idlc` and path `include` is installed with LibreOffice SDK.
**PATHS**
* Dictionary
* **idlc** for generate files urd.
* **include** path with files idl.
* **remerge** for generate files rdb.
* **soffice** for open LibreOffice.
* **install** for install extension.
Example:
.. code-block:: python
PATHS = {
'idlc': '/usr/lib/libreoffice/sdk/bin/idlc',
'include': '/usr/share/idl/libreoffice',
'regmerge': '/usr/lib/libreoffice/program/regmerge',
'soffice': ('soffice', PROGRAM, FILE_TEST),
'install': ('unopkg', 'add', '-v', '-f', '-s'),
}
.. _Semantic Versioning: https://semver.org/