Skip to content

Latest commit

 

History

History
executable file
·
308 lines (190 loc) · 10.5 KB

DEVELOPER.md

File metadata and controls

executable file
·
308 lines (190 loc) · 10.5 KB
Raw

Command Click Developer page

This page is for developer. CommandClick true value change self made script to android app.
I hope you get that knowledge.

Table of Contents

System structure

Fannel (bookmarklet) dir structure

fannel is bookmarklet in ComamndClick

Create bellow directory tree

├── {fannelName}.js
└── {fanneName}Dir
    ├── settingVariables
    │   ├── setReplaceVariables.js
    │   └── setVariableTypes.js
    └── README.md
  • Base fannel file is {fannelName}.js
  • Place other settings and data in {fanneName}Dir dir

Fannel(bookmarklet) structure

  • labeling section

  • setting variable contents
    -> Setting variable

  • cmd variable contents

    -> cmd variable

  • script contents
    javascript' or shellscript' contents

Labeling section

-> About labeling section

This section is description for fannel(js or shell file enforced by CommandClick).

Cmd variables

User difinition setting variables to enable edit by gui
If set, display firstly in edit.

Setting variable

-> About setting variables

CommandClick's pre-reserved system setting variables to enable edit by gui
If set, display secondly in edit.

editExecute

Edit and Execute on click play button.
Particularly, ALWAYS is most used value in order to standalone app.

Value Description
NO only edit (default)
ALWAYS always edit -> execute

setReplaceVariables

This variable definite constant variable.
You also have multiple specifing this.

-> detail

  • ex
setReplaceVariables="{replaceVariablle1}={repalce string1}

or

setReplaceVariables="file://{file path}"

setVariableTypes

This variable is controller in MVVM or MVC architecture
When edit, set variable type to cmd variables.

You also have multiple specifying this.
-> detail

toolbar button config

You can customize bellow button config

playButtonConfig editButtonConfig settingButtonConfig

More for setting variables

-> About setting variables

Javascript

Js is one of the core language in CommandClick
CC has super customization functions.
And Enable to control CC system.

Js action

js action is developed for CommandClick developer
This language is annotation-oriented language based on javascript in CommandClick
You automatically have more readable, maintainable, and manageable code by js action.

  • prompt ex
var=isOkHelloWorld
  ?func=prompt
  ?args=
    comfirmMsg="Hello world, OK?"

-> detail is constructing...

Js shiban

CC has shiban for javascript.
This is used to handle normal js or js action or etc.

-> js shiban

JavaScript interface

-> javascript interfaces

CommandClick is javascript framework for andorid. Particularly, this methods strongly support your android app development(fannel development).
This, so colled, android app row code library.

Javascript pre reserved word

-> About js pre reserved word

Like ${0} in shell, CommandClick's js has pre reserved word

Import js library

CommandClick can import all file with uri. We can use javascript all of the world. This is CommandClick basic idea.
CommandClick is open world app, as is, web browser, termux client, bookmarklet maker, applicatoin store, and library terminal.
Bellow is how to import. You can enjoy this all range import application!

-> js import

Javascript system args

-> About javascript system args

Add arg on CommandClick's certain action for js.
For example, urlHistoryClick, onAutoExec action.

Include Javascript Library

-> About include javascript library

First, I respect bellow javascript package author.
Bellow respectable package is inclided assets. you can import like bellow.

Include css Library

-> About include css Library

First, I respect bellow css package author.
Bellow respectable package is inclided assets. you can import like bellow.

Html tag output

-> About html tag output

CommandClick script output trminal as html, so html tag is valid. You can use tag .

Javascript TroubleShooting

-> About js trouble shouting

Ubuntu

CommadClick has ubuntu22.04.
So, this app is full end app from frontend (webview) + backend (ubuntu).

Custom shell command

It is a useful tool for CommandClick. For example, send broadcast, toast, and etc.

-> About custom shell command

Ubuntu env variables

-> About environment variable in ubuntu

Ubuntu Extra Startup Shell Paths

Set auto start shell script path Usecase is startup script, service, and daemon etc...

-> ubuntuExtraStartupShellPaths.tsv

QR code format

QR code has excellent carrying capacity. So, suit for fannel distribution.
By CC qr system, you can easily distribute your app (fannel).
Bellow, that format.

-> qr code

Directory structure

-> About directory structure

File api

CommandClick is managed by files data So, each file data can use in CommandClick's development

-> fileApi

File api for ubuntu

-> About ubuntu file api

Support file for CommandClick's ubuntu For example, alternative data base, etc..

Broadcast actions

-> About broadcast actions & schema

Use port

-> About use port

Commandclick-repository

-> About CommandClick's fannel repository

fannel is ComamndClick using script (javascript, and shellscript) For instance, your click script in CommandClick. One thing I can say that CommandClick is developed for the purpose of changing javaxcript and shellscript to gui appication. That applies to click script. It's so called Gui application. We can say so. I call the gui application fannel

Glossary

-> About glossary