Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions Basic Startup.txt

This file was deleted.

27 changes: 27 additions & 0 deletions Help/BOILER_PLATES/app.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">

<link rel="stylesheet" type="text/css" href="app.css">
<script type="text/javascript" src="../res/jquery.js"></script>
<script type="text/javascript" src="../res/mink.js"></script>
</head>

<style type="text/css">
/* @import should go here */
</style>

<body>
<!-- HTML should go above this line -->
<div id="Toast-Message"></div>
<br /><br />
<br /><br />
</body>

<script type="text/javascript">
/* JavaScript should go here */
</script>

</html>
53 changes: 53 additions & 0 deletions Help/app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Building Mink apps

*Note: Feel free to change anything in this project under the SOURCE directory.*

----

### Needed:

- Knowledge of:
+ JS
+ HTML5
+ CSS3

- Software:
+ Text editor
+ HTML5 enabled browser
+ JS enabled browser
+ CSS3 enabled browser

----

### Automatically handled by Mink:

1. FULL SCREEN:
- If the screen is scrolled past the master button, the master button area (system tray) is overlapped (thus 'hiding' it), as well as the notification area.¹

2. TIME UPDATE:
- The current time will be notified every 60s, for 5s.¹

----

### Step-by-step instructions on building an app:

1. Create a sub-directory in the `/SOURCE/APP` directory, and inside of it, a group of files: `app.html` `app.js` `app.css` (and if needed, a sub-directory `/mof` to hold extra data: i.e. form data, form submission pages, cache pages, etc.)

2. Name the directory `com.{company}.{name}` (like Android apps)

3. Build your app as `app.html`

4. Link your app to the Mink OS:
- In the index.html file, add the following:
```html
<a href="APP/com.company.name/app.tml" app>
Name*
</a>
<br /><br />
```
- Or:
+ While running the Mink OS, select `Settings | Apps | Add` and enter the company and name of the app

*Note: If you clear browser cookies ALL app data, locations, and references will be deleted if you choose not to do § i
*Note: ¹ is to be updated (either fixing, or creating)
*Note: be sure to include the following in your app.html file if you need the resources: BOILER_PLATES/app.html
8 changes: 8 additions & 0 deletions Help/color_palette.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Mink Blue: #00ACED NEGATED =
Mink Orange: #|FF5312 - 00ACED| =
Mink Pink: #|FF59DB - FF5312| =
Mink Over-kill: #|0006C9 - 00ACED| =
Mink Green: #|00A624 - FF5312| =
Mink Tangerine: #FFA312

*Note: "=" means to create the color on the next line.*
2 changes: 2 additions & 0 deletions Help/css.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# CASCADING STYLE SHEET (RGB)
- all CSS selectors
5 changes: 5 additions & 0 deletions Help/html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# HYPER TEXT MARKUP LANGUAGE (MINK)
- all HTML5 attributes, properties and elements

# Attributes
- `icon`: icon of this element
131 changes: 131 additions & 0 deletions Help/js.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# JAVASCRIPT (INK)

## Miscellaneous JS

- variables
- `input` - form input
- `navigator.platformType` - mobile/immobile (desktop)

