You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -46,6 +50,8 @@ Some quick links to the various documentation files
46
50
47
51
## General Remarks
48
52
53
+
54
+
49
55
### Caster Version Supported
50
56
51
57
Currently Caster 0.5, 0.6, 1.0 are all supported but it is my recommendation that you update to the latest master or anything >=1.0, as 1.0.0 introduced various improvements and sooner or later support for the two older versions of Caster or will be dropped.
@@ -405,35 +411,32 @@ Forces RPC no matter what. Might be useful when host is windows and guest is
405
411
406
412
407
413
408
-
## Quick Command Overview
414
+
## Quick Functionality Overview
409
415
410
-
Here we will briefly go over the commands offered.
416
+
Here we will really really briefly go over the functionality offered. you can find more extensive documentation in the outgoing links.
411
417
412
-
Before we get started, a small general remark:
413
-
```
414
-
tip: if you do not know what to say, say smart :P
415
-
```
418
+
### A Bit Of Advice
416
419
417
-
because virtually every command starts with the keyword smart!
420
+
It is my recommendation,
418
421
419
-
```python
420
-
"smart <big_roi> [<big_roi_sub_index>]"
422
+
Also keep in mind that whenever you find anything ending in `index` that is an integer!
423
+
424
+
### A Small Remark
421
425
422
-
"smart <color> [alternative]"
423
-
```
424
426
425
-
This was chosen in order to minimize chances of collision with other commands on your system. However, because for a variety of commands, omitting the keyword smart makes them more convenient and easier to speak
426
-
you may find the smart keyword in brackets
427
+
Before we get started, a small general remark , virtually every command starts with the keyword smart!
427
428
428
429
```python
429
-
"[smart] alternative <alternative_index>"
430
+
"smart <big_roi> [<big_roi_sub_index>]"
430
431
431
-
"[smart] paste back [<paste_back_index>]"
432
+
"smart <color>"
432
433
433
-
"[smart] paste <color> back"
434
+
"[smart] alternative <alternative_index>"
434
435
```
435
436
436
-
if there are conflicts with other commands, try to remove those brackets (making smart not optional). Furthermore, I think it is best not to put brackets in cases where I haven't.
437
+
This was chosen in order to minimize chances of collision with other commands on your system. However, because for most commands, omitting the keyword smart makes them more convenient and easier to speak you may find the smart keyword is optional in some commands.
438
+
439
+
if there are conflicts with other commands, make it not optional/edit to suit!
437
440
438
441
After the small remark let's get started!
439
442
@@ -523,55 +526,30 @@ I do not expect these examples to make this distinction clear, just keep this in
523
526
Details vary but that is the. spirit! Ok , what else?
524
527
525
528
526
-
### Alternatives
529
+
### Operations
527
530
528
-
As you can see, these commands select some ROI (region of interest) and generate alternatives. These alternatives are shown to the user in an output panel on the bottom of the screen and the top ones get highlighted in the code as well.
531
+
As you can see, these commands select some ROI (region of interest) and generate alternatives. what can we do with those alternatives?
529
532
530
-
We can select one of those alternativeswith the alternative rule which comes in two variations:
533
+
the plug-in ships with a variety of commands that you can run after a selection query that enable you to perform various operations with the main results /one of the alternatives, in certain cases multiple of them or even work with the point origin of the selection query as well!For example
531
534
532
-
```python
533
-
"[smart] alternative <alternative_index>"
534
-
535
-
"smart <color> [alternative]"
536
-
```
537
-

535
+
we can select them
538
536
539
-
alternative_index is an integer
540
-
```python
541
-
(Tip : index --> integer)
542
-
```
543
-
whereas color is an adjective corresponding the color highlighting:
But why would we want to select some text in the first place? Other than editing it, maybe to copy it and paste it somewhere? Very likely where we are currently working? Well, the paste back command allows just that!
543
+
or we can swap them
555
544
556
-

545
+

557
546
558
-
As you can see it comes in two formats:
559
-
```python
560
-
"[smart] paste back [<paste_back_index>]"
547
+
Or we can paste them
561
548
562
-
"[smart] paste <color> back"
563
-
```
564
-
565
-
If no alternative is specified the main result is pasted back!
566
-
567
-
Please also pay attention to the following:
568
-
569
-

570
-
571
-
That is you can use successive selection queries and paste back will insert in your original starting position!
549
+

572
550
551
+
Furthermore by using the prefix `operation` that appears at the start of selection queries
573
552
574
-
So we can select some basic stuff and we can insert it where we are writing. What elae can we do?
575
553
576
554
### Collection Queries
577
555
@@ -585,41 +563,7 @@ Collection Queries try to address this issue. These collect the text of interest
585
563
586
564

587
565
588
-
you can collect a variety of things:
589
-
590
-
```python
591
-
Choice("collectable",{
592
-
"(variable|variables)":"variable",
593
-
"( parameter | parameters)":"parameter",
594
-
"(module|modules)":"module",
595
-
"imported (value|object)":"import value",
596
-
"function ( name |names)":"function name",
597
-
}
598
-
```
599
-
please note that these items are collected from the whole source code.
600
-
601
-
### Insert Item
602
-
603
-
These "items" can then be inserted in the current cursor position by means of the
604
-
605
-
```python
606
-
"(smart insert|insert item) <item_index>"
607
-
```
608
-
command. Item_index specifies which item from the collection you want
609
-
610
-

611
-
612
-
### index collectible
613
-
614
-
certain collectible items such as variables and parameters can be index collected by means of a query like
615
-
616
-
```python
617
-
"[smart] variable <collect_index>"
618
-
```
619
-
In such a case, items will only be collected from the current function andin item will be inserted
620
-
based on the index specified and their order of appearance
0 commit comments