Under the work of v0.9.7 documentation

pull/41/head
Hieromon Ikasamo 6 years ago
parent 8bf37ed398
commit c53cf7cc90
  1. 4
      mkdocs/acelements.md
  2. 2
      mkdocs/achandling.md
  3. 1
      mkdocs/api.md
  4. 8
      mkdocs/index.md

@ -11,7 +11,7 @@ Representative HTML elements for making the custom Web page are provided as Auto
- [AutoConnectSubmit](#autoconnectsubmit): Submit button - [AutoConnectSubmit](#autoconnectsubmit): Submit button
- [AutoConnectText](#autoconnecttext): Style attributed text - [AutoConnectText](#autoconnecttext): Style attributed text
## Layout on custom Web page ## Layout on a custom Web page
You can specify the direction to arrange the radio buttons as [**AutoConnectRadio**](#autoconnectradio) vertically or horizontally. Other elements are arranged vertically in the order of addition to AutoConnectAux. This basic layout depends on the CSS of the AutoConnect menu so it can not be changed drastically. You can specify the direction to arrange the radio buttons as [**AutoConnectRadio**](#autoconnectradio) vertically or horizontally. Other elements are arranged vertically in the order of addition to AutoConnectAux. This basic layout depends on the CSS of the AutoConnect menu so it can not be changed drastically.
@ -325,7 +325,7 @@ A `style` specifies the qualification style to give to the content and can use t
### <i class="fa fa-edit"></i> Declaration for the elements in Sketches ### <i class="fa fa-edit"></i> Declaration for the elements in Sketches
Variables of each element can be declared with macros. By using the macros, you can treat element name that is String type as variable in sketches.[^2] Variables of each AutoConnetElement can be declared with macros. By using the macros, you can treat element name that is String type as variable in sketches.[^2]
[^2]: The square brackets in the syntax are optional parameters, the stroke is a selection parameter, the bold fonts are literal. [^2]: The square brackets in the syntax are optional parameters, the stroke is a selection parameter, the bold fonts are literal.

@ -468,5 +468,7 @@ The transition of the custom Web page follows the URI of the page, but the ESP82
During the connection attempt, the web browser on the client will send a probe for a captive portal. Its request will cause unintended custom Web page transitions. During the connection attempt, the web browser on the client will send a probe for a captive portal. Its request will cause unintended custom Web page transitions.
- Can not place URI of the custom Web pages to [AUTOCONNECT_URI](https://).
!!! hint "302 Redirect Alternatives" !!! hint "302 Redirect Alternatives"
To transition from a custom Web page to a sketch owned page, execute the link function of JavaScript with the AutoConnectElement element. To transition from a custom Web page to a sketch owned page, execute the link function of JavaScript with the AutoConnectElement element.

@ -279,7 +279,6 @@ Register the handler function for undefined URL request detected.
AutoConenctAux* where(void) AutoConenctAux* where(void)
``` ```
Returns a pointer to the AutoConnectAux object of the custom web page that caused the request to that page. This function is available only for the AutoConnectAux object. It is invalid for HTTP requests from individual pages registered with the **on** handler of ESP8266WebServer/ESP32. In other words, this function only returns the last AutoConnecAux page called. Returns a pointer to the AutoConnectAux object of the custom web page that caused the request to that page. This function is available only for the AutoConnectAux object. It is invalid for HTTP requests from individual pages registered with the **on** handler of ESP8266WebServer/ESP32. In other words, this function only returns the last AutoConnecAux page called.
<dl class="apidl"> <dl class="apidl">
<dt>**Retuen value**</dt> <dt>**Retuen value**</dt>
<dd>A pointer to the AutoConnectAux that caused the request the page.</dd> <dd>A pointer to the AutoConnectAux that caused the request the page.</dd>

@ -89,12 +89,12 @@ To install the PageBuilder library into your Arduino IDE, you can use the *Libra
[^1]:Since AutoConnect v0.9.7, PageBuilder v1.3.0 later is required. [^1]:Since AutoConnect v0.9.7, PageBuilder v1.3.0 later is required.
<i class="fa fa-download"></i> <strong>Optional required library</strong> <i class="fa fa-download"></i> <strong>Another library (optional)</strong>
The [ArduinoJson](https://github.com/bblanchon/ArduinoJson) library is necessary to be able to process the *AutoConnectElement* with JSON description. Since AutoConnect v0.9.7, you can insert user owned screens that can consist of representative HTML elements as the styled TEXT, INPUT, BUTTON, CHECKBOX, SELECT, SUBMIT to the AutoConnect menu. These HTML elements can also be added from user sketches using the AutoConnect API, but they can be easily loaded JSON description stored in PROGMEM, SPIFFS or SD. [ArduinoJson version 5](https://arduinojson.org/v5/doc/) is required to use this function. The [ArduinoJson](https://github.com/bblanchon/ArduinoJson) library is necessary to be able to process the [**custom Web Pages**](acintro.md) with JSON description. Since AutoConnect v0.9.7, you can insert user owned screens that can consist of representative HTML elements as the styled TEXT, INPUT, BUTTON, CHECKBOX, SELECT, SUBMIT to the AutoConnect menu. These HTML elements can be added from the user sketch using the AutoConnect API, and you can also easily import the custom Web page declarations described with JSON which stored in PROGMEM, SPIFFS, or SD. [ArduinoJson version 5](https://arduinojson.org/v5/doc/) is required to use this feature.
!!! info "ArduinoJson version 6 is still in beta" !!! info "AutoConnect supports ArduinoJson version 5 only"
The Arduino Library Manager installs the ArduinoJson version 6 by default. Open the Arduino Library Manager and make sure that ArduinoJson version 5 is installed. And ArduinoJson version 6 is still in beta. The Arduino Library Manager installs the ArduinoJson version 6 by default. Open the Arduino Library Manager and make sure that ArduinoJson version 5 is installed.
### Install the AutoConnect ### Install the AutoConnect

Loading…
Cancel
Save