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 21:41:51 -06:00
parent 2231df7427
commit f0f1ccf19f
6 changed files with 194 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.

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

@ -205,5 +205,70 @@ Example:
LICENSE_ES = LICENSE_EN
Information
^^^^^^^^^^^
Information of extension: Display name, description and license to displayed when install.
**INFO**
* Dictionary
Example:
.. code-block:: python
INFO = {
'en': {
'display_name': 'Test Macro',
'description': 'My great extension',
'license': LICENSE_EN,
},
'es': {
'display_name': 'Macro de Prueba',
'description': 'Mi gran extensión',
'license': LICENSE_ES,
},
}
Parent menu
^^^^^^^^^^^
Only for normal extension (`TYPE_EXTENSION = 1`), where add extension menu, only two possible values: **AddonMenu** or **OfficeMenuBar**
**PARENT**
* String
* **AddonMenu**: Show in menu Tools->Add-Ons
* **OfficeMenuBar**: Show in LibreOffice menu
Example:
.. code-block:: python
PARENT = 'OfficeMenuBar'
Main menu
^^^^^^^^^
Only for normal extension (`TYPE_EXTENSION = 1`) and only if parent menu is `OfficeMenuBar`. Can be multi language.
**MENU_MAIN**
* Dictionary
Example:
.. code-block:: python
MENU_MAIN = {
'en': 'My Extension',
'es': 'Mi Extensión',
}
.. _Semantic Versioning: https://semver.org/

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

