Add introduction files to each of the sections

This commit is contained in:
Will Rossiter 2014-09-21 12:07:58 +12:00 committed by Cam Findlay
parent effefd5199
commit a506dfd42a
39 changed files with 396 additions and 417 deletions

View File

@ -1,8 +1,8 @@
# Requirements # Requirements
SilverStripe CMS needs to be installed on a web server. Content authors and website administrators use their web browser to access a web-based GUI to SilverStripe CMS needs to be installed on a web server. Content authors and website administrators use their web browser
do their day-to-day work. Website designers and developers require access to the files on the server to update templates, to access a web-based GUI to do their day-to-day work. Website designers and developers require access to the files on
website logic, and perform upgrades or maintainance. the server to update templates, website logic, and perform upgrades or maintenance.
Our web-based [PHP installer](/installation) can check if you meet the requirements listed below. Our web-based [PHP installer](/installation) can check if you meet the requirements listed below.
@ -36,14 +36,26 @@ Our web-based [PHP installer](/installation) can check if you meet the requireme
## Web server hardware requirements ## Web server hardware requirements
Hardware requirements vary widely depending on the traffic to your website, the complexity of its logic (i.e., PHP), and its size (i.e., database.) By default, all pages are dynamic, and thus access both the database and execute PHP code to generate. SilverStripe can cache full pages and segments of templates to dramatically increase performance. Hardware requirements vary widely depending on the traffic to your website, the complexity of its logic (i.e., PHP), and
its size (i.e., database.) By default, all pages are dynamic, and thus access both the database and execute PHP code to
generate. SilverStripe can cache full pages and segments of templates to dramatically increase performance.
A typical website page on a conservative single CPU machine (e.g., Intel 2Ghz) takes roughly 300ms to generate. This comfortably allows over a million page views per month. Caching and other optimisations can improve this by a factor of ten or even one hundred times. SilverStripe CMS can be used in multiple-server architectures to improve scalability and redundancy. A typical website page on a conservative single CPU machine (e.g., Intel 2Ghz) takes roughly 300ms to generate. This
comfortably allows over a million page views per month. Caching and other optimisations can improve this by a factor of
ten or even one hundred times. SilverStripe CMS can be used in multiple-server architectures to improve scalability and
redundancy.
For more information on how to scale SilverStripe see the [Performance](../../developer_guides/performance/) Gluide.
## Client side (CMS) requirements ## Client side (CMS) requirements
SilverStripe CMS is designed to work well with Google Chrome, Mozilla Firefox and Internet Explorer 8+. We aim to provide satisfactory experiences in Apple Safari. SilverStripe CMS works well across Windows, Linux, and Mac operating systems. SilverStripe CMS is designed to work well with Google Chrome, Mozilla Firefox and Internet Explorer 8+. We aim to
provide satisfactory experiences in Apple Safari. SilverStripe CMS works well across Windows, Linux, and Mac operating
systems.
## End user requirements ## ## End user requirements
SilverStripe CMS is designed to make excellent, standards-compliant websites that are compatible with a wide range of industry standard browsers and operating systems. A competent developer is able to produce websites that meet W3C guidelines for HTML, CSS, JavaScript, and accessibility, in addition to meeting specific guildelines, such as e-government requirements. SilverStripe CMS is designed to make excellent, standards-compliant websites that are compatible with a wide range of
industry standard browsers and operating systems. A competent developer is able to produce websites that meet W3C
guidelines for HTML, CSS, JavaScript, and accessibility, in addition to meeting specific guildelines, such as
e-government requirements.

View File

@ -1,15 +1,8 @@
# Installing SilverStripe title: Getting Started
introduction: SilverStripe is a web application. This means that you will need to have a webserver and database. We will take you through the setup of the server environment as well the application itself.
## Download
SilverStripe is a web application. This means that you will need to have a webserver and database meeting its ## Installing SilverStripe
[requirements](server-requirements). We will take you through the setup of the server environment as well the application itself.
<div markdown='1' style="float: right; margin-left: 20px">
![](../_images/composer.png)
</div>
## Getting the code
The best way to get SilverStripe is to [install with Composer](composer). Composer is a package management tool for PHP that The best way to get SilverStripe is to [install with Composer](composer). Composer is a package management tool for PHP that
lets you install and upgrade SilverStripe and its modules. Although installing Composer is one extra step, it will give you much more flexibility than just downloading the file from silverstripe.org. lets you install and upgrade SilverStripe and its modules. Although installing Composer is one extra step, it will give you much more flexibility than just downloading the file from silverstripe.org.

