Skip to content

Commit

Permalink
Merge pull request #27 from ogewan/future
Browse files Browse the repository at this point in the history
Change the Future
  • Loading branch information
ogewan committed Sep 5, 2015
2 parents baca685 + 507a5bf commit 03a2eb1
Show file tree
Hide file tree
Showing 13 changed files with 1,119 additions and 500 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

```<div cglink="cng"><button class="prev"></button><button class="next"></button></div>```, *Adding the attribute* **cglink** *turns any element into a controller. Note: cglink binds the controller to a* **[stage]**

* :new: To update any element dynamically, add the **cg-hot** class. This updates the element and its children every time the page changes.
* To update any element dynamically, add the **cg-hot** class. This updates the element and its children every time the page changes.

* To add additional features, use a plug-in:

Expand All @@ -30,13 +30,38 @@

### Script
If the Stage is the Body, and the Core is the Mind, then Scripts are the Soul. The Script is a JSON file that sets up the configuration options and adds images for each page. [This is how to do it.](https://github.com/ogewan/comix-ngn/wiki/How-to-Script)
#### Additive
:new: an additive is a simplified JSON file that expedites the addition of comic pages.
The following is the structure:
``` js
{"p":[
imageurl 1, imageurl 2, imageurl 3, etc...
]}
```
To enable the additive feature:
Add the **additive** attribute to selected venue

or

Add an address to the additive option in the config section of the Script.JSON
### Attributes
For more fine-grain control, use the following additional attributes or class properties:
* __SPECIAL__ - These classes change the properties of whatever they are set on.
* __cgdate__ - This sets the elements [innerHTML](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML) or inner text to the release date of Stage page.
* __cgtitle__ - This sets the elements [innerHTML](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML) or inner text to the title of Stage page.
* __CORE__ - These attributes customizes settings and performance of comix-ngn.
* __fBox__ - fBox functions as a sort of fusebox that globally toggles many options:
(*Note: fBox requires the following format "{'option': true/false}"*)

```<script src="comixngn.js" fBox="{'fstrun':true}"></script>```

* __fstrun__ (bool): toggles stageInjection on page load
* __pgepsh__ (bool): toggles url change on slide change
* __pgesve__ (bool): toggles slide number saving in localStorage
* __protect__ (bool): by default, the comix(main comic) is set once, if protect is set to default, the comix is overwritten per stageInjection
* __noverwrite__ (bool): by default, stageInjection cannot overwrite already inserted comics, set to false to allow overwriting
* __arrow__ (bool): toggles arrow key navigation

* __comicID__ - This sets the ID of the comic which is allows the framework to save site specific settings to user's browsers, such as most recently viewed page. It will default to the website's host name if not given.

```<script src="comixngn.js" comixID="comixngn"></script>```
Expand Down
1 change: 1 addition & 0 deletions additive.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"p":["http://pre03.deviantart.net/fe47/th/pre/f/2014/301/8/3/how_to_po__page_06_by_ladisilverfox-d84ix3x.jpg","http://pre06.deviantart.net/0c7f/th/pre/f/2014/301/6/9/how_to_po__page_07_by_ladisilverfox-d84ix44.jpg","http://pre03.deviantart.net/9240/th/pre/f/2014/301/0/4/how_to_po__page_08_by_ladisilverfox-d84ix4e.jpg","http://pre04.deviantart.net/d793/th/pre/f/2014/301/c/1/how_to_po__page_09_by_ladisilverfox-d84ix4p.jpg","http://pre07.deviantart.net/f25b/th/pre/f/2014/301/3/7/how_to_po__page_10_by_ladisilverfox-d84ix4x.jpg","http://pre06.deviantart.net/b853/th/pre/f/2014/301/3/4/how_to_po__page_11_by_ladisilverfox-d84ix56.jpg","http://pre05.deviantart.net/48ee/th/pre/f/2014/301/e/2/how_to_po__page_12_by_ladisilverfox-d84ix5b.jpg","http://pre05.deviantart.net/7811/th/pre/f/2015/075/b/b/how_to_po__page_13_by_ladisilverfox-d8m13ky.jpg","http://pre01.deviantart.net/42c8/th/pre/f/2015/075/b/2/how_to_po__page_14_by_ladisilverfox-d8m12mn.jpg","http://pre11.deviantart.net/ad85/th/pre/f/2015/075/b/9/how_to_po__page_15_by_ladisilverfox-d8m12my.jpg","http://pre03.deviantart.net/a4d3/th/pre/f/2015/075/7/7/how_to_po__page_16_by_ladisilverfox-d8m12n8.jpg","http://pre04.deviantart.net/f7bc/th/pre/f/2015/075/4/f/how_to_po__page_17_by_ladisilverfox-d8m12nc.jpg","http://pre04.deviantart.net/d8d6/th/pre/f/2015/075/1/b/how_to_po__page_18_by_ladisilverfox-d8m12nn.jpg","http://pre03.deviantart.net/1492/th/pre/f/2015/075/9/0/how_to_po__page_19_by_ladisilverfox-d8m12nw.jpg","http://pre04.deviantart.net/ff2a/th/pre/f/2015/075/b/f/how_to_po__page_20_by_ladisilverfox-d8m12o8.jpg","http://pre00.deviantart.net/d0fd/th/pre/f/2015/075/d/0/how_to_po__page_21_by_ladisilverfox-d8m12od.jpg","http://pre05.deviantart.net/990a/th/pre/f/2015/075/1/b/how_to_po__page_22_by_ladisilverfox-d8m12oj.jpg","http://pre12.deviantart.net/6acc/th/pre/f/2015/075/b/b/how_to_po__page_23_by_ladisilverfox-d8m12oo.jpg","http://pre04.deviantart.net/f10b/th/pre/f/2015/075/6/8/how_to_po__page_24_by_ladisilverfox-d8m12ox.jpg","http://pre14.deviantart.net/5c7d/th/pre/f/2015/075/f/a/how_to_po__page_25_by_ladisilverfox-d8m12p0.jpg","http://pre13.deviantart.net/5d92/th/pre/f/2015/075/6/4/how_to_po__page_26_by_ladisilverfox-d8m12p8.jpg","http://pre14.deviantart.net/710a/th/pre/f/2015/099/a/7/how_to_po__page_27_by_ladisilverfox-d8p3ggk.jpg","http://pre04.deviantart.net/d0aa/th/pre/f/2015/099/b/3/how_to_po__page_28_by_ladisilverfox-d8p3gh2.jpg","http://pre14.deviantart.net/aadf/th/pre/f/2015/099/4/e/how_to_po__page_29_by_ladisilverfox-d8p3ghx.jpg","http://pre05.deviantart.net/f0e5/th/pre/f/2015/099/8/8/how_to_po__page_30_by_ladisilverfox-d8p3gi4.jpg","http://pre00.deviantart.net/8eb3/th/pre/f/2015/099/a/1/how_to_po__page_31_by_ladisilverfox-d8p3gic.jpg","http://pre11.deviantart.net/f04a/th/pre/f/2015/099/9/7/how_to_po__page_32_by_ladisilverfox-d8p3gis.jpg","http://pre04.deviantart.net/0e56/th/pre/f/2015/099/3/8/how_to_po__page_33_by_ladisilverfox-d8p3gj6.jpg","http://pre12.deviantart.net/411c/th/pre/f/2015/200/0/1/how_to_po__page_34_by_ladisilverfox-d91zcnc.jpg","http://pre03.deviantart.net/8e5c/th/pre/f/2015/200/1/0/how_to_po__page_35_by_ladisilverfox-d91zcnv.jpg","http://pre02.deviantart.net/086b/th/pre/f/2015/200/0/6/how_to_po__page_36_by_ladisilverfox-d91zco7.jpg","http://pre09.deviantart.net/cf1e/th/pre/f/2015/200/7/7/how_to_po__page_37_by_ladisilverfox-d91zcp6.jpg"]}
Loading

0 comments on commit 03a2eb1

Please sign in to comment.