tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-09-27 20:06:52 +02:00
Code Issues Projects Releases Wiki Activity

DOCS - fix reported broken links by zippy in IRC

Browse Source
This commit is contained in:
Cam Findlay 2015-01-14 08:59:55 +13:00
parent cf9c6666dd
commit 3239cfd495
3 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/00_Getting_Started/00_Server_Requirements.md
View File

@ -45,7 +45,7 @@ comfortably allows over a million page views per month. Caching and other optimi
ten or even one hundred times. SilverStripe CMS can be used in multiple-server architectures to improve scalability and ten or even one hundred times. SilverStripe CMS can be used in multiple-server architectures to improve scalability and
redundancy. redundancy.
For more information on how to scale SilverStripe see the [Performance](../../developer_guides/performance/) Gluide. For more information on how to scale SilverStripe see the [Performance](/developer_guides/performance/) Guide.
## Client side (CMS) requirements ## Client side (CMS) requirements
@ -57,5 +57,5 @@ systems.
SilverStripe CMS is designed to make excellent, standards-compliant websites that are compatible with a wide range of 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 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 guidelines for HTML, CSS, JavaScript, and accessibility, in addition to meeting specific guide lines, such as
e-government requirements. e-government requirements.

16
docs/en/00_Getting_Started/04_Directory_Structure.md
View File

@ -10,8 +10,8 @@ directories is meaningful to its logic.
Directory | Description Directory | Description
--------- | ----------- --------- | -----------
`assets/` | Contains images and other files uploaded via the SilverStripe CMS. You can also place your own content inside it, and link to it from within the content area of the CMS. `assets/` | Contains images and other files uploaded via the SilverStripe CMS. You can also place your own content inside it, and link to it from within the content area of the CMS.
`cms/` | Contains all the files that form the CMS area of your site. It’s structure is similiar to the mysite/ directory, so if you find something interesting, it should be easy enough to look inside and see how it was built. `cms/` | Contains all the files that form the CMS area of your site. It’s structure is similar to the mysite/ directory, so if you find something interesting, it should be easy enough to look inside and see how it was built.
`framework/` | The framework that builds both your own site and as the CMS that powers it. You’ll be utilizing files in this directory often, both directly and indirectly. `framework/` | The framework that builds both your own site and as the CMS that powers it. You’ll be utilising files in this directory often, both directly and indirectly.
## Custom Code Structure ## Custom Code Structure
@ -23,7 +23,7 @@ existing modules or the directories lists in "Core Structure".
| `<mysite>/` | This directory contains all of your code that defines your website. | | `<mysite>/` | This directory contains all of your code that defines your website. |
| `<mysite>/_config` | YAML configuration specific to your application | | `<mysite>/_config` | YAML configuration specific to your application |
| `<mysite>/code` | PHP code for model and controller (subdirectories are optional) | | `<mysite>/code` | PHP code for model and controller (subdirectories are optional) |
| `<mysite>/templates` | HTML [templates](templates) with *.ss-extension | | `<mysite>/templates` | HTML [templates](/developer_guides/templates) with *.ss-extension |
| `<mysite>/css ` | CSS files | | `<mysite>/css ` | CSS files |
| `<mysite>/images ` | Images used in the HTML templates | | `<mysite>/images ` | Images used in the HTML templates |
| `<mysite>/javascript` | Javascript and other script files | `<mysite>/javascript` | Javascript and other script files
@ -35,7 +35,7 @@ existing modules or the directories lists in "Core Structure".
| `themes/yourtheme/` | The themes folder can contain more than one theme - here's your own | | `themes/yourtheme/` | The themes folder can contain more than one theme - here's your own |
See [themes](/topics/themes) See [themes](/developer_guides/templates/themes)
## Module Structure {#module_structure} ## Module Structure {#module_structure}
@ -56,13 +56,13 @@ Example Forum:
Module developers can bundle developer documentation with their code by producing Module developers can bundle developer documentation with their code by producing
plain text files inside a 'docs' folder located in the module folder. These files plain text files inside a 'docs' folder located in the module folder. These files
can be written with the Markdown syntax (See [Contributing Documentation](/misc/contributing/documentation)) can be written with the Markdown syntax (See [Contributing Documentation](/contributing/documentation))
and include media such as images or videos. and include media such as images or videos.
Inside the docs folder, developers should organize the markdown files into each Inside the docs folder, developers should organise the markdown files into each
separate language they wish to write documentation for (usually just `en`). Inside separate language they wish to write documentation for (usually just `en`). Inside
each languages' subfolder, developers then have freedom to create whatever structure each languages' subfolder, developers then have freedom to create whatever structure
they wish for organizing the documentation they wish. they wish for organising the documentation they wish.
Example Forum Documentation: Example Forum Documentation:
@ -89,4 +89,4 @@ by using a `flush=1` query parameter. See the ["Manifests" documentation](/devel
## Best Practices ## Best Practices
### Making /assets readonly ### Making /assets readonly
See [secure-development#filesystem](/topics/security#filesystem) See [Secure coding](/developer_guides/security/secure_coding#filesystem)

10
docs/en/02_Developer_Guides/00_Model/11_Scaffolding.md
View File

@ -6,7 +6,7 @@ summary: A Model-driven approach to defining your application UI.
The ORM already has a lot of information about the data represented by a `DataObject` through its `$db` property, so The ORM already has a lot of information about the data represented by a `DataObject` through its `$db` property, so
SilverStripe will use that information to provide scaffold some interfaces. This is done though [api:FormScaffolder] SilverStripe will use that information to provide scaffold some interfaces. This is done though [api:FormScaffolder]
to provide reasonable defaults based on the property type (e.g. a checkbox field for booleans). You can then further to provide reasonable defaults based on the property type (e.g. a checkbox field for booleans). You can then further
customize those fields as required. customise those fields as required.
## Form Fields ## Form Fields
@ -32,7 +32,7 @@ An example is `DataObject`, SilverStripe will automatically create your CMS inte
} }
} }
To fully customize your form fields, start with an empty FieldList. To fully customise your form fields, start with an empty FieldList.
:::php :::php
<?php <?php
@ -53,11 +53,11 @@ To fully customize your form fields, start with an empty FieldList.
You can also alter the fields of built-in and module `DataObject` classes through your own You can also alter the fields of built-in and module `DataObject` classes through your own
[DataExtension](../extensions), and a call to `DataExtension->updateCMSFields`. [DataExtension](/developer_guides/extending/extensions), and a call to `DataExtension->updateCMSFields`.
## Searchable Fields ## Searchable Fields
The `$searchable_fields` property uses a mixed array format that can be used to further customize your generated admin The `$searchable_fields` property uses a mixed array format that can be used to further customise your generated admin
system. The default is a set of array values listing the fields. system. The default is a set of array values listing the fields.
:::php :::php
@ -218,7 +218,7 @@ Non-textual elements (such as images and their manipulations) can also be used i
); );
} }
## Related Documenation ## Related Documentation
* [SearchFilters](searchfilters) * [SearchFilters](searchfilters)