summaryrefslogtreecommitdiffstats
path: root/tde-i18n-es/docs/tdewebdev/kommander/specials.docbook
blob: 7c1db3f9caf77a07d88aa96c5c277bf94ebb8308 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
<?xml version="1.0"  encoding="UTF-8" ?>

<sect1 id="specials">
<sect1info>
<title
>Especiales y variables globales internas</title>
<authorgroup>
<author
><firstname
></firstname
> <surname
></surname
> <affiliation
><address
> <email
></email>
</address
></affiliation>
</author>

<othercredit role="translator"
><firstname
>Juan Manuel</firstname
> <surname
>García Molina</surname
> <affiliation
><address
><email
>juanma@superiodico.net</email
></address
></affiliation
><contrib
>Traductor</contrib
></othercredit
> 

</authorgroup>
</sect1info>

<title
>Especiales y variables globales internas</title>

<para
>Los especiales son funciones que &kommander; procesa. Debería tener en cuenta que hasta que &kommander; tenga un analizador completo, todas las especiales de &kommander; se ejecutarán primero, y luego se ejecutará el guión. En la mayoría de los casos, no suele ser un problema, pero en algunos sí que lo es. </para>

<variablelist>
<varlistentry>
<term
><function
>@dcop(<parameter
>appId</parameter
>, <parameter
>objeto</parameter
>, <parameter
>funcion</parameter
>, <parameter
>argumentos</parameter
>)</function
></term>
<listitem>
<para
>Hace una llamada &DCOP;. @dcop(<quote
>kmail</quote
>, <quote
>KMailIface</quote
>, <quote
>checkMail()</quote
>, <quote
></quote
>) </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@dcopid</function
></term>
<listitem>
<para
>El id. &DCOP; del proceso. (kmdr-executor-@pid) </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@dialog(<parameter
>dialog</parameter
>[,<parameter
>parameters</parameter
>])</function
></term>
<listitem>
<para
>Lanza el cuadro de diálogo de Kommander especificado. El cuadro de diálogo se obtiene del directorio dialog y del actual, en ese orden. Esto se hace con antelación a la llamada al ejecutor y define el directorio predefinido en el que está la aplicación de Kommader. Los parámetros (parameters) se pueden pasar al estilo de Unix o por nombre, como <quote
>variable=valor</quote
>. Luego puede buscar los parámetros globales pasados.  @global(variable) devolvería <quote
>valor</quote
>. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@env(<parameter
>environmentVariable</parameter
>)</function
></term>
<listitem>
<para
>Expande la environmentVariable (variable de entorno) pasada. @env(PWD) se expande como $PWD. Recuerde que <quote
>$</quote
> es parte de la shell y no se debe usar. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@exec(<parameter
>command</parameter
>)</function
></term>
<listitem>
<para
>devuelve la salida de la ejecución del command (comando) especificado. @exec(ls -l). </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@execBegin ... @execEnd</function
></term>
<listitem>
<para
>igual que <function
>@exec</function
>, pero admite shebang (n.t. la marca de comienzo de un guión en Unix) y guiones de varias líneas. Sirve para varios lenguajes de guiones, así como para declararlos o usar una shebang. </para>
<itemizedlist>
<listitem
><para
><function
>@execBegin(php)</function
></para
></listitem>
<listitem
><para
><function
>@execBegin</function
>#!/usr/bin/php</para
></listitem>
</itemizedlist>
<para
>El primero usa el nombre del ejecutable <acronym
>PHP</acronym
>. &kommander; busca PATH (n.t. la ruta) para <application
>php</application
> y, si no lo encontrara, buscaría si está registrado con &kommander; en una ubicación externa a su ruta. Si no fuera así, le diría al usuario que no se puede encontrar. El segundo ejemplo usa el <quote
>shebang</quote
> (n.t. la marca de comienzo de un guión en Unix) clásico, que tiene algunas ventajas y también algunos inconvenientes. Si tiene una copia de la beta de <acronym
>PHP5</acronym
>, por ejemplo, en <filename
>/usr/local/bin</filename
>, podría no encontrarse por no estar en <filename
>/usr/bin</filename
>, y para ello sería muy útil. Sin embargo, si distribuye el cuadro de diálogo a alguien que tenga <acronym
>PHP</acronym
> en <filename
>/opt/bin</filename
>, no lo encontrará cuando use shebang. Por tanto, use con cuidado las shebangs y, si va a compartir archivos, se recomienda que use el ejecutable.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@global(<parameter
>variable</parameter
>)</function
></term>
<listitem>
<para
>expande el valor de la variable global especificada. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@null</function
></term>
<listitem>
<para
>Devuelve null (nulo). Ahora que Kommander comprueba si widgetText extá vacío en la ejecución, esto evitará que haya errores erróneos en el caso de que haya un estado no definido en el widget.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@parentPid</function
></term>
<listitem>
<para
>El &PID; del proceso padre. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@pid</function
></term>
<listitem>
<para
>El &PID; del proceso. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@readSetting(<parameter
>key</parameter
>, <parameter
>defaultValue</parameter
>)</function
></term>
<listitem>
<para
>lee un valor de <filename
>kommanderrc</filename
> </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@selectedWidgetText</function
></term>
<listitem>
<para
>el contenido seleccionado de un widget que puede mostrar más de un valor, como los widgets de lista </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@setGlobal(<parameter
>variable</parameter
>, <parameter
>value</parameter
>)</function
></term>
<listitem>
<para
>Define la variable global como el value (valor) especificado. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@widgetText</function
></term>
<listitem>
<para
>el contenido de un widget </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@writeSetting(<parameter
>key</parameter
>, <parameter
>value</parameter
>)</function
></term>
<listitem>
<para
>escribe un valor en <filename
>kommanderrc</filename
> </para>
</listitem>
</varlistentry>
</variablelist>

