summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--readme.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/readme.md b/readme.md
index 27666af..f4b7a77 100644
--- a/readme.md
+++ b/readme.md
@@ -19,26 +19,26 @@ and add the following code to your program code.
Giving a list of the rows list to the function `ctbl:popup-table-buffer-easy', a simple table buffer is popped out.
```lisp
-(ctbl:popup-table-buffer-easy
+(ctbl:popup-table-buffer-easy
'((1 2 3 4) (5 6 7 8) (9 10 11 12)))
```
Here is the result image. The header titles are generated automatically.
-![sample-1-1](img/sample-1-1.png)
+![sample-1-1](/usr/share/doc/elpa-ctable/sample-1-1.png)
Giving two lists, the latter list is displayed at header titles.
```lisp
-(ctbl:popup-table-buffer-easy
+(ctbl:popup-table-buffer-easy
'((1 2 3 4) (5 6 7 8) (9 10 11 12))
'(aaa bbb ccc ddd))
```
Here is the result image.
-![sample-1-2](img/sample-1-2.png)
+![sample-1-2](/usr/share/doc/elpa-ctable/sample-1-2.png)
## Basic Use
@@ -50,7 +50,7 @@ Second, one chooses builds the view component with the models.
Here is an illustration for the object relations in this basic case.
-![Object relations](img/normal_use.png)
+![Object relations](/usr/share/doc/elpa-ctable/normal_use.png)
Here is a sample code for the model and view.
@@ -87,7 +87,7 @@ Here is a sample code for the model and view.
Here is the result image.
-![sample-2-1](img/sample-2-1.png)
+![sample-2-1](/usr/share/doc/elpa-ctable/sample-2-1.png)
The models have further options and functions to customize the display and behavior, such as column width, text alignment, sorting and so on. (See Model section)
@@ -98,7 +98,7 @@ The ctable framework provides some hooks to notify the usual events: click, sele
The appearance of the table can be customized, such as foreground and background color, tabular lines. (See Display Parameter section)
-![ctable components](img/objects.png)
+![ctable components](/usr/share/doc/elpa-ctable/objects.png)
## Sample Codes
@@ -110,7 +110,7 @@ The appearance of the table can be customized, such as foreground and background
- directory tree and table list in collaboration with direx.el
- ref: https://github.com/m2ym/direx-el
-![direx-ctable image](img/direx-ctable.png)
+![direx-ctable image](/usr/share/doc/elpa-ctable/direx-ctable.png)
# Advanced Topics
@@ -159,8 +159,8 @@ The ctable provides some hooks for the particular events: clicking, selection ch
Here is a sample code for the click action:
```lisp
-(ctbl:cp-add-click-hook
- cp (lambda () (message "CTable : Click Hook [%S]"
+(ctbl:cp-add-click-hook
+ cp (lambda () (message "CTable : Click Hook [%S]"
(ctbl:cp-get-selected-data-row cp))))
```
@@ -263,7 +263,7 @@ Region destination example:
Then, the tabular view will be embedded in the scratch buffer. You can navigate the ctable view in the buffer. Undoing for the some times, you can remove the ctable view.
-![ctable in scratch buffer](img/region-scratch.png)
+![ctable in scratch buffer](/usr/share/doc/elpa-ctable/region-scratch.png)
Because this destination never interacts anything out of the region and has its own key-binds as a text property, users can easily embed a tabular view in the other applications.
@@ -351,11 +351,11 @@ Here is a sample code:
(loop with lim = 4000
for i from 0 upto lim
for d = (/ (random 1000) 1000.0)
- collect
+ collect
(list i d (exp (- (/ i 1.0 lim))) (exp (* (- (/ i 1.0 lim)) d)))))
(async-model ; wrapping a large data in async-data-model
(ctbl:async-model-wrapper large-data))
- (cp ; just build a component
+ (cp ; just build a component
(ctbl:create-table-component-buffer
:model
(make-ctbl:model
@@ -370,7 +370,7 @@ Here is a sample code:
And here is the result image:
-![async data wrapper](img/async-wrapper.png)
+![async data wrapper](/usr/share/doc/elpa-ctable/async-wrapper.png)
### Case 2: Asynchronous Retrieving
@@ -387,7 +387,7 @@ Here is a minimum sample code:
(loop for i from row-num below (+ row-num len)
collect
(list i (* i i) (* i i i) (sqrt i)))))
-
+
(ctbl:open-table-buffer-easy
(make-ctbl:async-model :request 'async-response) ; defining async-model
'("int" "square" "cube" "root"))
@@ -403,7 +403,7 @@ The `request` function should have 4 arguments:
Here is the result image:
-![defining async model:1](img/async-model-sample1.png)
+![defining async model:1](/usr/share/doc/elpa-ctable/async-model-sample1.png)
#### ctbl:async-model struct