Skip to content

Commit 2d34531

Browse files
lmajanogitbook-bot
authored andcommitted
GitBook: [master] 119 pages and 2 assets modified
1 parent 56e3f70 commit 2d34531

File tree

65 files changed

+145
-182
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+145
-182
lines changed

.gitbook/assets/controllerlayer.jpg

21 KB
Loading
40.7 KB
Loading

SUMMARY.md

+57-58
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Summary
1+
# Table of contents
22

33
* [Introduction](README.md)
44

@@ -20,44 +20,43 @@
2020

2121
## For Newbies
2222

23-
* [60 Minute Quick Start](quick-start/60-minute-quick-start/README.md)
24-
* [Installing ColdBox](quick-start/60-minute-quick-start/installing-coldbox.md)
25-
* [My First ColdBox Application](quick-start/60-minute-quick-start/my-first-coldbox-application.md)
26-
* [My First Handler & View](quick-start/60-minute-quick-start/my-first-handler-and-view.md)
27-
* [Linking Events Together](quick-start/60-minute-quick-start/linking-events-together.md)
28-
* [Working With Event Handlers](quick-start/60-minute-quick-start/working-with-event-handlers.md)
29-
* [Adding A Layout](quick-start/60-minute-quick-start/adding-a-layout.md)
30-
* [Adding A Model](quick-start/60-minute-quick-start/adding-a-model.md)
31-
* [RESTFul Data](quick-start/60-minute-quick-start/restful-data.md)
32-
* [Next Steps](quick-start/60-minute-quick-start/next-steps.md)
23+
* [60 Minute Quick Start](for-newbies/60-minute-quick-start/README.md)
24+
* [Installing ColdBox](for-newbies/60-minute-quick-start/installing-coldbox.md)
25+
* [My First ColdBox Application](for-newbies/60-minute-quick-start/my-first-coldbox-application.md)
26+
* [My First Handler & View](for-newbies/60-minute-quick-start/my-first-handler-and-view.md)
27+
* [Linking Events Together](for-newbies/60-minute-quick-start/linking-events-together.md)
28+
* [Working With Event Handlers](for-newbies/60-minute-quick-start/working-with-event-handlers.md)
29+
* [Adding A Layout](for-newbies/60-minute-quick-start/adding-a-layout.md)
30+
* [Adding A Model](for-newbies/60-minute-quick-start/adding-a-model.md)
31+
* [RESTFul Data](for-newbies/60-minute-quick-start/restful-data.md)
32+
* [Next Steps](for-newbies/60-minute-quick-start/next-steps.md)
3333

3434
## Getting Started
3535

3636
* [Getting Started Guide](getting-started/getting-started-guide.md)
37-
* [Installation](getting-started/overview/README.md)
38-
* [IDE Integration](getting-started/overview/ide-integration.md)
39-
* [Conventions](the-basics/configuration/conventions.md)
40-
* [Configuration](the-basics/configuration/README.md)
41-
* [ColdBox.cfc](the-basics/configuration/coldbox.cfc/README.md)
42-
* [Configuration Directives](the-basics/configuration/coldbox.cfc/configuration-directives/README.md)
43-
* [CacheBox](the-basics/configuration/coldbox.cfc/configuration-directives/cachebox.md)
44-
* [ColdBox](the-basics/configuration/coldbox.cfc/configuration-directives/coldbox.md)
45-
* [Conventions](the-basics/configuration/coldbox.cfc/configuration-directives/conventions.md)
46-
* [Environments](the-basics/configuration/coldbox.cfc/configuration-directives/environments.md)
47-
* [Flash](the-basics/configuration/coldbox.cfc/configuration-directives/flash.md)
48-
* [InterceptorSettings](the-basics/configuration/coldbox.cfc/configuration-directives/interceptorsettings.md)
49-
* [Interceptors](the-basics/configuration/coldbox.cfc/configuration-directives/interceptors.md)
50-
* [Layouts](the-basics/configuration/coldbox.cfc/configuration-directives/layouts.md)
51-
* [LayoutSettings](the-basics/configuration/coldbox.cfc/configuration-directives/layoutsettings.md)
52-
* [LogBox](the-basics/configuration/coldbox.cfc/configuration-directives/logbox.md)
53-
* [Modules](the-basics/configuration/coldbox.cfc/configuration-directives/modules.md)
54-
* [ModuleSettings](the-basics/configuration/coldbox.cfc/configuration-directives/modulesettings.md)
55-
* [Settings](the-basics/configuration/coldbox.cfc/configuration-directives/settings.md)
56-
* [WireBox](the-basics/configuration/coldbox.cfc/configuration-directives/wirebox.md)
57-
* [Configuration Interceptor](the-basics/configuration/coldbox.cfc/configuration-interceptor.md)
58-
* [System Settings \(Java Properties and Environment Variables\)](the-basics/configuration/coldbox.cfc/system-settings-java-properties-and-environment-variables.md)
59-
* [Using Settings](the-basics/configuration/using-settings.md)
60-
* [Bootstrapper](the-basics/configuration/bootstrapper.md)
37+
* [Installation](getting-started/installation.md)
38+
* [Conventions](getting-started/conventions.md)
39+
* [Configuration](getting-started/configuration/README.md)
40+
* [ColdBox.cfc](getting-started/configuration/coldbox.cfc/README.md)
41+
* [Configuration Directives](getting-started/configuration/coldbox.cfc/configuration-directives/README.md)
42+
* [CacheBox](getting-started/configuration/coldbox.cfc/configuration-directives/cachebox.md)
43+
* [ColdBox](getting-started/configuration/coldbox.cfc/configuration-directives/coldbox.md)
44+
* [Conventions](getting-started/configuration/coldbox.cfc/configuration-directives/conventions.md)
45+
* [Environments](getting-started/configuration/coldbox.cfc/configuration-directives/environments.md)
46+
* [Flash](getting-started/configuration/coldbox.cfc/configuration-directives/flash.md)
47+
* [InterceptorSettings](getting-started/configuration/coldbox.cfc/configuration-directives/interceptorsettings.md)
48+
* [Interceptors](getting-started/configuration/coldbox.cfc/configuration-directives/interceptors.md)
49+
* [Layouts](getting-started/configuration/coldbox.cfc/configuration-directives/layouts.md)
50+
* [LayoutSettings](getting-started/configuration/coldbox.cfc/configuration-directives/layoutsettings.md)
51+
* [LogBox](getting-started/configuration/coldbox.cfc/configuration-directives/logbox.md)
52+
* [Modules](getting-started/configuration/coldbox.cfc/configuration-directives/modules.md)
53+
* [ModuleSettings](getting-started/configuration/coldbox.cfc/configuration-directives/modulesettings.md)
54+
* [Settings](getting-started/configuration/coldbox.cfc/configuration-directives/settings.md)
55+
* [WireBox](getting-started/configuration/coldbox.cfc/configuration-directives/wirebox.md)
56+
* [Configuration Interceptor](getting-started/configuration/coldbox.cfc/configuration-interceptor.md)
57+
* [System Settings \(Java Properties and Environment Variables\)](getting-started/configuration/coldbox.cfc/system-settings-java-properties-and-environment-variables.md)
58+
* [Using Settings](getting-started/configuration/using-settings.md)
59+
* [Bootstrapper](getting-started/configuration/bootstrapper.md)
6160

6261
## The Basics
6362

@@ -86,7 +85,7 @@
8685
* [Pathinfo Providers](the-basics/routing/pathinfo-providers.md)
8786
* [Building Routable Links](the-basics/routing/building-routable-links.md)
8887
* [HTML base tag](the-basics/routing/html-base-tag.md)
89-
* [Request Context](the-basics/request-context/README.md)
88+
* [Request Context](the-basics/request-context.md)
9089
* [Event Handlers](the-basics/event-handlers/README.md)
9190
* [Composed Properties](the-basics/event-handlers/composed-properties.md)
9291
* [How are events called?](the-basics/event-handlers/how-are-events-called.md)
@@ -216,10 +215,10 @@
216215

217216
## Testing
218217