<sect2 id="arrays">
<title
>Grupo de funciones de vectores</title>

<variablelist>
<varlistentry>
<term
><function
>@Array.values(<parameter
>array</parameter
>)</function
></term>
<listitem>
<para
>Devuelve la lista separada por EOL de todos los valores del array (vector). Se puede usar para pasear a través de los elementos de un vector.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.keys(<parameter
>array</parameter
>)</function
></term>
<listitem>
<para
>Devuelve una lista separada por EOL con todas las claves del array (vector).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.setValue(<parameter
>array</parameter
>, <parameter
>key</parameter
>, <parameter
>value</parameter
>)</function
></term>
<listitem>
<para
>Define una key (clave) y un value (valor) para un elemento del array (vector). Si no existe el vector, se crea.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.clear(<parameter
>array</parameter
>)</function
></term>
<listitem>
<para
>Elimina todos los elementos del array (vector).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.count(<parameter
>array</parameter
>)</function
></term>
<listitem>
<para
>Devuelve el número de elementos que hay en el array (vector).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.value(<parameter
>array</parameter
>,<parameter
>key</parameter
>)</function
></term>
<listitem>
<para
>Devuelve el valor asociado a la key (clave) dada.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.remove(<parameter
>array</parameter
>,<parameter
>key</parameter
>)</function
></term>
<listitem>
<para
>Elimina el elemento que hay en la key (clave) dada del array (vector).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.fromString(<parameter
>array</parameter
>,<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Añade al array (vector) todos los elementos de la string (cadena de caracteres). La cadena de caracteres debería tener el formato <emphasis
>clave\tvalor\n</emphasis
>."</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@Array.toString(<parameter
>array</parameter
>,<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>"Devuelve todos los elementos del array (vector) en el formato <emphasis
>clave\tvalor\n</emphasis
>."</para>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="files">
<title
>Grupo de funciones de archivo</title>
<variablelist>

<varlistentry>
<term
><function
>@File.read(<parameter
>file</parameter
>)</function
></term>
<listitem>
<para
>Devuelve el contendo del file (archivo) dado.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@File.write(<parameter
>file</parameter
><parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Escribe la string (cadena de caracteres) dada en file (archivo).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@File.append(<parameter
>file</parameter
><parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Añade la string (cadena de caracteres) dada al final del file (archivo).</para>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="strings">
<title
>Grupo de funciones de cadenas de caracteres</title>
<variablelist>

<varlistentry>
<term
><function
>@String.length(<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Devuelve el número de caracteres que hay en la cadena de caracteres (string).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.contains(<parameter
>string</parameter
>,<parameter
>substring</parameter
>)</function
></term>
<listitem>
<para
>Comprueba si la cadena de caracteres (string) contiene la subcadena (substring) dada.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.find(<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Devuelve la posición de una subcadena de caracteres (substring) en la cadena (string), o -1 si no se encuentra."</para>
<note
><para
>Tiene una posición opcional de comienzo, entera (integer) para encontrar los usos en alfa 6.</para
></note>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.left(<parameter
>string</parameter
>, <parameter
>int</parameter
>)</function
></term>
<listitem>
<para
>Devuelve los n primeros caracteres de la cadena (string).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.right(<parameter
>string</parameter
>, <parameter
>int</parameter
>)</function
></term>
<listitem>
<para
>Devuelve los n últimos caracteres de la cadena (string).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.mid(<parameter
>string</parameter
>, <parameter
>int start</parameter
>, <parameter
>int end</parameter
>)</function
></term>
<listitem>
<para
>Devuelve la subcadena de caracteres (substring) de la cadena (string), comenzando en las posiciones indicadas.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.remove(<parameter
>string</parameter
>, <parameter
>substring</parameter
>)</function
></term>
<listitem>
<para
>Elimina todas las ocurrencias de una subcadena de caracteres (substring) dada.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.replace(<parameter
>string</parameter
>, <parameter
>substring find</parameter
>, <parameter
>substring replace</parameter
>)</function
></term>
<listitem>
<para
>Reemplaza todas las ocurrencias de una subcadena de caracteres (substring) dada con un reemplazo (replace) dado.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.upper(<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Convierte la cadena de caracteres (string) a mayúsculas.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.lower(<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Convierte la cadena de caracteres (string) a minúsculas.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.compare(<parameter
>string</parameter
>, <parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Compara dos cadenas de caracteres (string). Devuelve 0 si son iguales. -1 si la primera es menor, 1 si la primera es mayor.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.isEmpty(<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Comprueba si la cadena de caracteres (string) está vacía.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><function
>@String.isNumber(<parameter
>string</parameter
>)</function
></term>
<listitem>
<para
>Comprueba si la cadena de caracteres (string) es un número válido.</para>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="builtins">
<title
>Globales internos</title>
<para
>A los globales internos se accede como a las variables globales habituales, con <function
>@global</function
>.</para>
<variablelist>
<varlistentry>
<term
><function
>@global(_KDDIR)</function
></term>
<listitem>
<para
>El directorio en el que está el cuadro de diálogo actual.</para>
</listitem>
</varlistentry>
<varlistentry>
<term
><function
>@global(_NAME)</function
></term>
<listitem
><para
>El nombre del cuadro de diálogo.</para
></listitem>
</varlistentry>
</variablelist>
</sect2>

</sect1>