Skip to content

Commit

Permalink
MINOR: formatting changes and fixes to original document formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Andrewartha authored and chillu committed Mar 20, 2011
1 parent f15f083 commit 8ad630d
Show file tree
Hide file tree
Showing 27 changed files with 69 additions and 62 deletions.
3 changes: 1 addition & 2 deletions docs/en/changelogs/2.2.0.md
Expand Up @@ -72,7 +72,7 @@ Sitemap.php
* Portuguese (Portugal) translation
* Support for multilingual content
* Added a Statistics area showing the following reports
* Page views
* Page views
* User activity
* Trends
* Operating Systems
Expand Down Expand Up @@ -120,7 +120,6 @@ Sitemap.php
* Replace the 'reorganise' button with 'Allowing drag & drog reordering' checkbox
* Delete and Unpublish buttons turn red on hover
* Added the ability to align images 'left on their own'


## Enhancements

Expand Down
2 changes: 1 addition & 1 deletion docs/en/changelogs/2.3.6.md
Expand Up @@ -37,4 +37,4 @@
### Other

Created with:
{![](_images/./sscreatechangelog --version 2.3.6 --branch branches/2.3 --stopbranch tags/2.3.5)}
<code>./sscreatechangelog --version 2.3.6 --branch branches/2.3 --stopbranch tags/2.3.5</code>
2 changes: 1 addition & 1 deletion docs/en/changelogs/2.3.7.md
Expand Up @@ -9,4 +9,4 @@
* [rev:100744] Fixing Member_ProfileForm to validate for existing members via Member_Validator to avoid CMS users to switch to another existing user account by using their email address (from r100704) (from r100717)