View File

@ -1,4 +1,7 @@
# Written Tutorials title: Tutorials
introduction: The tutorials below take a step by step look at how to build a SilverStripe application.
## Written Tutorials
* [Tutorial 1: Building a basic site](1-building-a-basic-site): An introduction to building a site with * [Tutorial 1: Building a basic site](1-building-a-basic-site): An introduction to building a site with
SilverStripe. SilverStripe.
@ -9,14 +12,14 @@ site".
* [Tutorial 5: Dataobject Relationship Management](5-dataobject-relationship-management): Learn how to create * [Tutorial 5: Dataobject Relationship Management](5-dataobject-relationship-management): Learn how to create
simple data relationships. simple data relationships.
# Video tutorials ## Video tutorials
* [Installing on Linux](http://silverstripe.org/assets/screencasts/Tutorial-InstallingLinux-DM08.swf) * [Installing on Linux](http://silverstripe.org/assets/screencasts/Tutorial-InstallingLinux-DM08.swf)
* [Installing on Mac OSX (using MAMP)](http://silverstripe.org/assets/screencasts/Tutorial-InstallingMAMP-SW08.swf) * [Installing on Mac OSX (using MAMP)](http://silverstripe.org/assets/screencasts/Tutorial-InstallingMAMP-SW08.swf)
* [Installing a module (e.g. a blog)](http://silverstripe.org/assets/screencasts/Tutorial-InstallingBlogModule-DM08.swf) * [Installing a module (e.g. a blog)](http://silverstripe.org/assets/screencasts/Tutorial-InstallingBlogModule-DM08.swf)
* [Customising the CMS (adding new fields)](http://silverstripe.org/assets/screencasts/Tutorial-ChangingFields-DM08.swf) * [Customising the CMS (adding new fields)](http://silverstripe.org/assets/screencasts/Tutorial-ChangingFields-DM08.swf)
# Help: If you get stuck ## Help: If you get stuck
* [Common Problems](/installation/common-problems): Review some existing solutions to common problems. * [Common Problems](/installation/common-problems): Review some existing solutions to common problems.
* [SilverStripe Forums](http://www.silverstripe.com/silverstripe-forum/): Head over to the forums and ask the community * [SilverStripe Forums](http://www.silverstripe.com/silverstripe-forum/): Head over to the forums and ask the community

View File

@ -0,0 +1,8 @@
title: Model and Databases
summary: Learn how SilverStripe manages database tables, ways to query your database and how to publish data.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -298,7 +298,7 @@ request](http://docs.jquery.com/Frequently_Asked_Questions#Why_do_my_events_stop
### Assume Element Collections ### Assume Element Collections
jQuery is based around collections of DOM elements, the library functions typically handle multiple elements (where it jQuery is based around collections of DOM elements, the library functions typically handle multiple elements (where it
makes sense). Encapsulate your code by nesting your jQuery commands inside a `jQuery().each()` call. Example: makes sense). Encapsulate your code by nesting your jQuery commands inside a `jQuery().each()` call.
:::js :::js
$('.MyCustomField').each(function() { $('.MyCustomField').each(function() {
@ -415,7 +415,7 @@ HTML
:::ss :::ss
<form action"#"> <form action"#">
<div class="autocomplete {url:'my-controller-route/autocomplete'}"> <div class="autocomplete {url:'MyController/autocomplete'}">
<input type="text" name="title" /> <input type="text" name="title" />
<div class="results" style="display: none;"> <div class="results" style="display: none;">
</div> </div>

View File

@ -9,13 +9,13 @@ located in `themes/<mytheme>/templates/Page.ss`.
:::ss :::ss
<ul> <ul>
<% loop $Menu(1) %> <% loop $Menu(1) %>
<li> <li>
<a href="$Link" title="Go to the $Title page" class="$LinkingMode"> <a href="$Link" title="Go to the $Title page" class="$LinkingMode">
<span>$MenuTitle</span> <span>$MenuTitle</span>
</a> </a>
</li> </li>
<% end_loop %> <% end_loop %>
</ul> </ul>
More details on creating a menu are explained as part of ["Tutorial 1: Building a basic site"](/tutorials/1-building-a-basic-site), as well as ["Page type templates" topic](/topics/page-type-templates). More details on creating a menu are explained as part of ["Tutorial 1: Building a basic site"](/tutorials/1-building-a-basic-site), as well as ["Page type templates" topic](/topics/page-type-templates).

View File

@ -0,0 +1,8 @@
title: Templates and Views
summary: This guide showcases the SilverStripe template engine and learn how to build your own themes.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -0,0 +1,8 @@
title: Controllers
summary: Controllers form the backbone of your SilverStripe application. They handle routing URLs to your templates.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -0,0 +1,8 @@
title: Forms
summary: Capture user information through Forms. This guide will work through making forms, custom form fields and adding fields to your data.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -0,0 +1,8 @@
title: Configuration
summary: SilverStripe provides several ways to store and modify your application settings. Learn about site wide settings and the YAML based configuration system.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -0,0 +1,8 @@
title: Extending SilverStripe
summary: Understand the ways to modify the built-in functionality through Extensions, Subclassing and Dependency Injection.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -1,3 +1,5 @@
summary: Deploy robust applications by bundling Unit and Behavior tests with your application code and modules.
# Unit and Integration Testing # Unit and Integration Testing
For behaviour testing in SilverStripe, check out [SilverStripe Behat Documentation](https://github.com/silverstripe-labs/silverstripe-behat-extension/). For behaviour testing in SilverStripe, check out [SilverStripe Behat Documentation](https://github.com/silverstripe-labs/silverstripe-behat-extension/).

View File

@ -1,3 +1,5 @@
summary: Learn how to identify errors in your application and best practice for logging application errors.
# Debugging # Debugging
## Environment Types ## Environment Types

View File

@ -0,0 +1,8 @@
title: Performance
summary: Make your applications faster by learning how to write more scalable code and ways to cache your important information.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -0,0 +1,7 @@
summary: This guide covers user authentication, the permission system and how to secure your code against malicious behaviors
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -1,3 +1,5 @@
summary: Send HTML and plain text email from your SilverStripe application.
# Email # Email
SilverStripe has emailing functionality using the built-in mail() function in PHP. SilverStripe has emailing functionality using the built-in mail() function in PHP.

View File

@ -119,11 +119,11 @@ could delgate the error handling to it's descendant class. To handle the errors
// This will raise Youtube API specific error messages (if any). // This will raise Youtube API specific error messages (if any).
public function errorCatch($response){ public function errorCatch($response){
$err_msg = $response; $err_msg = $response;
if(strpos($err_msg, '<') === false) { if(strpos($err_msg, '<') === false) {
user_error("YouTube Service Error : $err_msg", E_USER_ERROR); user_error("YouTube Service Error : $err_msg", E_USER_ERROR);
} }
return $response; return $response;
} }

View File

@ -0,0 +1,7 @@
summary: Integrate other web services within your application or make your SilverStripe data available via REST.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -1,3 +1,5 @@
summary: Provide your users with advanced search functionality.
# Search # Search
## Searching for Pages (and Files) ## Searching for Pages (and Files)

View File

@ -1,3 +1,5 @@
summary: Display templates and PHP code in different languages based on the preferences of your website users.
# i18n # i18n
## Introduction ## Introduction

View File

@ -1,3 +1,5 @@
summary: Learn how to deal with File and Image records
# Files, Images and Folders # Files, Images and Folders
## Files, Images and Folders as database records ## Files, Images and Folders as database records

View File

@ -0,0 +1,7 @@
summary: Extend the admin view to provide custom behavior or new features for CMS users.
[CHILDREN]
## How-to
[CHILDREN How_To]

View File

@ -1,3 +1,5 @@
summary: An overview of the steps involved in delivering a SilverStripe web page.
# Execution Pipeline # Execution Pipeline
## Introduction ## Introduction

View File

@ -1,4 +1,6 @@
# Commandline Usage via "sake" summary: Automate SilverStripe, run cronjobs or sync with other platforms through the sake Command Line Interface.
# Command line usage
## Introduction ## Introduction

View File

@ -1,8 +1,7 @@
#Developer Guides title: Developer Guides
A collection of more advanced functionality and features contained within the SilverStripe Framework. This covers common use cases, provides code examples and explanations of how you might use parts of the Framework and CMS to suit your projects. introduction: The following guides take a more detailed look into the core concepts and code examples for building SilverStripe applications.
This is by no means a completely exhaustive list of Classes and Methods but rather more of a descriptive book style format with examples. In each guide you'll find reference documentation followed by a collection of short and informal How-to's which contain
snippets of code to use in your own projects.
Each key section will also contain a "How To" section into which we accept community contributed code examples and more specific use cases. [CHILDREN]
TODO - A table of contents including any missing stub pages.

View File

@ -0,0 +1,4 @@
title: Upgrading
introduction: Keep your SilverStripe installations up to date with the latest fixes, security patches and new features.
# Upgrading

View File

@ -1,134 +1,11 @@
# Changelogs title: Changelogs
introduction: Key information on new features and improvements in each version.
Keep up to date with new releases subscribe to the [SilverStripe Release Announcements](https://groups.google.com/group/silverstripe-announce) group, Keep up to date with new releases subscribe to the [SilverStripe Release Announcements](https://groups.google.com/group/silverstripe-announce) group,
or read our [blog posts about releases](http://silverstripe.org/blog/tag/release). or read our [blog posts about releases](http://silverstripe.org/blog/tag/release).
We also keep an overview of [security-related releases](http://silverstripe.org/security-releases/). We also keep an overview of [security-related releases](http://silverstripe.org/security-releases/).
For information on how to upgrade to newer versions consult the [upgrading](/installation/upgrading) guide. For information on how to upgrade to newer versions consult the [upgrading](/upgrading) guide.
## Stable Releases [CHILDREN]
* [3.2.0](3.2.0) - Unreleased
* [3.1.8](3.1.8) - 18 November 2014
* [3.1.7](3.1.7) - 14 November 2014
* [3.1.6](3.1.6) - 25 August 2014
* [3.1.5](3.1.5) - 13 May 2014
* [3.1.4](3.1.4) - 8 April 2014
* [3.1.0](3.1.0) - 1 October 2013
* [3.0.11](3.0.11) - 13 May 2014
* [3.0.10](3.0.10) - 8 April 2014
* [3.0.5](3.0.5) - 20 February 2013
* [3.0.4](3.0.4) - 19 February 2013
* [3.0.3](3.0.3) - 26 November 2012
* [3.0.2](3.0.2) - 17 September 2012
* [3.0.1](3.0.1) - 31 July 2012
* [3.0.0](3.0.0) - 28 June 2012
* [2.4.7](2.4.7) - 1 February 2012
* [2.4.6](2.4.6) - 18 October 2011
* [2.4.10](2.4.10) - 2013-02-19
* [2.4.9](2.4.9) - 2012-12-04
* [2.4.8](2.4.8) - 2012-10-30
* [2.4.7](2.4.7) - 2012-02-01
* [2.4.6](2.4.6) - 2011-10-17
* [2.4.5](2.4.5) - 2 February 2011
* [2.4.4](2.4.4) - 21 December 2010
* [2.4.3](2.4.3) - 11 November 2010
* [2.4.2](2.4.2) - 22 September 2010
* [2.4.1](2.4.1) - 23 July 2010
* [2.4.0](2.4.0)
* [2.3.13](2.3.13) - 1 February 2012
* [2.3.12](2.3.12) - 17 October 2011
* [2.3.11](2.3.11) - 2 February 2011
* [2.3.10](2.3.10) - 21 December 2010
* [2.3.9](2.3.9) - 11 November 2010
* [2.3.8](2.3.8) - 23 July 2010
* [2.3.7](2.3.7) - 18 March 2010
* [2.3.6](2.3.6) - 8 February 2010
* [2.3.5](2.3.5) - 21 January 2010
* [2.3.4](2.3.4) - 27 November 2009
* [2.3.3](2.3.3) - 3 August 2009
* [2.3.2](2.3.2) - 18 June 2009
* [2.3.1](2.3.1) - 19 March 2009
* [2.3.0](2.3.0) - 23 February 2009
* [2.2.4](2.2.4) - 20 March 2009
* [2.2.3](2.2.3) - ~31 October 2008
* [2.2.2](2.2.2) - 22 May 2008
* [2.2.1](2.2.1) - 21 December 2007
* [2.2.0](2.2.0) - 28 November 2007
* [2.1.1](2.1.1) - 2 November 2007
* [2.1.0](2.1.0) - 2 October 2007
* [2.0.2](2.0.2) - 14 July 2007
* [2.0.1](2.0.1) - 17 April 2007
* 2.0.0 - 3 February 2007 (initial release)
## Alpha/beta/release candidate
* [3.1.7-rc1](rc/3.1.7-rc1) - 8 November 2014
* [3.1.6-rc3](rc/3.1.6-rc3) - 18 August 2014
* [3.1.6-rc2](rc/3.1.6-rc2) - 12 August 2014
* [3.1.6-rc1](rc/3.1.6-rc1) - 5 August 2014
* [3.1.5-rc1](rc/3.1.5-rc1) - 7 May 2014
* [3.1.4-rc1](rc/3.1.4-rc1) - 1 April 2014
* [3.0.11-rc1](rc/3.0.11-rc1) - 7 May 2014
* [3.0.10-rc1](rc/3.0.10-rc1) - 1 April 2014
* [3.0.6-rc1](rc/3.0.6-rc1) - 2013-08-08
* [3.0.3-rc1](rc/3.0.3-rc1) - 6 November 2012
* [3.0.2-rc2](rc/3.0.2-rc2) - 12 September 2012
* [3.0.2-rc1](rc/3.0.2-rc1) - 5 September 2012
* [3.0.0-rc3](rc/3.0.0-rc3) - 27 June 2012
* [3.0.0-rc2](rc/3.0.0-rc2) - 26 June 2012
* [3.0.0-rc1](rc/3.0.0-rc1) - 18 June 2012
* [3.0.0-beta3](beta/3.0.0-beta3) - 28 May 2012
* [3.0.0-beta2](beta/3.0.0-beta2) - 20 April 2012
* [3.0.0-beta1](beta/3.0.0-beta1) - 12 March 2012
* [3.0.0-alpha2](alpha/3.0.0-alpha2) - 12 January 2012
* [3.0.0-alpha1](alpha/3.0.0-alpha1) - 1 November 2011
* [3.0.0-pr1](pr/3.0.0-pr1) - 2 May 2011
* [2.4.5-rc1](rc/2.4.5-rc1) - 31 January 2011
* [2.4.4-rc2](rc/2.4.4-rc2) - 20 December 2010
* [2.4.4-rc1](rc/2.4.4-rc1) - 10 December 2010
* [2.4.3-rc2](rc/2.4.3-rc2) - 4 November 2010
* [2.4.3-rc1](rc/2.4.3-rc1) - 1 November 2010
* [2.4.2-rc2](rc/2.4.2-rc2) - 20 September 2010
* [2.4.2-rc1](rc/2.4.2-rc1) - 16 September 2010
* [2.4.1-rc2](rc/2.4.1-rc2) - 21 July 2010
* [2.4.1-rc1](rc/2.4.1-rc1) - 16 July 2010
* [2.4.0-rc3](rc/2.4.0-rc3) - 4 May 2010
* [2.4.0-rc2](rc/2.4.0-rc2) - 30 April 2010
* [2.4.0-rc1](rc/2.4.0-rc1) - 1st April 2010
* [2.4.0-beta2](beta/2.4.0-beta2) - 17 March 2010
* [2.4.0-beta1](beta/2.4.0-beta1) - 29 January 2010
* [2.4.0-alpha1](alpha/2.4.0-alpha1) - 11 November 2009
* [2.3.11-rc1](rc/2.3.11-rc1) - 31 January 2011
* [2.3.10-rc2](rc/2.3.10-rc2) - 20 December 2010
* [2.3.10-rc1](rc/2.3.10-rc1) - 10 December 2010
* [2.3.9-rc2](rc/2.3.9-rc2) - 4 November 2010
* [2.3.9-rc1](rc/2.3.9-rc1) - 1 November 2010
* [2.3.8-rc1](rc/2.3.8-rc1) - 16 July 2010

View File

@ -1,7 +1,5 @@
# Contributing Issues and Opinions # Contributing Issues and Opinions
[« Back to Contributing page](../contributing)
## Reporting Bugs ## Reporting Bugs
If you have discovered a bug in SilverStripe, we'd be glad to hear about it - If you have discovered a bug in SilverStripe, we'd be glad to hear about it -

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB