|
1 |
| -# Seer-plugin |
| 1 | +# Seer Plug-in |
2 | 2 |
|
3 | 3 | #### How to add a plugin
|
4 | 4 |
|
5 |
| -- The extension of the file is not case sensitive. |
6 |
| -- Drag the line number to change sequence |
7 |
| -- Triggered only check the plug-in type at a time |
| 5 | +- The extension of file is case insensitive |
| 6 | +- Drag line number to change sequence |
| 7 | +- Triggered only check the plug-in type once |
8 | 8 |
|
9 |
| - |
10 |
| - |
11 |
| -#### How to write a plugin |
12 |
| - |
13 |
| -######Replace invocation |
14 |
| - |
15 |
| -Seer will replace *SEER_OUTPUT_PATH\* with the triggered file, replace *SEER_INPUT_PATH\* with the output path. If the plugin output file doesn't contain a suffix, you could append suffix to the *SEER_OUTPUT_PATH\*. |
16 |
| - |
17 |
| -*In practical use, it looks like this:* |
18 |
| - |
19 |
| -> nconvert.exe -out pdf -o \*SEER_OUTPUT_PATH\*.pdf \*SEER_INPUT_PATH\* |
| 9 | +To install a plugin, select it in the `Settings` and hit the `Download` button afterwards. This initiates the download of the plugin file in the default system browser. |
20 | 10 |
|
| 11 | +All plugins are provided as zip archives which you need to extract on the local system. Afterwards, switch to the `Local` tab under `Plugins` in Seer's `Settings`, and click on add. This opens a file browser which you use to select the `json` file in the folder you have extracted the archive to. |
21 | 12 |
|
| 13 | +Once done, support for the new file types has been added to Seer. |
22 | 14 |
|
23 | 15 |
|
24 | 16 |
|
25 |
| -######Normal invocation |
26 |
| - |
27 |
| -Seer will add two strings after command line when invoking the plugin. |
28 |
| - |
29 |
| -``` |
30 |
| -1. The front string is the full path to the triggered file, for example, "E:/my_folder/name.ttf". |
31 |
| -2. The other string has a full path of the file and there is no file suffix. For example, "C:/Users/COREY/AppData/Local/Temp/Seer/a-random-name". |
32 |
| -``` |
33 |
| - |
34 |
| -The plugin will analysis triggered file into the format of one of the built-in Seer suffix, name the resulting file as a-random-name, and save it on the path, “C:/Users/COREY/AppData/Local/Temp/Seer/”. |
35 |
| - |
36 |
| -To illustrate the function, we use the mentioned font file above as an example. |
| 17 | +#### How to write a plugin |
37 | 18 |
|
38 |
| -The invocation of Seer is shown as below. |
| 19 | +######Replace invocation |
39 | 20 |
|
40 |
| -`C:/Seer/fontpreview.exe C:/triggering-path/FILE.TTF C:/Seer-temp-path/ABCabc123` |
| 21 | +Seer replaces `*SEER_INPUT_PATH*` with the triggered file, replaces `*SEER_OUTPUT_PATH*` with the saving path. If the plugin output file doesn't contain a suffix, you can append suffix to the `*SEER_OUTPUT_PATH*`. |
41 | 22 |
|
42 |
| -**fontpreview.exe would render FILE.TTF to ABCabc123.png** |
| 23 | +*In practical use, it looks like this:* |
43 | 24 |
|
44 |
| -*In practical use, it looks like these:* |
| 25 | +> nconvert.exe -out pdf -o \*SEER_OUTPUT_PATH\*.pdf \*SEER_INPUT_PATH\* |
45 | 26 |
|
46 |
| -> - fontpreview_py.exe -t "A Quick Brown Fox Jumps Over The Lazy Dog 0123456789" |
47 |
| -> - 1syt.exe |
48 |
| -###### |
49 | 27 |
|
50 | 28 |
|
| 29 | +*Source Code for example* |
51 | 30 |
|
52 |
| -*Source Code* |
| 31 | +- [fontpreview](https://github.com/ccseer/Seer-plugins/blob/master/font/fontpreview_py.py) |
| 32 | +- [MS-Office](https://github.com/ccseer/Seer-plugins/blob/master/ms-office/1syt.py) |
53 | 33 |
|
54 |
| -- fontpreview [Github](https://github.com/ccseer/Seer-plugins/blob/master/font/fontpreview_py.py) |
55 |
| -- MS-Office [Github](https://github.com/ccseer/Seer-plugins/blob/master/ms-office/1syt.py) |
56 | 34 |
|
57 |
| -Contact: cc.seer@gmail.com |
58 | 35 |
|
59 | 36 |
|
60 | 37 |
|
0 commit comments