fix markdown tables for url variables documentation

This commit is contained in:
Andrew Aitken-Fincham 2019-12-19 10:54:45 +00:00
parent eaf6bca706
commit 910f5efbf2

View File

@ -20,55 +20,55 @@ session variables, used templates and much more.
## Templates ## Templates
| URL Variable | | Values | | Description | | URL Variable | Values | Description |
| ------------ | | ------ | | ----------- | | ------------ | ------ | ----------- |
| flush | | 1 | | Clears out all caches. Used mainly during development, e.g. when adding new classes or templates. Requires "dev" mode or ADMIN login | | flush | 1 | Clears out all caches. Used mainly during development, e.g. when adding new classes or templates. Requires "dev" mode or ADMIN login |
| showtemplate | | 1 | | Show the compiled version of all the templates used, including line numbers. Good when you have a syntax error in a template. Cannot be used on a Live site without **isDev**. | | showtemplate | 1 | Show the compiled version of all the templates used, including line numbers. Good when you have a syntax error in a template. Cannot be used on a Live site without **isDev**. |
## General Testing ## General Testing
| URL Variable | | Values | | Description | | URL Variable | Values | Description |
| ------------ | | ------ | | ----------- | | ------------ | ------ | ----------- |
| isDev | | 1 | | Put the site into [development mode](../), enabling debugging messages to the browser on a live server. For security, you'll be asked to log in with an administrator log-in. Will persist for the current browser session. | | isDev | 1 | Put the site into [development mode](../), enabling debugging messages to the browser on a live server. For security, you'll be asked to log in with an administrator log-in. Will persist for the current browser session. |
| isTest | | 1 | | See above. | | isTest | 1 | See above. |
| debug | | 1 | | Show a collection of debugging information about the director / controller operation | | debug | 1 | Show a collection of debugging information about the director / controller operation |
| debug_request | | 1 | | Show all steps of the request from initial [HTTPRequest](api:SilverStripe\Control\HTTPRequest) to [Controller](api:SilverStripe\Control\Controller) to Template Rendering | | debug_request | 1 | Show all steps of the request from initial [HTTPRequest](api:SilverStripe\Control\HTTPRequest) to [Controller](api:SilverStripe\Control\Controller) to Template Rendering |
| execmetric | | 1 | | Display the execution time and peak memory usage for the request | | execmetric | 1 | Display the execution time and peak memory usage for the request |
## Classes and Objects ## Classes and Objects
| URL Variable | | Values | | Description | | URL Variable | Values | Description |
| ------------ | | ------ | | ----------- | | ------------ | ------ | ----------- |
| debugfailover | | 1 | | Shows failover methods from classes extended | | debugfailover | 1 | Shows failover methods from classes extended |
## Database ## Database
| URL Variable | | Values | | Description | | URL Variable | Values | Description |
| ------------ | | --------- | | ----------- | | ------------ | ------------------ | ----------- |
| showqueries | | 1|inline | | List all SQL queries executed, the `inline` option will do a fudge replacement of parameterised queries | | showqueries | 1 | inline | List all SQL queries executed, the `inline` option will do a fudge replacement of parameterised queries |
| showqueries | | 1|backtrace | | List all SQL queries executed, the `backtrace` option will do a fudge replacement of parameterised queries *and* show a backtrace of every query | | showqueries | 1 | backtrace | List all SQL queries executed, the `backtrace` option will do a fudge replacement of parameterised queries *and* show a backtrace of every query |
| previewwrite | | 1 | | List all insert / update SQL queries, and **don't** execute them. Useful for previewing writes to the database. | | previewwrite | 1 | List all insert / update SQL queries, and **don't** execute them. Useful for previewing writes to the database. |
## Security Redirects ## Security Redirects
You can set an URL to redirect back to after a [Security](/developer_guides/security) action. See the section on [URL You can set an URL to redirect back to after a [Security](/developer_guides/security) action. See the section on [URL
Redirections](/developer_guides/controllers/redirection) for more information and examples. Redirections](/developer_guides/controllers/redirection) for more information and examples.
| URL Variable | | Values | | Description | | URL Variable | Values | Description |
| ------------ | | ------ | | ----------- | | ------------ | ------ | ----------- |
| BackURL | | URL | | Set to a relative URL string to use once Security Action is complete | | BackURL | URL | Set to a relative URL string to use once Security Action is complete |
## Building and Publishing URLS ## Building and Publishing URLS
| Site URL | | Action | | Site URL | Action |
| -------- | | ------ | | --------------------------------------------- | ------ |
| http://localhost**/dev/build** | | Rebuild the entire database and manifest, see below for additional URL Variables | | http://localhost**/dev/build** | Rebuild the entire database and manifest, see below for additional URL Variables |
| http://localhost**/admin/pages/publishall/** | | Publish all pages on the site. Only works reliably on smaller sites. | http://localhost**/admin/pages/publishall/** | Publish all pages on the site. Only works reliably on smaller sites. |
### /dev/build ### /dev/build
| URL Variable | | Values | | Description | | URL Variable | Values | Description |
| ------------ | | ------ | | ----------- | | ------------ | ------ | ----------- |
| quiet | | 1 | | Don't show messages during build | | quiet | 1 | Don't show messages during build |
| dont_populate | | 1 | | Don't run **requireDefaultRecords()** on the models when building. This will build the table but not insert any records | | dont_populate | 1 | Don't run **requireDefaultRecords()** on the models when building. This will build the table but not insert any records |