219-
* [Testing Quick Start](getting-started/overview/testing-an-application.md)
220-
* [Testing ColdBox Applications](testing/testing/README.md)
221-
* [Test Harness](testing/testing/test-harness.md)
222-
* [ColdBox Testing Classes](testing/testing/coldbox-testing-classes.md)
218+
* [Testing Quick Start](testing/testing-quick-start.md)
219+
* [Testing ColdBox Applications](testing/testing-coldbox-applications/README.md)
220+
* [Test Harness](testing/testing-coldbox-applications/test-harness.md)
221+
* [ColdBox Testing Classes](testing/testing-coldbox-applications/coldbox-testing-classes.md)
223222
* Integration Testing
224223
* Test Annotations
225224
* Common Methods
@@ -232,9 +231,9 @@
232231
* Testing Without Virtual Application
233232
* Rendering Results
234233
* HTTP Method Mocking
235-
* [Interceptor Testing](testing/testing/interceptor-testing.md)
236-
* [Model Object Testing](testing/testing/model-object-testing.md)
237-
* [Tips & Tricks](testing/testing/tips-and-tricks.md)
234+
* [Interceptor Testing](testing/testing-coldbox-applications/interceptor-testing.md)
235+
* [Model Object Testing](testing/testing-coldbox-applications/model-object-testing.md)
236+
* [Tips & Tricks](testing/testing-coldbox-applications/tips-and-tricks.md)
238237

239238
## Digging Deeper
240239

@@ -276,9 +275,9 @@
276275
* [Proxy Events](digging-deeper/coldbox-proxy/proxy-events.md)
277276
* [Standard Return Types](digging-deeper/coldbox-proxy/standard-return-types.md)
278277
* [Caveats & Gotchas](digging-deeper/coldbox-proxy/caveats-and-gotchas.md)
279-
* [Request Context Decorator](the-basics/request-context/request-context-decorator/README.md)
280-
* [For What Can I Use This?](the-basics/request-context/request-context-decorator/for-what-can-i-use-this.md)
281-
* [Configuration](the-basics/request-context/request-context-decorator/configuration.md)
278+
* [Request Context Decorator](digging-deeper/request-context-decorator/README.md)
279+
* [For What Can I Use This?](digging-deeper/request-context-decorator/for-what-can-i-use-this.md)
280+
* [Configuration](digging-deeper/request-context-decorator/configuration.md)
282281
* [Recipes](digging-deeper/recipes/README.md)
283282
* [Building REST APIs](digging-deeper/recipes/building-rest-apis.md)
284283
* [Application Templates](digging-deeper/recipes/application-templates.md)
@@ -290,16 +289,16 @@
290289

291290
## Architecture Concepts
292291

293-
* [What is MVC](getting-started/overview/what-is-mvc.md)
294-
* [What is ColdBox](getting-started/overview/what-is-coldbox.md)
295-
* [How ColdBox Works](getting-started/overview/how-coldbox-works.md)
296-
* [Testing Concepts](testing/testing/testing-concepts/README.md)
297-
* [Functional Testing](testing/testing/testing-concepts/functional-testing.md)
298-
* [Non-Functional Testing](testing/testing/testing-concepts/non-functional-testing.md)
299-
* [Bugs Cost Money](testing/testing/testing-concepts/bugs-cost-money.md)
300-
* [Static Testing](testing/testing/testing-concepts/static-testing.md)
301-
* [Dynamic Testing](testing/testing/testing-concepts/dynamic-testing.md)
302-
* [Developer Focus](testing/testing/testing-concepts/developer-focus.md)
303-
* [Testing Vocabulary](testing/testing/testing-concepts/testing-vocabulary.md)
304-
* [Testing Tools](testing/testing/testing-concepts/testing-tools.md)
292+
* [What is MVC](architecture-concepts/what-is-mvc.md)
293+
* [What is ColdBox](architecture-concepts/what-is-coldbox.md)
294+
* [How ColdBox Works](architecture-concepts/how-coldbox-works.md)
295+
* [Testing Concepts](architecture-concepts/testing-concepts/README.md)
296+
* [Functional Testing](architecture-concepts/testing-concepts/functional-testing.md)
297+
* [Non-Functional Testing](architecture-concepts/testing-concepts/non-functional-testing.md)
298+
* [Bugs Cost Money](architecture-concepts/testing-concepts/bugs-cost-money.md)
299+
* [Static Testing](architecture-concepts/testing-concepts/static-testing.md)
300+
* [Dynamic Testing](architecture-concepts/testing-concepts/dynamic-testing.md)
301+
* [Developer Focus](architecture-concepts/testing-concepts/developer-focus.md)
302+
* [Testing Vocabulary](architecture-concepts/testing-concepts/testing-vocabulary.md)
303+
* [Testing Tools](architecture-concepts/testing-concepts/testing-tools.md)
305304