- functions
- "all" original JS functions
- all jQuery functions (as of v.2.1.1)
- `ICON_COUNT(id, what, who)`
+ id: what DOM Object should I locate
+ what: what icon am I looking for, if left blank, how many total icons are in this DOM
+ who: which DOM do I get if there are multiple copies, default is 0 (first)
- `ICON_EXISTS(icon)`
+ `icon` - what icon am I looking for
- `ICON_GET(id)`
+ `id` - locate this DOM and return the icon
- `ICON_GET_CHILD(id)`
+ `id` - get this DOM's child's icon
- `ICON_INDEX(icon)`
+ `icon` - what is this icon's name/number ; if given a name, returns a number; if given a number, returns a name
- `ICON_SET(id, icon)` (*use this for one time icon changes*)
+ `id` - get this DOM Object
+ `icon` - make this the new icon
- `ICON_SET_CHILD(id, child, icon)`
+ `id` - get this DOM
+ `child` - which child
+ `icon` - make this the icon
- `ICON_SWAP(id, icon)` (*use this for multiple icon changes, it will automatically swap between the original icon and new icon*)
+ `id` - get this DOM Object
+ `icon` - new icon to swap with
- `LIST_ICONS()` (*use this to return a list of all icons*)
- `NO_CSS_TAMPER([CSS])` (*use this for an over-ride, this will make the internal style-sheet over-ride the external style-sheet located at /SOURCE/RGB/mink.css; this function executes itself automatically onload (under the first style element)*)
+ `CSS` - which style element should I get, if left blank, I will use the first, if any, style element I find
- `DELETE_STORAGE(name)` | `Delete(name)`
+ `name` - storage-point to delete
- `GET_STORAGE(x)` | `Load(x, a, e, w)`
+ `x` - what storage-point should I load, or if using `Load()` and there is a video/audio tail, load the media into the document
+ `a` - text to display as an alternate
+ `e` : does it need to be encoded? if so (e is true), encode x
+ `w` : which DOM Object needs this
- `GET_STORAGE_BOOLEAN(c)`
+ `c` - does this storage-point exist
- `GET_FORM_DATA()` (*use to return a variable `input` as an array; the `name` attribute of each input element become apart of `input`*)
- `SET_STORAGE([name, value])` | `Save(value, [name])` (*you do not need to set name in `Save()`, it will automatically create one for you*)
+ name - this is the storage-point's name, if name is left blank for Save() , the default name will be `{appname}.cache`
+ value - this is the storage value
- `FROM_{type}(size, to)` (*this function will return the 'true' data size, i.e. 1024 bytes will be 1 kb, 1000 bytes will return 1.024 kb*)
+ `size` - express size as `to`
+ `to` - to this size: [b, B, KB, MB, GB, TB, PB, EB, ZB, YB]
- `b` - bit (2^-3 Bytes)
- `B` - byte (2^0 Bytes) __or__ 8 bits (`00000000`)
- `KB` - kilobyte (2^10 Bytes)
- `MB` - megabyte (2^20 Bytes)
- `GB` - gigabyte (2^30 Bytes)
- `TB` - terabyte (2^40 Bytes)
- `PB` - petabyte (2^50 Bytes)
- `EB` - exabyte (2^60 Bytes)
- `ZB` - zetabyte (2^70 Bytes)
- `YB` - yottabyte (2^80 Bytes)
- `AUTO_SIZE(n, f, s)` (will return a floored integer, i.e. 1023B will be 0KB)
+ `n` - data size
+ `f` - from this size, default is b (bits)
+ `s` - scale, at which point should I make the data size type scale, default is 0.5
- *if n@Size-Type > s, make n=n@Size-Type*
- `Toast(data, t)`
+ `data` - what to display
+ `t` - timeout, in seconds (automatically converts into miliseconds) ; default is 3 (3s)
- `lock = new PatternLock(id, [data])` (see [PatternLock](http://ignitersworld.com/lab/patternLock.html) for more help, (C) to Sudhanshu Yadav 2013)
+ `lock` - new pattern lock to create
+ `id` - the element's id attribute
+ `data` - extra specifications

----

# Examples

## GET_FORM_DATA()

> form.html
```html
<form action="next.html" method="GET">
<!-- ... -->
<input name="username" type="text">
<input name="password" type="password">
</form>
```

> form.js
```javascript
GET_FORM_DATA()
```

*The `input` variable now holds: `input.username` and `input.password`, with a value of the users choice; you must use `method="GET"`*

----

## SET_STORAGE([name, value])

> foobar.js
```javascript
SET_STORAGE('name',input.username,'password',input.password);
```

*Note: the storage-points |name| and |password| exist, and won't expire*

----

## FROM_{type}(size, to)

```javascript
FROM_GB(1024, 'TB');
// Returns 1 (TB)
```

----

## AUTO_SIZE(n, f, s)

```javascript
AUTO_SIZE(5,'B')
// Returns 5B

AUTO_SIZE(1024,'B')
// Returns 1KB

AUTO_SIZE(9000000000,'B')
// Returns 8GB
```
47 changes: 47 additions & 0 deletions Help/resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# REFERENCES OF RESOURCES:

*Note: use these if you are in the `/SOURCE/APP/com.company.name` directory, else if in the `/SOURCE/APP/com.company.name/mof` directory, add `../` to the beginning*

# DEFAULT STYLING:

```html
<link rel="stylesheet" type="text/css" href="../res/mink.css">
<script type="text/javascript" src="../res/app.js"></script>
```

# BLACK ICONS:
```html
<link rel="stylesheet" type="text/css" href="../res/icons-black.css">
```

# WHITE ICONS:
```html
<link rel="stylesheet" type="text/css" href="../res/icons-white.css">
```

# MINK JS FUNCTIONS:
```html
<script type="text/javascript" src="../res/mink.js"></script>
```

# JQUERY:
```html
<script type="text/javascript" src="../res/jquery.js"></script>
```

# TOAST MESSAGE:
```html
<div id="Toast-Message"></div>
```

*Note: `Toast()` can only be used by apps*

# NOTIFICATION:

*Note: can only be displayed by Mink*

# LOCKS:
```html
<script type="text/css" src="../res/pattern.js"></script>
<link rel="stylesheet" type="text/css" href="../res/pattern.css">
```
2 changes: 2 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org>

Ephellon D. Dantzler
Loading