-
Notifications
You must be signed in to change notification settings - Fork 0
/
cheatsheet.html
559 lines (522 loc) · 18.4 KB
/
cheatsheet.html
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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-02-25 Sun 23:00 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>‎</title>
<meta name="generator" content="Org Mode" />
<style>
#content { max-width: 60em; margin: auto; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #e6e6e6;
border-radius: 3px;
background-color: #f2f2f2;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
}
pre.src:before {
display: none;
position: absolute;
top: -8px;
right: 12px;
padding: 3px;
color: #555;
background-color: #f2f2f299;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-authinfo::before { content: 'Authinfo'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { }
</style>
</head>
<body>
<div id="content" class="content">
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orgc12624a">1. GETTING STARTED</a>
<ul>
<li><a href="#org1b524b3">1.1. INSTALLATION</a>
<ul>
<li><a href="#orgd076baf">1.1.1. Windows</a></li>
</ul>
</li>
<li><a href="#orgc97f9d4">1.2. POST-INSTALLATION</a></li>
<li><a href="#org9a8ecbd">1.3. WORKFLOW DEFINITION FORMAT</a>
<ul>
<li><a href="#orgcbe7443">1.3.1. DIRECTORY STRUCTURE</a></li>
<li><a href="#orgbc3e6d4">1.3.2. FILE FORMAT</a></li>
<li><a href="#orgd361f49">1.3.3. MINIMAL EXAMPLE <code>play.js</code></a></li>
</ul>
</li>
<li><a href="#org1f8863f">1.4. CREATE NEW WORKFLOW</a></li>
<li><a href="#org9c995a8">1.5. RUN THE NEW WORKFLOW</a></li>
<li><a href="#org6a82e69">1.6. DIRECTORY <code>log</code> AFTER EXECUTION</a></li>
</ul>
</li>
<li><a href="#org19ff304">2. COMMAND REFERENCE</a>
<ul>
<li><a href="#orgc4d293c">2.1. OVERVIEW</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgc12624a" class="outline-2">
<h2 id="orgc12624a"><span class="section-number-2">1.</span> GETTING STARTED</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-org1b524b3" class="outline-3">
<h3 id="org1b524b3"><span class="section-number-3">1.1.</span> INSTALLATION</h3>
<div class="outline-text-3" id="text-1-1">
</div>
<div id="outline-container-orgd076baf" class="outline-4">
<h4 id="orgd076baf"><span class="section-number-4">1.1.1.</span> Windows</h4>
<div class="outline-text-4" id="text-1-1-1">
<p>
Install a recent <code>python3</code> (LTS releases recommended from the original website <a href="https://www.python.org/downloads/windows/">https://www.python.org/downloads/windows/</a>) and run <code>pip install dcx</code> afterwards. Note: It is possible to have your python installed in your user's realm without the need for administrator privileges.
</p>
<p>
In a commandline or terminal where you have access to <code>python</code> you can then simply start the dcx cli by running:
</p>
<pre class="example">
python -m dcx
</pre>
<p>
or perhaps with more parameters (similar to <code>--help</code>):
</p>
<pre class="example">
python -m dcx --help
</pre>
</div>
</div>
</div>
<div id="outline-container-orgc97f9d4" class="outline-3">
<h3 id="orgc97f9d4"><span class="section-number-3">1.2.</span> POST-INSTALLATION</h3>
<div class="outline-text-3" id="text-1-2">
<p>
You have (obviously) managed to install <code>dcx</code> already. Great!
</p>
<p>
I recommend putting a starter bash script somewhere in your <code>PATH</code>, so you can just run <code>dcx</code> without the python venv init.
</p>
<p>
For example, you could have a <code>dcx</code> file beneath <code>/usr/local/bin/</code> (change your venv path if necessary):
</p>
<div class="org-src-container">
<pre class="src src-bash">#!/bin/bash
. ~/venv/bin/activate
python -m dcx "$@"
</pre>
</div>
</div>
</div>
<div id="outline-container-org9a8ecbd" class="outline-3">
<h3 id="org9a8ecbd"><span class="section-number-3">1.3.</span> WORKFLOW DEFINITION FORMAT</h3>
<div class="outline-text-3" id="text-1-3">
</div>
<div id="outline-container-orgcbe7443" class="outline-4">
<h4 id="orgcbe7443"><span class="section-number-4">1.3.1.</span> DIRECTORY STRUCTURE</h4>
<div class="outline-text-4" id="text-1-3-1">
<p>
A workflow consists (in its most simple form) of exactly <b>one file</b> named <code>play.js</code> in your working directory.
</p>
</div>
</div>
<div id="outline-container-orgbc3e6d4" class="outline-4">
<h4 id="orgbc3e6d4"><span class="section-number-4">1.3.2.</span> FILE FORMAT</h4>
<div class="outline-text-4" id="text-1-3-2">
<p>
<code>play.js</code> is JSON with <b>only</b> one root element, an array <code>[]</code>.
</p>
<p>
This array stores all linear executed <code>play_steps</code>, which themselves are arrays, again. They will later be executed in-order from top to bottom.
</p>
<p>
Basic <code>play.js</code> structural (still no content):
</p>
<div class="org-src-container">
<pre class="src src-javascript">[
[],
[],
[]
]
</pre>
</div>
<p>
These <b>inner</b> arrays (the <code>play_steps</code>) ALWAYS consist of at least 2 columns.
</p>
<p>
1st column: <code>"JSON encoded XPath String" | null</code>
</p>
<p>
2nd column: <code>COMMAND</code> name, as String
</p>
<p>
3rd, 4th, … column: (Optional) positional parameters for the used <code>COMMAND</code>.
</p>
<p>
Note: All columns <b>have to be</b> JSON Strings (with the exception of the 1st, which can be JSON:null in case of a <code>COMMAND</code> that does not relate to any website-element).
</p>
</div>
</div>
<div id="outline-container-orgd361f49" class="outline-4">
<h4 id="orgd361f49"><span class="section-number-4">1.3.3.</span> MINIMAL EXAMPLE <code>play.js</code></h4>
<div class="outline-text-4" id="text-1-3-3">
<p>
This example may give you a better idea:
</p>
<p>
<code>play.js</code>:
</p>
<div class="org-src-container">
<pre class="src src-javascript">[
[null, "get", "https://127.0.0.1:8080/"],
[null, "halt"]
]
</pre>
</div>
<p>
What you see is an example play with only 2 command invocations.
</p>
<p>
The 1st command is <code>get</code>, which equals to typing the following URL into your address bar and opening it.
</p>
<p>
The 2nd command keeps the browser open and your commandline going into kind of an <b>interactive</b> mode. Without the <code>halt</code> command, your browser would immediately close and disappear after opening the URL from the previous step. To skip out the interactive prompt, just press RETURN.
</p>
</div>
</div>
</div>
<div id="outline-container-org1f8863f" class="outline-3">
<h3 id="org1f8863f"><span class="section-number-3">1.4.</span> CREATE NEW WORKFLOW</h3>
<div class="outline-text-3" id="text-1-4">
<p>
Creating a new workflow/test/play (whatever you want to call it) should always happen in a new empty directory.
</p>
<p>
To make it a little easier to start, you can run
</p>
<div class="org-src-container">
<pre class="src src-bash">mkdir EXAMPLE_WORKFLOW
cd EXAMPLE_WORKFLOW
dcx --gen
</pre>
</div>
<p>
to create a simple sample <code>play.js</code> file in your new working directory (here: <code>EXAMPLE_WORKFLOW</code>).
</p>
</div>
</div>
<div id="outline-container-org9c995a8" class="outline-3">
<h3 id="org9c995a8"><span class="section-number-3">1.5.</span> RUN THE NEW WORKFLOW</h3>
<div class="outline-text-3" id="text-1-5">
<p>
Before you start, you need to know which browser to use. Invoking just plain <code>dcx</code> will try firefox. You can override this behaviour by adding <code>--local-chrome</code> to use chrome instead.
</p>
<div class="org-src-container">
<pre class="src src-bash">cd EXAMPLE_WORKFLOW
dcx # for firefox
dcx --local-chrome # for chrome
</pre>
</div>
<p>
Note: The directory <code>log</code> will be created during runtime - and deleted automatically. IF YOU WANT TO KEEP IT FOR INSPECTION, ADD <code>--log</code>.
</p>
</div>
</div>
<div id="outline-container-org6a82e69" class="outline-3">
<h3 id="org6a82e69"><span class="section-number-3">1.6.</span> DIRECTORY <code>log</code> AFTER EXECUTION</h3>
<div class="outline-text-3" id="text-1-6">
<p>
WARNING: By-default the <code>log</code> directory will always be removed (recursive, no-prompt).
</p>
</div>
</div>
</div>
<div id="outline-container-org19ff304" class="outline-2">
<h2 id="org19ff304"><span class="section-number-2">2.</span> COMMAND REFERENCE</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-orgc4d293c" class="outline-3">
<h3 id="orgc4d293c"><span class="section-number-3">2.1.</span> OVERVIEW</h3>
<div class="outline-text-3" id="text-2-1">
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="org-left" />
<col class="org-left" />
<col class="org-left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="org-left">Command</th>
<th scope="col" class="org-left">Description</th>
<th scope="col" class="org-left">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td class="org-left"><code>attribute_setenv</code></td>
<td class="org-left">Add specified element's attribute to ENV</td>
<td class="org-left"><code>["id:button9", "attribute_setenv", "class", "BUTTON9_CSS_CLASSES"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>bash</code></td>
<td class="org-left">Execute a bash command without single tics</td>
<td class="org-left"><code>[null, "bash", "uptime > aha"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>bash0</code></td>
<td class="org-left">Execute a bash command without single tics and return 0</td>
<td class="org-left"><code>[null, "bash", "echo ok; exit 1"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>clear</code></td>
<td class="org-left">Empty <code><INPUT></code> or <code><TEXTAREA></code></td>
<td class="org-left"><code>["id:firstname", "clear"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>click</code></td>
<td class="org-left">Click on element CENTER</td>
<td class="org-left"><code>["id:btn-submit", "click"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>get</code></td>
<td class="org-left">Open a URL</td>
<td class="org-left"><code>[null, "get", "https://www.google.de"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>halt</code></td>
<td class="org-left">Enter breakpoint</td>
<td class="org-left"><code>[null, "halt"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>path</code></td>
<td class="org-left">Open a PATH/URL von the same server/host</td>
<td class="org-left"><code>[null, "path", "/info.html"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>sam</code></td>
<td class="org-left">Use <code>say -v Samantha <...></code> to speak on macos</td>
<td class="org-left"><code>[null, "sam", "all system nominal"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>setenv</code></td>
<td class="org-left">Add or change ENV parameters during runtime</td>
<td class="org-left"><code>[null, "setenv", "PARAM_X", "1234"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>setvalue</code></td>
<td class="org-left">Set form values via javascript and not sending keys</td>
<td class="org-left"><code>["id:inputfield8", "setvalue", "John Doe"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>sleep</code></td>
<td class="org-left">Freeze Execution for Specified Seconds</td>
<td class="org-left"><code>[null, "sleep", "8"]</code></td>
</tr>
</tbody>
<tbody>
<tr>
<td class="org-left"><code>type</code></td>
<td class="org-left">Send keys to element</td>
<td class="org-left"><code>["id:funkyfield", "type", "Hello"]</code></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2024-02-25 Sun 23:00</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>