@ -225,6 +225,69 @@
</pre></div>
</div>
</div>
<div class="section" id="information">
<h3>Information<a class="headerlink" href="#information" title="Permalink to this headline"></a></h3>
<p>Information of extension: Display name, description and license to displayed when install.</p>
<p><strong>INFO</strong></p>
<blockquote>
<div><ul class="simple">
<li><p>Dictionary</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">INFO</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;display_name&#39;</span><span class="p">:</span> <span class="s1">&#39;Test Macro&#39;</span><span class="p">,</span>
<span class="s1">&#39;description&#39;</span><span class="p">:</span> <span class="s1">&#39;My great extension&#39;</span><span class="p">,</span>
<span class="s1">&#39;license&#39;</span><span class="p">:</span> <span class="n">LICENSE_EN</span><span class="p">,</span>
<span class="p">},</span>
<span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;display_name&#39;</span><span class="p">:</span> <span class="s1">&#39;Macro de Prueba&#39;</span><span class="p">,</span>
<span class="s1">&#39;description&#39;</span><span class="p">:</span> <span class="s1">&#39;Mi gran extensión&#39;</span><span class="p">,</span>
<span class="s1">&#39;license&#39;</span><span class="p">:</span> <span class="n">LICENSE_ES</span><span class="p">,</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="parent-menu">
<h3>Parent menu<a class="headerlink" href="#parent-menu" title="Permalink to this headline"></a></h3>
<p>Only for normal extension (<cite>TYPE_EXTENSION = 1</cite>), where add extension menu, only two possible values: <strong>AddonMenu</strong> or <strong>OfficeMenuBar</strong></p>
<p><strong>PARENT</strong></p>
<blockquote>
<div><ul class="simple">
<li><dl class="simple">
<dt>String</dt><dd><ul>
<li><p><strong>AddonMenu</strong>: Show in menu Tools-&gt;Add-Ons</p></li>
<li><p><strong>OfficeMenuBar</strong>: Show in LibreOffice menu</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">PARENT</span> <span class="o">=</span> <span class="s1">&#39;OfficeMenuBar&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="main-menu">
<h3>Main menu<a class="headerlink" href="#main-menu" title="Permalink to this headline"></a></h3>
<p>Only for normal extension (<cite>TYPE_EXTENSION = 1</cite>) and only if parent menu is <cite>OfficeMenuBar</cite>. Can be multi language.</p>
<p><strong>MENU_MAIN</strong></p>
<blockquote>
<div><ul class="simple">
<li><p>Dictionary</p></li>
</ul>
</div></blockquote>
<p>Example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">MENU_MAIN</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;My Extension&#39;</span><span class="p">,</span>
<span class="s1">&#39;es&#39;</span><span class="p">:</span> <span class="s1">&#39;Mi Extensión&#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,"final":2,"function":2,"new":[1,2],"public":1,"true":1,FOR:1,The:1,With:2,absolut:1,add:2,addin:[1,2],along:1,ani:1,base:1,basic:2,befor: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,copi:[1,2],correctli:1,cours:2,creat:[1,2],cuat:2,current:1,detail:1,develop:[1,2],dictionari:1,directori:2,displai:1,distribut:1,domain:2,don:2,done:2,download:2,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,foundat:1,free:1,from:2,gener:[1,2],git:2,gitlab:[],gnu:1,have:1,hope:1,http:[1,2],i18n:1,imag:1,impli:1,index:0,info:2,inform:1,instal:0,integ:1,intern:1,introduct:0,invers:1,languag:1,later:1,lib:1,libreoffic:2,libreofric:[],license_:1,license_en:1,like:1,link:1,local:2,logo:1,look:1,macro:2,make:2,manag:1,mauriciobaeza:[],merchant:1,modifi:1,modul:0,more:1,move:[1,2],multi:1,myfirstextens:2,myfirstextension_v0:2,mygreatextens:1,net:[1,2],nombr:1,normal:1,now:2,one:1,onli:1,option:1,org:1,overview:0,oxt:2,page:[0,1],paramet:0,part:1,particular:1,path_pygettext:1,pleas:1,png:1,pot:[1,2],project:[1,2],publish:1,purpos:1,python3:1,python:2,rapid:2,receiv:1,recomend:2,recommend:1,redistribut:1,rel:1,repositori:2,requir:0,script:2,sdk:2,search:0,see:1,semant:1,should:1,show:1,softwar:1,sourc:2,space:1,start:[1,2],string:1,successfulli:2,sucesfulli:2,support:2,term:1,test:2,testext:[],text:1,thi:[1,2],tool:1,type_extens:1,under:1,uniqu:1,unopkg:2,url:1,use_local:1,used:[1,2],useful:1,user:2,usr:1,vim:1,want:1,warranti:1,without: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,instal:2,introduct:2,licens:1,local:1,name:1,overview:2,paramet: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],"public":1,"true":1,FOR:1,Ons:1,The:1,With:2,absolut:1,add:[1,2],addin:[1,2],addonmenu:1,along:1,ani:1,base:1,basic:2,befor: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,copi:[1,2],correctli:1,cours:2,creat:[1,2],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,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,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,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,net:[1,2],nombr:1,normal:1,now:2,officemenubar:1,one:1,onli:1,option:1,org:1,overview:0,oxt:2,page:[0,1],paramet:0,part:1,particular:1,path_pygettext:1,pleas:1,png:1,possibl:1,pot:[1,2],project:[1,2],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,script:2,sdk:2,search:0,see:1,semant:1,should:1,show:1,softwar:1,sourc:2,space:1,start:[1,2],string:1,successfulli:2,sucesfulli:2,support:2,term:1,test:[1,2],testext:[],text:1,thi:[1,2],tool:1,two:1,type_extens:1,under:1,uniqu:1,unopkg:2,url:1,use_local:1,used:[1,2],useful:1,user:2,usr:1,valu:1,vim:1,want:1,warranti:1,when:1,where:1,without: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}})

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

@ -205,5 +205,70 @@ Example:
LICENSE_ES = LICENSE_EN
Information
^^^^^^^^^^^
Information of extension: Display name, description and license to displayed when install.
**INFO**
* Dictionary
Example:
.. code-block:: python
INFO = {
'en': {
'display_name': 'Test Macro',
'description': 'My great extension',
'license': LICENSE_EN,
},
'es': {
'display_name': 'Macro de Prueba',
'description': 'Mi gran extensión',
'license': LICENSE_ES,
},
}
Parent menu
^^^^^^^^^^^
Only for normal extension (`TYPE_EXTENSION = 1`), where add extension menu, only two possible values: **AddonMenu** or **OfficeMenuBar**
**PARENT**
* String
* **AddonMenu**: Show in menu Tools->Add-Ons
* **OfficeMenuBar**: Show in LibreOffice menu
Example:
.. code-block:: python
PARENT = 'OfficeMenuBar'
Main menu
^^^^^^^^^
Only for normal extension (`TYPE_EXTENSION = 1`) and only if parent menu is `OfficeMenuBar`. Can be multi language.
**MENU_MAIN**
* Dictionary
Example:
.. code-block:: python
MENU_MAIN = {
'en': 'My Extension',
'es': 'Mi Extensión',
}
.. _Semantic Versioning: https://semver.org/