Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/puutaro/CommandClick
Browse files Browse the repository at this point in the history
  • Loading branch information
puutaro committed Nov 6, 2023
2 parents cf54ae3 + 62872c1 commit e7a26cb
Show file tree
Hide file tree
Showing 10 changed files with 457 additions and 86 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ CommandClick

- Existing web browsers mainly has tab feature. But `CommandClick`'core is history search. Therefore, you easly restore, load, and check my history.
- Existing web browsers support normal javascript. But `CommandClick` enforce javascript, and interact with not only web but also ubuntu and android os. Therefore, this has wide spread usage
- Existing web browsers cannot create original android application. But `CommandClick` can create application just for you as low code tool.
- Existing web browsers cannot create original android app. But `CommandClick` can create the app just for you as low code tool.


Screenshots
Expand Down
41 changes: 28 additions & 13 deletions TUTORIAL.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,36 @@
# `CommandClick` Tutorial
# Tutorial

`CommandClick` is low code tool.
Apps that normally require many lines can be written with even less code.
In `CommandClick`, coll these app [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository).
By CommandClick power, enable your idea to [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) fastly.
For example, [webSercher.js](https://github.com/puutaro/commandclick-repository/blob/master/fannel/webSearcher.js) [newsSpeecher.js](https://github.com/puutaro/commandclick-repository/blob/master/fannel/newsSpeecherDir/newsSpeecher.md), [cmdYoutuberU.js](https://github.com/puutaro/commandclick-repository/blob/master/fannel/cmdYoutuberUDir/cmdYoutuber.md), etc.
In order to make low cost app, this tutorial teach you requred knowledge.
I hope your `ComamndClick` developer life is meaningful.
<img src="https://github.com/puutaro/CommandClick/assets/55217593/e4e6f75b-a35e-47f1-bb41-144d8ea88185" width="500">

Table of Contents
`CommandClick`'s true value is low code tool.
Ofcourse, `CommandClick` can use as web browser, mobile ubuntu terminal. These feature is very useful.
However that alone don't know `CommandClick`'s true aim.
`CommandClick` is android app maker.
It can also be made with surprisingly litle effort.
The less effort, the better.
Do you play date to prety girl and delicious lunch to decrease time for code implementation time?
Becuase `CommmandClick` itself include ubuntu and web browser, due to effort, you can do everything.
But, it's is worst.
`CommandClick`'s significance is less `effort` development.
Although this tool require understanding specification ofcourse, it's aime save your effort.
This tutorial tell you knowledge for low cost.
I hope your android development life will become easy and fast.

Requirement
-----------------
<!-- vim-markdown-toc GFM -->

* [Hello world](#hello-world)
Javascript code basic knowledge.
In [By notification](#by-notification) section, require shellscript basic knowledge.


Table
-----------------
<!-- vim-markdown-toc GFM -->

## Hello world
* Best 4 hello world
* [By alert](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/by_alert_hello_world.md)
* [By text to speech1](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/by_text_to_speech_hello_world.md)
* [By text to speech2](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/by_text_to_speech_hello_world2.md)
* [By notification](#by-notification)

-> [Best 3 hello world](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/hello_world.md)

17 changes: 10 additions & 7 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Table of Contents


Usage
-----
-----------------

### Index mode

Expand Down Expand Up @@ -455,7 +455,8 @@ Also whether click or long click torigger, due to `historySwitch` setting (refe
).


### Developer page
Developer page
-----------------

-> [DEVELOPER.md](https://github.com/puutaro/CommandClick/blob/master/DEVELOPER.md)

Expand All @@ -467,7 +468,8 @@ I mean, `CommandClick` is low code tool. You can make andorid application by les
Welcome to above developer page that expands depending on you.


### Commandclick-repository
Commandclick-repository
-----------------

-> [CommandClick's fannel repository](https://github.com/puutaro/commandclick-repository)

Expand All @@ -477,20 +479,21 @@ For instance, your click script in CommandClick. One thing I can say that Comman



### Generally TroubleShooting
Generally TroubleShooting
-----------------

- App not working -> [**kill all process**](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#kill)
- Although this is frequently, incident is unknown

f   


- When `fannel` suddenly not working, update latest `CommandClick` and `fannel`.
- `CommandClick` and `fannel` is new baby. Therefre, these is frequetly updated without backwards compatible. I continuly enforce usability and fanctionality. Before long, if these grow up adult, I weight stability. But, please feel at ease, most often even now, latest version works fine.




### Ubuntu, debian and windows version
Ubuntu, debian and windows version
-----------------

-> [ubuntu, debian or windows version](https://github.com/puutaro/cmdclick)

Expand Down
2 changes: 1 addition & 1 deletion md/developer/directory_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ to resotre y-position when you visit site in url history,

[Fannel](https://github.com/puutaro/CommandClick/blob/master/md/developer/js_pre_reserved_word.md) directory path

All fannel main direcotry must be ${fannel name without extend} + "Dir", otherwise cannot controll by `CommandClick`
All fannel main direcotry must be `${fannel name without extend} + "Dir"`, otherwise cannot controll by `CommandClick`


## `~/conf` <a id="conf"></a>
Expand Down
2 changes: 1 addition & 1 deletion md/developer/set_variable_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Table
* [setVariableTypes options table](#setvariabletypes-options-table)
* [Usage](#usage)
* [This option can be combined](#this-option-can-be-combined)
* [Specify file path](#specify-file-path)
* [Specify config](#specify-config)


## Overview
Expand Down
34 changes: 26 additions & 8 deletions md/developer/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@
# tutorial
# Tutorial

`CommandClick`'s true value is low code tool.
Ofcourse, `CommandClick` can use as web browser, mobile ubuntu terminal. These feature is very useful.
However that alone don't know `CommandClick`'s true aim.
`CommandClick` is android app maker.
It can also be made with surprisingly litle effort.
The less effort, the better.
Do you play date to prety girl and delicious lunch to decrease time for code implementation time?
Becuase `CommmandClick` itself include ubuntu and web browser, due to effort, you can do everything.
But, it's is worst.
`CommandClick`'s significance is less `effort` development.
Although this tool require understanding specification ofcourse, it's aime save your effort.
This tutorial tell you knowlege for low cost.
I hope your android development life will become easy and fast.

Table
Requirement
-----------------
<!-- vim-markdown-toc GFM -->

* [Best 3 hello world](#Best-3-hello-world)
javascript code basic knowledge.
In [By notification](#by-notification) section, require shellscript basic knowledge.


Table
-----------------
<!-- vim-markdown-toc GFM -->

## Best 3 hello world
* Best 4 hello world
* [By alert](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/by_alert_hello_world.md)
* [By text to speech1](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/by_text_to_speech_hello_world.md)
* [By text to speech2](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/by_text_to_speech_hello_world2.md)
* [By notification](#by-notification)

-> [Best 3 hello world](https://github.com/puutaro/CommandClick/blob/master/md/developer/tutorial/hello_world.md)

I choice best 3 hello world.
By this, you overview about CommandClick development.
27 changes: 17 additions & 10 deletions md/developer/tutorial/by_alert_hello_world.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,44 @@ Table
Create `hello_world_by_alert.js`.

```js.js
// [1]
/// SETTING_SECTION_START
// [2]
editExecute="NO"
// [3]
scriptFileName="hello_world_by_alert.js"
/// SETTING_SECTION_END

alert("hello world");
```

[1] -> [setting section](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)
[2] -> [editExecute](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#editexecute)
[3] -> [scriptFileName](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)


- `CommandClick` js [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) is bookmarklet.

- Js [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) require `;` by each line.

- This code is equal bellow code

```js.js
/// SETTING_SECTION_START // [1]
editExecute="NO" // [2]
scriptFileName="hello_world_by_alert.js" // [3]
/// SETTING_SECTION_END

alert("hello world");
```

[1] -> [setting section](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)
[2] -> [editExecute](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#editexecute)
[3] -> [scriptFileName](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)

## Step 2

Copy `hello_world_by_alert.js` to `/storage/emulated/0/Documents/cmdclick/default`<sub>[1]</sub> directory
Copy `hello_world_by_alert.js` to `/storage/emulated/0/Documents/cmdclick/default` directory<sub>[1]</sub>

[1] -> [app directory](https://github.com/puutaro/CommandClick/blob/master/md/developer/glossary.md#app-directory)

## Step 3

Execute by [run](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#run)

<img src="https://github.com/puutaro/CommandClick/assets/55217593/dda94eb8-e865-4672-9b33-93df9e7e83f9" width="400">

- Enable to execute from [url history](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#url-history) by bellow step

1. Click [edit startup](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#edit-startup) in `setting`
Expand All @@ -58,3 +64,4 @@ Execute by [run](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#ru
5. Click `hello_world_by_alert.js` in [url history](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#url-history)



116 changes: 85 additions & 31 deletions md/developer/tutorial/by_text_to_speech_hello_world.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,115 @@
# By text to speech, hello world

This
This is required section if you want to `CommandClick`'s [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) creator.
[Funnels](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) are surprisingly easy to make.
You experience `CommandClick`'s impact as low code tool.

This section is jump board in order to become `CommandClick` core developer.
This point include common use essence for [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) development.
Therefore, if you complete here, you acquire `CommandClick` development base skill.


Table
-----------------

* [Step 1](#step-1)
* [Step 2](#step-2)
* [Step 3](#step-3)
* [Step 4](#step-4)

## Step 1

Create `hello_world_by_alert.js`.
Create `textToSpeechTutorial1.js`.

```js.js
alert("hello world");
```

- `CommandClick` js [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) is bookmarklet.

- Js [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) require `;` by each line.

- This code is equal bellow code

```js.js
// [1]
/// SETTING_SECTION_START
editExecute="NO"
scriptFileName="hello_world_by_alert.js"
// [2]
scriptFileName="textToSpeechTutorial1.js"
// [3]
editExecute="ALWAYS"
// [4]
setReplaceVariables="TXT_LABEL=label"
// [5]
setReplaceVariables="FANNEL_PATH=${0}"
// [6]
setReplaceVariables="FANNEL_DIR_PATH=${01}/${001}"
setReplaceVariables="PLAY_TXT_PATH=${FANNEL_DIR_PATH}/playText.txt"
setReplaceVariables="PLAY_LIST_TSV_PATH=${FANNEL_DIR_PATH}/playList.tsv"
// [7]
setVariableTypes="speechText:TXT:LBL=${TXT_LABEL}=this"
/// SETTING_SECTION_END

alert("hello world");
// [8]
/// CMD_VARIABLE_SECTION_START
// [9]
speechText="hello world"
/// CMD_VARIABLE_SECTION_END


execTextToSpeech();

function execTextToSpeech(){
// [10]
jsFileSystem.createDir("${FANNEL_DIR_PATH}");
// [11]
jsFileSystem.writeLocalFile(
"${PLAY_TXT_PATH}",
speechText
);
// [12]
jsFileSystem.writeLocalFile(
"${PLAY_LIST_TSV_PATH}",
"${PLAY_TXT_PATH}"
);
let extraSettingMapStr = [
`importance=low`,
`pitch=50`,
].join("|");
jsTextToSpeech.speech(
"${PLAY_LIST_TSV_PATH}",
extraSettingMapStr,
);
};

```

-> [setting section](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)
-> [editExecute](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#editexecute)
-> [scriptFileName](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)

[1] -> [setting section](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)
[2] -> [scriptFileName](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#scriptfilename)
[3] -> [editExecute](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#editexecute)
[4] -> [setReplaceVariables](https://github.com/puutaro/CommandClick/blob/master/md/developer/set_replace_variables.md#overview)
[5] -> [pre order word](https://github.com/puutaro/CommandClick/blob/master/md/developer/js_pre_reserved_word.md)
[6]
-> [fannel dir](https://github.com/puutaro/CommandClick/blob/master/md/developer/directory_structure.md#fannel_dir)
[8] -> [cmd variables](https://github.com/puutaro/CommandClick/blob/master/DEVELOPER.md#cmd-variables)
[9] -> edit text cmd variable
[7]
-> [setVariableTypes](https://github.com/puutaro/CommandClick/blob/master/md/developer/set_variable_types.md#overview)
-> [`TXT`, `LBL`](https://github.com/puutaro/CommandClick/blob/master/md/developer/set_variable_types.md#setvariabletypes-options-table)
-> [This option can be combined](https://github.com/puutaro/CommandClick/blob/master/md/developer/set_variable_types.md#this-option-can-be-combined)
[10]
-> [jsFileSystem](https://github.com/puutaro/CommandClick/blob/master/md/developer/js_interface/jsFileSystem.md)
-> [createDir](https://github.com/puutaro/CommandClick/blob/master/md/developer/js_interface/functions/JsFileStystem/createDir.md)
[11]
-> [writeLocalFile](https://github.com/puutaro/CommandClick/blob/master/md/developer/js_interface/functions/JsFileStystem/writeLocalFile.md)
[12]
-> [TextToSpeech](https://github.com/puutaro/CommandClick/blob/master/md/developer/js_interface/functions/JsTextToSpeech/speech.md)

- `CommandClick` js [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) is bookmarklet.

- Js [fannel](https://github.com/puutaro/commandclick-repository/blob/master/README.md#commandclick-repository) require `;` by each line.


## Step 2

Copy `hello_world_by_alert.js` to `/storage/emulated/0/Documents/cmdclick/default` directory
Copy `textToSpeechTutorial1.js` to `/storage/emulated/0/Documents/cmdclick/default` directory<sub>[1]</sub>

- [app directory](https://github.com/puutaro/CommandClick/blob/master/md/developer/glossary.md#app-directory)
[1] -> [app directory](https://github.com/puutaro/CommandClick/blob/master/md/developer/glossary.md#app-directory)

## Step 3

Execute by [run](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#run)

- Enable to execute from [url history](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#url-history) by bellow step
Click with [this](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#run)

1. Click [edit startup](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#edit-startup) in `setting`
2. Click `add` button in [homeScriptUrlsPath](https://github.com/puutaro/CommandClick/blob/master/md/developer/setting_variables.md#homescripturlspath)
3. Click `hello_world_by_alert.js` in grid box
4. Close edit box.
5. Click `hello_world_by_alert.js` in [url history](https://github.com/puutaro/CommandClick/blob/master/USAGE.md#url-history)
## Step 4

Click Play button in toolbar

<img src="https://github.com/puutaro/CommandClick/assets/55217593/d932c31b-0987-429a-a5dc-59f2e65cad41" width="400">
Loading

0 comments on commit e7a26cb

Please sign in to comment.