From ea1c7f2a01c4bbad0291bd6ca6f1e11792a4ffc7 Mon Sep 17 00:00:00 2001 From: Mauricio Baeza Date: Sat, 6 Feb 2021 22:05:20 -0600 Subject: [PATCH] Add parameter --- doc/build/doctrees/environment.pickle | Bin 19880 -> 21410 bytes doc/build/doctrees/main/config.doctree | Bin 34968 -> 51098 bytes doc/build/html/_sources/main/config.rst.txt | 95 ++++++++++++++++ doc/build/html/main/config.html | 113 ++++++++++++++++++++ doc/build/html/searchindex.js | 2 +- doc/source/main/config.rst | 95 ++++++++++++++++ 6 files changed, 304 insertions(+), 1 deletion(-) diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle index 4ed5c8579cb0b67c30a0f9e383ec3ec768fce741..6127e47dc1bd8d342badf4aa3fe794ba3f93c3c6 100644 GIT binary patch delta 1116 zcmZuwOHUI~810m_qa_L|AxcCG1q9^Lg4P<12F0PYl!wHH3rL1COncK#n?8KR6cy!_ zOhU}P#u$x87pRE~VXAJ3Rd=-;P3sO>3r7+uO^z!}cetjCELpOQ<3BO*jWTTXQRgv- zFb*p}s(LGWl_@zJ%Q%y%gqo7$TeVHy0?~ruz-x9;>6$Dswi}ElAG1XtGlma1eKe*x zGfFzM)j>(Up#9R&{{QKLrJb{wR9_TTmkrf=+pwI8{PVpxYX!B>hFY8Xq;^-5?=~r| z6_q~ZJ<@A|KdxX^{#V}*p|MVc>j>eU)WeFhmcmuz1r3rWC=HTBBK_0fUDv{sRvtIX zuyGjHi=++W7$Y4bJsXhrpsz8O&FWT?=8wiL(uV<;72s{4!H4a|Eb#*bEijb4x;bRA z*Q~*Y|ECrt*A0BM34K_L5ysg_~@`MuO?D{rU(fDu0h$_->u+16~>7Af=R}5xJ z9D{}-A=33=<8A`$W>VUt6$91b(gF-$hN*cr$0p{PZci(6DjZ=X2gQh=m>J;Bmyhxx z=di3QECYYb771XS7U{ykh(|>$7$W{TMzWY)GBV`f6oKAt%w|RE2!*UmBE1+I`U?c4 BR@49h delta 623 zcmZ3qoN>i$M%D(_sdIf7vPy}tX6B`&R!r&P&P~kB(@)ONOUq2(EGZ?x%)h-YNc1ETg@_Jb&YYp~#Hn`SW24y^L5eI1DB&>FlQE+e8mismX8 zX%ACYG1#O9Y?G%2C^G@6-2o~<*E|Ri<6HpLQadH<5ZmPc0b(F2@jx{YWgjTRbe(N- zY@iO)4YtYMfo3vyfGV@@f{1${;y#dQpVBrZseMWh$K(k?lJ!})fI=EssOoxneDhOE zb5a#N!Ld~`rEvZm+3#-+@udDZsKGqptjJKmZpHH(?^16*&=dd-^ADTOTKoq zv`cTZ@feb&Zo2`&7-dWhX%l}Ko3^o5gMmOpXpBuvn|Q3M#3oe?4Q)d(ZPUK*JNKS* z?bwN%7WQLE-1wezzW4Kdw-0~a@y#T^r}fCFw$N(FxDNEZZ_UXtTi4VYpyeQ&W&`e zW;=^Nm|8h%QG%8l%ThUdb;xjS#D2|e z^DDH?mio}OLe$2lKw#e;LpP7yc3^1OxX|I-^e&#Y>}>56Y4!rsZ2vB&<88NbC>n5H zZ=#$HU*|dUz3Qr}y|KwPGnwno>{5nMjY6$i=g& z6ql2eIeAhEHb_!H3IrmG7S5iL1VgeEjWh_28W%b@=|>(bFj0Y@tBTe@I$x^E z7B`p<@mtQ|2+ehRIp(?yW9dp}A!}KtzhYCB)5L~KT;KRG?sKoT#ZhBob-{Ze(dw#e zq^!HFky2ec;dbuCNUUl!W_*6*+|kC(+aY=?w50L7gydKYs8YV`JVjtu(sJ976=j8M z7!!~cHnssWkih#8eJ-pw_Qu=Vgaemum5uiYFLsIO6edV=|yp~fd7|NLAjJsNycaZk2U@gU#<^a zz7ELQyJ9uqM?8+23(;8d&>+%tQ8;K61F~^n`#J;CKqO_w#0F5qqD5CA%U5wO^fdg)Ws>m{aF>i7OcdUc$~rFP@O39pmX z{T$dt-H%4bkeUR;Sa6*dnCW2;afVBQ^sZgjPcH)HM(^q zG%X>tI2BSQ>tK)Bn@9l5?~I6^uj7Tme_W2|h-$$yZP|Ke8(RRd4j?#V@Se)}X9PLp zkB3&pEe>%c!ANj`!8ooI!XP~x3iBuYnKAwL|4DgwT|MRTVG0HKY!kU|v$SPfXb-_8UEWl?fTfAK-YY zNtjnyiDuq9=OuQQ1nQQ*^ztM8kkdj~4$ktUq1HMj$TgNF~?a(H(LhfN!v!;@^- z!ty_n)88tZx5f_kpdqJMC`Ex3x!nDVHiDcv{ z^QW3fXB17t?yA4v1m>Xl!vw^i1cpB>An0cd$=Bh!$mF}gSi?*ADDw1nlXdCdS;v@R z7UZQV_K{88i>D3bSBT4YTVo$HG4Dc@e{aG}Is75O!F5{H%X*8^VhT;oT%j(Yz@)L! zp#9dEr7>wq-)1-@Qqcaqsad2unbiR{1>az45N6mnN_8`@dRvn`&)LcFdZ1`k)N60Z*gC0 zi|dRM$^*?-LfIFR8B!L<1qsCyVHu*=$`B&0SX)-|Fw)Yxn$R$178v2HafJfg;>fnb z8Hqi`gnJT&W7*^hToKu1@_&&{e#p4`fvIv8wetk1D}252_^xfP*Vy)}%m^n*J?W#Q}XQTY{jQPfi z#(W+Mla(HBS1+yzyXFe*dX~`9x0!i`K^jvd@$gs={7r`Axrj1GMPn?ZB$Uh~yruB7 z4t?~1x-vF$^x)v#gGWXNhlb$`!KR+KD5Sp^=lUcf^I z3BD>x9iT;;ayoh>aVn2*9OY&gSCoa-X=+Y@5aJyi@g|PAmJ}oo=FJ5=dQ0;hy}2Nu z2>n5hek(`cTxcx;kuToi1Xp;AZ8~TCt6`%f%+UuqdY5VLpj|t*MUJ!*y&vZU`Z<9H z;XgLs?W>$b<#u?06B_4)*5jwY#k`UST)v{?j5Yl9IE6{T>%j)8-USWP?vY#RTU_Up z7^bW}s-;ySCE4^T#ws>P-|sy=Yop6o0_mlWg_En?socorllxu&4VdyKW*V`p)*x$p0bh- z|JWO(Y1s2Nd2p(=h%|JB<*0J9;E}~8!BZf{Zp=SrM@-*7*WslWBZdp`37VW%cie2y+9om}pWMC^3luBRkahKVD(Mn&d%Xx%ww|x0C z!1zUQKKLl}B^2Ua54Mwg-(tu`%Zd^$XpLft>b&?Nsuyky9L^G~Oa^rW1iLHjtM{6z z*;mqwZGx3K0Fu;uNvau?YMB?Mx@DeJ>nm`eV!?X2VBGh(V5M{S=eS_|gO*?=4T6zp zldb$25GlySJB8u}NW8&$;&qVcFXZ^e!X4(q@yO@GnJa=pN@90%;cgwVgli#>oR=*G zWWL-95N3o4rlVj7NicPuU|_e!a?ZS4N$27)bH-S%MPTNVo3sS~B>5>WdCLh)@>TY> z%Sd(juE`fHiGKkDZBT3M1e2B0$8nO?@fHRnyTDLD{+>lVUVR|J@T(7jyoh_DrxV>D3hp?>+7z#*)?;$=6VFXI8ISul^&kJQ0Dj_Q+`#bI*BX+OXTfciG^Xk?k@y@@Svqd?b&gYV;^sz}C*vXLy{^>oAPrY}7UNk=d@iE(H zrxU%DQa(eS43ttzp-y;fM1KD!`hB|r)3f@}J*FQmJN4b>_t3@Gh0d5uKR)I6VGClP zp4H-lH92#Ha?h^RpL00+mOuOY?D?AIuH{u#u{wNI2JaTy#&XTj!X+^_-=N3Z>Lx9~Fy6^B7 zL_9=DhX~;iAsZq@Lxkk3xu}F-$Wyct8T#3M_irO!F1dgP@q+(Oj`4!SJH`uMycsWe RRU=+vfA&5*eE(qee*uM#lNqZz`g2|CF(3TZ`iw? ziRmu)=F9_onFY54)nsh}5$i$38t%#FM_P53gV;+z#5@o&8%UJ)aONfErj}F|q!v%9 zouZKi(&-1(HCf +
+

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:

+
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:

+
PROGRAM = '--calc'
+
+
+
+
+

File test

+

Open automaticaly when install and test.

+
+
    +

  • String

    • +
+
+

Example:

+
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:

+
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'),
+}
+
+
+
diff --git a/doc/build/html/searchindex.js b/doc/build/html/searchindex.js index 958b56b..a93ea06 100644 --- a/doc/build/html/searchindex.js +++ b/doc/build/html/searchindex.js @@ -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}}) \ No newline at end of file +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}}) \ No newline at end of file diff --git a/doc/source/main/config.rst b/doc/source/main/config.rst index 24ffdd6..223f146 100644 --- a/doc/source/main/config.rst +++ b/doc/source/main/config.rst @@ -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/