Created with:
<code>./sscreatechangelog --version 2.3.7 --branch branches/2.3 --stopbranch tags/2.3.6)</code>
<code>./sscreatechangelog --version 2.3.7 --branch branches/2.3 --stopbranch tags/2.3.6</code>
4 changes: 2 additions & 2 deletions docs/en/changelogs/2.3.8.md
Expand Up @@ -49,7 +49,7 @@ See [2.4.1](2.4.1#securitydisallow_direct_execution_of_php_files)
* [rev:103447] Fixed js applying to non-tinymce textarea fields in !ModelAdmin.js (fixes #5453)
* [rev:103362] Fixed js applying to non-tinymce textarea fields in !ModelAdmin.js (fixes #5453)
* [rev:103348] added moderation message for non-ajax mode
* [rev:101258] Fixed missing closing <div> in !ContentController->successfullyinstalled() (from r101254)
* [rev:101258] Fixed missing closing `<div>` in !ContentController->successfullyinstalled() (from r101254)


<code>./sscreatechangelog --version 2.3.8 --branch branches/2.3 --stopbranch tags/2.3.7</code>
`./sscreatechangelog --version 2.3.8 --branch branches/2.3 --stopbranch tags/2.3.7`
2 changes: 1 addition & 1 deletion docs/en/changelogs/2.4.1.md
Expand Up @@ -343,7 +343,7 @@ existing pages when their title is changed.
* [rev:104720] Fixed installation problem where version error didn't show
* [rev:104679] Make URLs lowercase
* [rev:104678] Fixed Translatable::canEdit() to suit new permission customisation scheme
* [rev:104675] Prevent !DataDifferencer from creating empty <ins /> and <del /> takes that confuse the browser.
* [rev:104675] Prevent !DataDifferencer from creating empty `<ins />` and `<del />` takes that confuse the browser.
* [rev:104672] Make !RsyncMultiHostPublisher protected; give default value.
* [rev:104670] Director::test() shouldn't break if $_SESSION isn't set.
* [rev:104666] Removed references to php5 binary in Makefile
Expand Down
2 changes: 1 addition & 1 deletion docs/en/changelogs/2.4.2.md
Expand Up @@ -48,7 +48,7 @@
* [110857] Enforcing canEdit() checks in !ComplexTableField_Popup - making form readonly if the current user can't edit
* [110838] Case insensitive !DateField value navigation (fixes #5990, thanks gw0(
* [110835] Passing $name in !MoneyField->!FieldCurrency() (fixes #5982, thanks andersw)
* [110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained <iframe>) (fixes #5949)
* [110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained `<iframe>`) (fixes #5949)
* [110808] Allowing $extraClass on !CheckboxField !FieldHolder (fixes #5939, thanks mobiusnz)
* [110759] ensure that pages can only be requested from staging and live
* [110463] Fixed boundary PHP notice case in !RequiredFields::php() where a field name may not be defined in the $data array when a Form is submitted
Expand Down
2 changes: 1 addition & 1 deletion docs/en/changelogs/rc/2.3.8-rc1.md
Expand Up @@ -38,4 +38,4 @@
* [rev:101258] Fixed missing closing `<div>` in ContentController->successfullyinstalled() (from r101254)


{![](_images/./sscreatechangelog --version 2.3.8-rc1 --branch branches/2.3 --stopbranch tags/2.3.7)}
`./sscreatechangelog --version 2.3.8-rc1 --branch branches/2.3 --stopbranch tags/2.3.7`
2 changes: 1 addition & 1 deletion docs/en/changelogs/rc/2.4.0-rc1.md
Expand Up @@ -143,4 +143,4 @@

* [rev:101314] ENHNACEMENT Installer no longer asks for firstname and surname for default CMS admin account, this can be changed later on and doesn't need to be entered for installation

{![](_images/./sscreatechangelog --version 2.4.0-rc1 --branch branches/2.4 --stoprevision 101127)}
`./sscreatechangelog --version 2.4.0-rc1 --branch branches/2.4 --stoprevision 101127`
2 changes: 1 addition & 1 deletion docs/en/changelogs/rc/2.4.0-rc2.md
Expand Up @@ -124,4 +124,4 @@
* [rev:102071] Removed unnecessary sapphire/thirdparty/.gitignore, as the directory doesnt contain svn:externals any longer (fixes #5334)
* [rev:102045] Fixed spelling mistake in ConfigureFromEnv class documentation

{![](_images/./sscreatechangelog --version 2.4.0-rc2 --branch branches/2.4 --stoprevision 102039)}
`./sscreatechangelog --version 2.4.0-rc2 --branch branches/2.4 --stoprevision 102039`
2 changes: 1 addition & 1 deletion docs/en/changelogs/rc/2.4.0-rc3.md
Expand Up @@ -24,4 +24,4 @@
* [rev:103975] Removed unnecessary $timeformat parameter from TimeField::__construct, and getting the default from Zend_Locale_Format in the same way that DateField behaves (unreleased API, so no api change).
* [rev:103975] Automatically choosing $locale in TimeField::__construct, to be consistent with DateField

{![](_images/./sscreatechangelog --version 2.4.0-rc2 --branch branches/2.4 --stoprevision 103839)}
`./sscreatechangelog --version 2.4.0-rc2 --branch branches/2.4 --stoprevision 103839`
2 changes: 1 addition & 1 deletion docs/en/changelogs/rc/2.4.1-rc1.md
Expand Up @@ -325,4 +325,4 @@
* [rev:104667] Added explicit bash handler to sake
* [rev:104442] Multi-use redemption page created

{![](_images/./sscreatechangelog --version 2.4.1-rc1 --branch branches/2.4 --stopbranch tags/2.4.0)}
`./sscreatechangelog --version 2.4.1-rc1 --branch branches/2.4 --stopbranch tags/2.4.0`
2 changes: 1 addition & 1 deletion docs/en/changelogs/rc/2.4.2-rc1.md
Expand Up @@ -35,7 +35,7 @@
* [rev:110857] Enforcing canEdit() checks in !ComplexTableField_Popup - making form readonly if the current user can't edit
* [rev:110838] Case insensitive !DateField value navigation (fixes #5990, thanks gw0(
* [rev:110835] Passing $name in !MoneyField->!FieldCurrency() (fixes #5982, thanks andersw)
* [rev:110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained <iframe>) (fixes #5949)
* [rev:110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained `<iframe>`) (fixes #5949)
* [rev:110808] Allowing $extraClass on !CheckboxField !FieldHolder (fixes #5939, thanks mobiusnz)
* [rev:110759] ensure that pages can only be requested from staging and live
* [rev:110463] Fixed boundary PHP notice case in !RequiredFields::php() where a field name may not be defined in the $data array when a Form is submitted
Expand Down
2 changes: 1 addition & 1 deletion docs/en/howto/csv-import.md
Expand Up @@ -156,7 +156,7 @@ Sample implementation of a custom loader. Assumes a CSV-file in a certain format
* Converts property names
* Splits a combined "Name" fields from the CSV-data into `FirstName` and `Lastname` by a custom importer method
* Avoids duplicate imports by a custom `$duplicateChecks` definition
* Creates `Team` relations automatically based on the `Gruppe` colum in the CSV data
* Creates `Team` relations automatically based on the `Gruppe` column in the CSV data


:::php
Expand Down
1 change: 0 additions & 1 deletion docs/en/howto/dynamic-default-fields.md
Expand Up @@ -34,6 +34,5 @@ methods. For example:
} else {
$this->FullTitle = $this->Title;
}
parent::populateDefaults();
}
5 changes: 3 additions & 2 deletions docs/en/howto/grouping-dataobjectsets.md
Expand Up @@ -70,6 +70,7 @@ a number of sets, grouped by the field that is passed as the parameter. In this
defined earlier is used to break them up.

:::ss
// Modules list grouped by TitleFirstLetter
<h2>Modules</h2>
<% control Modules.GroupedBy(TitleFirstLetter) %>
<h3>$TitleFirstLetter</h3>
Expand Down Expand Up @@ -130,6 +131,7 @@ January to December. This can be accomplshed by sorting by the Date field:
The final step is the render this into the template using the [api:DataObjectSet->GroupedBy()] method.

:::ss
// Modules list grouped by the Month Posted
<h2>Modules</h2>
<% control NewsItems.GroupedBy(MonthPosted) %>
<h3>$MonthPosted</h3>
Expand All @@ -138,5 +140,4 @@ The final step is the render this into the template using the [api:DataObjectSet
<li>$Title ($Date.Nice)</li>
<% end_control %>
</ul>
<% end_control %>

<% end_control %>
10 changes: 4 additions & 6 deletions docs/en/howto/index.md
Expand Up @@ -6,13 +6,11 @@ on tasks and goals rather than going into deep details.
You will find it useful to read the introduction [tutorials](/tutorials) before tackling these How-Tos so you can understand some of
the language and functions which are used in the guides.

* [Import CSV Data](csv-import). Build a simple CSV importer using either ModelAdmin or a custom controller
* [Dynamic Default Fields](dynamic-default-fields). Pre populate a DataObject with data.
* [Grouping DataObjectSets](grouping-dataobjectsets). Group results in a DataObjectSet to create sub sections.
* [Import CSV Data](csv-import). Build a simple CSV importer using either [api:ModelAdmin] or a custom controller
* [Dynamic Default Fields](dynamic-default-fields). Pre populate a [api:DataObject] with data.
* [Grouping DataObjectSets](grouping-dataobjectsets). Group results in a [api:DataObjectSet] to create sub sections.
* [PHPUnit Configuration](phpunit-configuration). How to setup your testing environment with PHPUnit

## Feedback

If you have a topic you would like covered in these how to's please ask for it on our [Bug Tracker](http://open.silverstripe.org)


If you have a topic you would like covered in these how to's please ask for it on our [Bug Tracker](http://open.silverstripe.org)
10 changes: 5 additions & 5 deletions docs/en/howto/phpunit-configuration.md
Expand Up @@ -3,7 +3,7 @@
This guide helps you to run [PHPUnit](http://phpunit.de) tests in your SilverStripe project.
See "[Testing](/topics/testing)" for an overview on how to create unit tests.

## Executing through "sake dev/tests" or "phpunit"?
## Should I execute through "sake dev/tests" or "phpunit"?

Short answer: Both are valid ways.

Expand Down Expand Up @@ -128,12 +128,12 @@ or through a `<php>` flag in your `phpunit.xml` (see [Appenix C: "Setting PHP IN

<phpunit>
<!-- ... -->
<php>
<var name="db" value="sqlite3"/>
</php>

</phpunit>

Note: It is recommended that you still run your tests with the original
database driver (at least on continuous integration) to ensure a realistic test scenario.
<div class="hint" markdown="1">
It is recommended that you still run your tests with the original database driver (at least on continuous integration)
to ensure a realistic test scenario.
</div>
19 changes: 13 additions & 6 deletions docs/en/installation/common-problems.md
Expand Up @@ -2,19 +2,26 @@

From time to time, things will go wrong. Here's a few things to try when you're confused.

See ["8 Common SilverStripe Errors Explain (and solved!) (leftandmain.com)"](http://www.leftandmain.com/silverstripe-tips/2010/09/08/8-common-silverstripe-errors-explained-and-solved/) for more common problems.
See ["8 Common SilverStripe Errors Explain (and solved!) (leftandmain.com)"](http://www.leftandmain.com/silverstripe-tips/2010/09/08/8-common-silverstripe-errors-explained-and-solved/)
for more common problems.

## The output shows only "Website Error"

This first and foremost means that your environment is set to "live mode" (see [environment-management]), which disallows detailed error messages for security reasons. You'll typically need to get your environment into "dev mode" to see more information.
This first and foremost means that your environment is set to "live mode" (see [environment-management]), which disallows
detailed error messages for security reasons. You'll typically need to get your environment into "dev mode" to see more
information.

If you can log-in to the CMS as an administrator, append `?isDev=1` to any URL to temporarily set your browsing session into "dev mode". If you can't log-in in the first place because of the error, add this directive to your `mysite/_config.php` (don't forget to remove it afterwards!):
If you can log-in to the CMS as an administrator, append `?isDev=1` to any URL to temporarily set your browsing session into
"dev mode". If you can't log-in in the first place because of the error, add this directive to your `mysite/_config.php`
(don't forget to remove it afterwards!):

:::php
Director::set_environment_type('dev'); // temporary debugging statement

Note: On "live" environments, the `?isDev=1` solution is preferred, as it means that your other visitors don't see ugly
<div class="warning" markdown='1'>
On "live" environments, the `?isDev=1` solution is preferred, as it means that your other visitors don't see ugly
(and potentially security sensitive) PHP errors as well.
</div>

## My templates don't update on page refresh

Expand All @@ -29,7 +36,7 @@ to a lot of development problems. Here are some specifics situations:
## A SQL query fails with "Column not found" or "Table not found"

Whenever you change the model definitions in PHP (e.g. when adding a property to the [$db](api:DataObject::$db) array,
creating a new page type), SilverStripe will need to update the database. Visiting `http://`<my-domain>`/dev/build` in
creating a new page type), SilverStripe will need to update the database. Visiting `http://<my-domain>/dev/build` in
your browser runs a script that will check the database schema and update it as necessary. Putting `?flush=1` on the
end makes sure that nothing that's linked to the old database structure will be carried over. If things aren't saving,
pages aren't loading, or other random things aren't working it's possible that the database hasn't been updated to
Expand All @@ -48,7 +55,7 @@ every page on the site, if that's easier.

## I can see unparsed PHP output in my browser

Please make sure all code inside '*.php' files is wrapped in classes. Due to the way `[api:ManifestBuilder]`
Please make sure all code inside `*.php` files is wrapped in classes. Due to the way `[api:ManifestBuilder]`
includes all files with this extension, any **procedural code will be executed on every call**. Most common error here
is putting a test.php/phpinfo.php file in the document root. See [datamodel](/topics/datamodel) and [controllers](/topics/controller)
for ways how to structure your code.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/installation/from-source.md
@@ -1,4 +1,4 @@
# Installation from Source Control #
# Installation from Source Control

## Introduction

Expand Down
4 changes: 2 additions & 2 deletions docs/en/installation/upgrading.md
Expand Up @@ -14,8 +14,8 @@ Never update a website on the live server without trying it on a development cop
* Leave custom folders like *mysite* or *themes* in place.
* Identify system folders in your webroot (`cms`, `sapphire` and any additional modules).
* Delete existing system folders (or move them outside of your webroot)
* Extract and replace system folders from your download (//Deleting instead of "copying over" existing folders
ensures that files removed from the new SilverStripe release are not persisting in your installation//)
* Extract and replace system folders from your download (Deleting instead of "copying over" existing folders
ensures that files removed from the new SilverStripe release are not persisting in your installation)

* Visit http://yoursite.com/dev/build/?flush=1 to rebuild the website Database
* Check if you need to adapt your code to changed APIs
Expand Down
2 changes: 1 addition & 1 deletion docs/en/installation/webserver.md
Expand Up @@ -4,7 +4,7 @@ These instructions show you how to install SilverStripe on any web server.

For additional information about installing SilverStripe on specific operation systems, refer to:

* [Installation on a Windows Server](windows-pi.md)
* [Installation on a Windows Server](windows-pi)
* [Installation on OSX](mac-osx)

## Installation Steps
Expand Down

0 comments on commit 8ad630d

Please sign in to comment.