getting-started/overview/how-coldbox-works.md architecture-concepts/how-coldbox-works.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Below you can see the full life-cycle for MVC requests:
3939

4040
### Proxy Lifecycle
4141

42-
ColdBox also has a proxy feature for building SOAP webservices or Flex/Air integration called [ColdBox Proxy](../../digging-deeper/coldbox-proxy/). Below you can see the life-cycle for that process:
42+
ColdBox also has a proxy feature for building SOAP webservices or Flex/Air integration called [ColdBox Proxy](../digging-deeper/coldbox-proxy/). Below you can see the life-cycle for that process:
4343

4444
![](https://github.com/ortus/coldbox-platform-documentation/tree/24d3f3d16693b36ca41bf5ce0329c6ff33316ef0/images/ColdBoxLifecyclesProxy.jpg)
4545

File renamed without changes.
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Core Interception Points
22

3-
There are many interception points that occur during an MVC and Remote life cycle in a ColdBox application. We highly encourage you to follow our flow diagrams in our [ColdBox Overview](../../../getting-started/overview/) section so you can see where in the life cycle these events fire. Also remember that each event can pass a data structure that can be used in your application.
3+
There are many interception points that occur during an MVC and Remote life cycle in a ColdBox application. We highly encourage you to follow our flow diagrams in our [ColdBox Overview]() section so you can see where in the life cycle these events fire. Also remember that each event can pass a data structure that can be used in your application.
44

quick-start/60-minute-quick-start/adding-a-layout.md for-newbies/60-minute-quick-start/adding-a-layout.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Adding A Layout
22

3-
Every time the framework renders a view, it will try to leverage the default layout which is located in `layouts/Main.cfm` by convention. This is an HTML file that gives format to your output and contains the location of where the view you want should be rendered.
3+
Every time the framework renders a view, it will try to leverage the default layout which is located in `layouts/Main.cfm` by convention. This is an HTML file that gives format to your output and contains the location of where the view you want should be rendered.
44

55
## Layout Code
66

@@ -61,7 +61,7 @@ Go execute the event now: `http://localhost:{port}/hello/index` and you will see
6161
{% hint style="info" %}
6262
You can also leverage the function `event.setLayout( "Funky" )` to change layouts and even concatenate the calls:
6363

64-
`event.setView( "hello/index" )
65-
.setLayout( "Funky" );`
64+
`event.setView( "hello/index" )
65+
.setLayout( "Funky" );`
6666
{% endhint %}
6767

quick-start/60-minute-quick-start/linking-events-together.md for-newbies/60-minute-quick-start/linking-events-together.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ColdBox provides you with a nice method for generating links between events by l
88

99
## Building Links
1010

11-
The method in the request context that builds links is called: `buildLink()`. Here are some of the arguments you can use:
11+
The method in the request context that builds links is called: `buildLink()`. Here are some of the arguments you can use:
1212

1313
```java
1414
/**
@@ -21,11 +21,11 @@ The method in the request context that builds links is called: `buildLink()`. H
2121
* @queryString The query string to append
2222
*/
2323
string function buildLink(
24-
to,
25-
boolean translate=true,
26-
boolean ssl,
27-
baseURL="",
28-
queryString="");
24+
to,
25+
boolean translate=true,
26+
boolean ssl,
27+
baseURL="",
28+
queryString="");
2929
```
3030

3131
## Edit Your View
@@ -48,17 +48,17 @@ This code will generate a link to the `main.index` event in a search engine safe
4848
```
4949

5050
{% hint style="success" %}
51-
**Tip** You can visit our API Docs for further information about the `event` object and the `buildLink` method: [http://apidocs.ortussolutions.com/coldbox/current/index.html?coldbox/system/web/context/RequestContext.html](http://apidocs.ortussolutions.com/coldbox/current/index.html?coldbox/system/web/context/RequestContext.html).
51+
**Tip** You can visit our API Docs for further information about the `event` object and the `buildLink` method: [http://apidocs.ortussolutions.com/coldbox/current/index.html?coldbox/system/web/context/RequestContext.html](http://apidocs.ortussolutions.com/coldbox/current/index.html?coldbox/system/web/context/RequestContext.html).
5252

5353
For extra credit try to use more of the `buildLink` arguments.
5454
{% endhint %}
5555

5656
## URL Structure & Mappings
5757

58-
ColdBox allows you to manipulate the incoming URL so you can create robust URL strategies especially for RESTFul services. This is all done by convention and you can configure it via the application router: `config/Router.cfc` for more granular control.
58+
ColdBox allows you to manipulate the incoming URL so you can create robust URL strategies especially for RESTFul services. This is all done by convention and you can configure it via the application router: `config/Router.cfc` for more granular control.
5959

6060
{% hint style="info" %}
61-
Out of the box we provide you with convention based routing that maps the URL to modules/folders/handlers and actions.
61+
Out of the box we provide you with convention based routing that maps the URL to modules/folders/handlers and actions.
6262

6363
`route( "/:handler/:action" ).end()`
6464
{% endhint %}

quick-start/60-minute-quick-start/my-first-coldbox-application.md for-newbies/60-minute-quick-start/my-first-coldbox-application.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
CommandBox comes with a `coldbox create app` command that can enable you to create application skeletons using one of our official skeletons or [your own](../../digging-deeper/recipes/application-templates.md):
44

55
* **Advanced** : A tag based advanced template
6-
* **AdvancedScript** \(_`default`_\): A script based advanced template
6+
* **AdvancedScript** \(`default`\): A script based advanced template
77
* **elixir** : A ColdBox Elixir based template
88
* **ElixirBower** : A ColdBox Elixir + Bower based template
99
* **ElixirVueJS** : A ColdBox Elixir + Vue.js based template
@@ -71,7 +71,7 @@ That's it, you have just created your first application. Hooray, onward!
7171

7272
## File/Folder Conventions
7373

74-
ColdBox is a conventions based framework. The location of files and functions matter. Since we scaffolded our first application, let's write down in a table below with the different conventions that exist in ColdBox.
74+
ColdBox is a conventions based framework. The location of files and functions matter. Since we scaffolded our first application, let's write down in a table below with the different conventions that exist in ColdBox.
7575

7676
| **File/Folder Convention** | **Mandatory** | **Description** |
7777
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
@@ -85,12 +85,12 @@ ColdBox is a conventions based framework. The location of files and functions m
8585
| `views` | false | Views |
8686

8787
{% hint style="info" %}
88-
What is the common denominator in all the conventions? That they are all optional.
88+
What is the common denominator in all the conventions? That they are all optional.
8989
{% endhint %}
9090

9191
## Re-initializing The Application
9292

93-
There will be times when you make configuration or code changes that are not reflected immediately in the application due to caching. You can tell the framework to _reinit _or restart the application for you via the URL by leveraging the special URL variable `fwreinit`.
93+
There will be times when you make configuration or code changes that are not reflected immediately in the application due to caching. You can tell the framework to \_reinit \_or restart the application for you via the URL by leveraging the special URL variable `fwreinit`.
9494

9595
```text
9696
http://localhost:{port}/?fwreinit=1
@@ -103,8 +103,6 @@ coldbox reinit
103103
```
104104

105105
{% hint style="success" %}
106-
**Tip:** You can add a password to the **reinit **procedures for further security, please see the [configuration section](../../the-basics/configuration/coldbox.cfc/).
106+
**Tip:** You can add a password to the **reinit **procedures for further security, please see the [configuration section](https://github.com/ortus-docs/coldbox-docs/tree/7a8d2250f812e1b65cfc9c2888a8489110724897/the-basics/configuration/coldbox.cfc).
107107
{% endhint %}
108108

109-
110-

0 commit comments

Comments
 (0)