Skip to content

Commit

Permalink
API-CHANGE Update docs to match renaming of sapphire to framework
Browse files Browse the repository at this point in the history
  • Loading branch information
simonwelsh authored and halkyon committed Apr 14, 2012
1 parent 3a6341a commit 6563690
Show file tree
Hide file tree
Showing 36 changed files with 142 additions and 141 deletions.
15 changes: 8 additions & 7 deletions docs/en/changelogs/3.0.0.md
Expand Up @@ -7,7 +7,8 @@
* "Page Content" and "Page Settings" are split into two interfaces
* Image/Link insertion moved into a modal dialog instead of a sidebar
* "Add pages" dropdown moved to a more descriptive modal dialog
* Allow usage of "sapphire" framework without the "cms" module
* Renaming of sapphire to SilverStripe framework
* Allow usage of SilverStripe framework without the "cms" module
* CMS JavaScript moved to [jQuery.entwine](https://github.com/hafriedlander/jquery.entwine)
* CMS stylesheets are generated by SCSS to provide more flexible and robust styling

Expand Down Expand Up @@ -207,7 +208,7 @@ If you have customized the admin interface in any way, please review
the detailed changelog for this release. Many interface components have changed completely,
unfortunately there is no clear upgrade path for every interface detail.
As a starting point, have a look at the new templates in `cms/templates`
and `sapphire/admin/templates`, as well as the new [jQuery.entwine](https://github.com/hafriedlander/jquery.entwine)
and `framework/admin/templates`, as well as the new [jQuery.entwine](https://github.com/hafriedlander/jquery.entwine)
based JavaScript logic. Have a look at the new ["Extending the CMS" guide](../howto/extending-the-cms),
["CSS" guide](../topics/css), ["JavaScript" guide](../topics/javascript) and
["CMS Architecture" guide](/reference/cms-architecture) to get you started.
Expand Down Expand Up @@ -250,7 +251,7 @@ on details for how to achieve the same goals in the new class.

### Stylesheet preprocessing via SCSS and the "compass" module ###

CSS files in the `cms` and `sapphire/admin` modules are now generated through
CSS files in the `cms` and `framework/admin` modules are now generated through
the ["compass" SilverStripe module](http://silverstripe.org/compass-module), which uses
the ["Compass" framework](http://compass-style.org/) and the ["SCSS" language](http://sass-lang.com/).
This allows us to build more flexible and expressive stylesheets as a foundation for any
Expand Down Expand Up @@ -300,14 +301,14 @@ Please use the appropriate setters on the form field instance instead.

### Restructured files and folders ###

In order to make the `sapphire` framework useable without the `cms` module,
In order to make the SilverStripe framework useable without the `cms` module,
we've moved some files around.

CMS base functionality which is not directly related to content pages (`SiteTree`)
has been moved from the `cms` module into a new "sub-module" located in `sapphire/admin`.
has been moved from the `cms` module into a new "sub-module" located in `framework/admin`.
This includes generic management interfaces like "Files & Images" (`AssetAdmin`),
"Security" (`SecurityAdmin`) and the `ModelAdmin` class.
On the other hand, `SiteTree` related features were moved from `sapphire` to the `cms` module.
On the other hand, `SiteTree` related features were moved from `framework` to the `cms` module.

Due to the built-in PHP class autoloader,
this usually won't have any effect on your own code (unless you're including direct file paths).
Expand Down Expand Up @@ -382,7 +383,7 @@ There is a new deprecation API that generates deprecation notices. Calls to Dep
will only produce errors if the API was deprecated in the release equal to or earlier than the
"notification version".

`sapphire/_config.php` currently contains a call to throw notices calls to all methods deprecated
`framework/_config.php` currently contains a call to throw notices calls to all methods deprecated
in 3.0.

Deprecation::notification_version('3.0.0');
Expand Down
6 changes: 3 additions & 3 deletions docs/en/howto/extend-cms-interface.md
Expand Up @@ -17,7 +17,7 @@ First of all, create a new folder structure in your SilverStripe webroot, which
form our module for this example.

cms/
sapphire/
framework/
zzz_admin/
_config.php
code/
Expand All @@ -34,7 +34,7 @@ the common `Page` object (a new PHP class `MyPage` will look for a `MyPage.ss` t
We can use this to create a different base template with `LeftAndMain.ss`
(which corresponds to the `LeftAndMain` PHP controller class).

Copy the template markup of the base implementation at `sapphire/admin/templates/LeftAndMain.ss` into `zzz_admin/admin/templates/LeftAndMain.ss`. It will automatically be picked up by the CMS logic. Add a new section after the `$Content` tag:
Copy the template markup of the base implementation at `framework/admin/templates/LeftAndMain.ss` into `zzz_admin/admin/templates/LeftAndMain.ss`. It will automatically be picked up by the CMS logic. Add a new section after the `$Content` tag:

:::ss
...
Expand Down Expand Up @@ -144,4 +144,4 @@ blocks and concepts for more complex extensions as well.
## Related

* [CMS Architecture](../reference/cms-architecture)
* [Topics: Rich Text Editing](../topics/rich-text-editing)
* [Topics: Rich Text Editing](../topics/rich-text-editing)
20 changes: 10 additions & 10 deletions docs/en/howto/phpunit-configuration.md
Expand Up @@ -25,10 +25,10 @@ All command-line arguments are documented on [phpunit.de](http://www.phpunit.de/
## Usage of "phpunit" executable

* `phpunit`: Runs all tests in all folders
* `phpunit sapphire/tests/`: Run all tests of the sapphire module
* `phpunit sapphire/tests/filesystem`: Run all filesystem tests within the sapphire module
* `phpunit sapphire/tests/filesystem/FolderTest.php`: Run a single test
* `phpunit sapphire/tests '' flush=all`: Run tests with optional `$_GET` parameters (you need an empty second argument)
* `phpunit framework/tests/`: Run all tests of the framework module
* `phpunit framework/tests/filesystem`: Run all filesystem tests within the framework module
* `phpunit framework/tests/filesystem/FolderTest.php`: Run a single test
* `phpunit framework/tests '' flush=all`: Run tests with optional `$_GET` parameters (you need an empty second argument)

## Coverage reports

Expand Down Expand Up @@ -61,7 +61,7 @@ for unit and functional tests.

Example `phpunit-unittests-only.xml`:

<phpunit bootstrap="/sapphire/tests/bootstrap.php" colors="true">
<phpunit bootstrap="framework/tests/bootstrap.php" colors="true">
<testsuites>
<testsuite>
<directory>mysite/tests/unit</directory>
Expand All @@ -83,8 +83,8 @@ This applies for all thirdparty code

<filter>
<blacklist>
<directory suffix=".php">sapphire/dev/</directory>
<directory suffix=".php">sapphire/thirdparty/</directory>
<directory suffix=".php">framework/dev/</directory>
<directory suffix=".php">framework/thirdparty/</directory>
<directory suffix=".php">cms/thirdparty/</directory>
<!-- Add your custom rules here -->
Expand All @@ -101,7 +101,7 @@ particularly if you have a lot of database write operations.
This is a problem when you're trying to to "[Test Driven Development](http://en.wikipedia.org/wiki/Test-driven_development)".

To speed things up a bit, you can simply use a faster database just for executing tests.
The sapphire database layer makes this relatively easy, most likely
The SilverStripe database layer makes this relatively easy, most likely
you won't need to adjust any project code or alter SQL statements.

The [SQLite3 module](http://www.silverstripe.org/sqlite-database/) provides an interface
Expand All @@ -122,7 +122,7 @@ Example `mysite/_config.php`:

You can either use the database on a single invocation:

phpunit sapphire/tests "" db=sqlite3
phpunit framework/tests "" db=sqlite3

or through a `<php>` flag in your `phpunit.xml` (see [Appenix C: "Setting PHP INI settings"](http://www.phpunit.de/manual/current/en/appendixes.configuration.html)):

Expand All @@ -136,4 +136,4 @@ or through a `<php>` flag in your `phpunit.xml` (see [Appenix C: "Setting PHP IN
<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>
</div>
24 changes: 12 additions & 12 deletions docs/en/installation/from-source.md
Expand Up @@ -24,7 +24,7 @@ See [frequently asked questions](/installation/from-source#frequently-asked-ques
SilverStripe core is currently hosted on [github.com/silverstripe](http://github.com/silverstripe). The core consists of four parts:

* The `installer` project ([github.com/silverstripe/silverstripe-installer](http://github.com/silverstripe/silverstripe-installer))
* The `sapphire` module ([github.com/silverstripe/sapphire](http://github.com/silverstripe/sapphire))
* The `framework` module ([github.com/silverstripe/sapphire](http://github.com/silverstripe/sapphire))
* The `cms` module ([github.com/silverstripe/silverstripe-cms](http://github.com/silverstripe/silverstripe-cms))
* A sample theme called `simple` ([github.com/silverstripe-themes/silverstripe-simple](http://github.com/silverstripe-themes/silverstripe-simple))

Expand Down Expand Up @@ -72,7 +72,7 @@ Run the following command to download all core dependencies via [Piston](http://
cd my-silverstripe-project/
tools/new-project

This will add `sapphire`, `cms` and the `simple` theme to your project.
This will add `framework`, `cms` and the `simple` theme to your project.

As a fallback solution, you can simply download all necessary files without any dependency management through piston.
This is handy if you have an existing project in version control, and want a one-off snapshot
Expand Down Expand Up @@ -144,15 +144,15 @@ Please replace `<username>` below with your github username.

git clone git@github.com:<username>/silverstripe-installer.git my-silverstripe-project
cd my-silverstripe-project
git clone git@github.com:<username>/sapphire.git sapphire
git clone git@github.com:<username>/sapphire.git framework
git clone git@github.com:<username>/silverstripe-cms.git cms
git clone git@github.com:<username>/silverstripe-simple.git themes/simple

Now you need to add the original repository as `upstream`, so you can keep your fork updated later on.

cd my-silverstripe-project
(git remote add upstream git://github.com/silverstripe/silverstripe-installer.git && git fetch upstream)
(cd sapphire && git remote add upstream git://github.com/silverstripe/sapphire.git && git fetch upstream)
(cd framework && git remote add upstream git://github.com/silverstripe/sapphire.git && git fetch upstream)
(cd cms && git remote add upstream git://github.com/silverstripe/silverstripe-cms.git && git fetch upstream)
(cd themes/simple && git remote add upstream git://github.com/silverstripe-themes/silverstripe-simple.git)

Expand All @@ -172,7 +172,7 @@ You can optionally select a ["release branch"](https://github.com/silverstripe/s

cd my-silverstripe-project
git checkout -b 2.4 origin/2.4
(cd sapphire && git checkout -b 2.4 origin/2.4)
(cd framework && git checkout -b 2.4 origin/2.4)
(cd cms && git checkout -b 2.4 origin/2.4)
(cd themes/simple && git checkout -b 2.4 origin/2.4)
# repeat for all modules in your project...
Expand All @@ -181,7 +181,7 @@ After creating the local branch, you can simply switch between branches:

cd my-silverstripe-project
git checkout 2.4
(cd sapphire && git checkout 2.4)
(cd framework && git checkout 2.4)
(cd cms && git checkout 2.4)
(cd themes/simple && git checkout 2.4)
# repeat for all modules in your project...
Expand All @@ -190,7 +190,7 @@ To switch back to master:

cd my-silverstripe-project
git checkout master
(cd sapphire && git checkout master)
(cd framework && git checkout master)
(cd cms && git checkout master)
(cd themes/simple && git checkout master)
# repeat for all modules in your project...
Expand Down Expand Up @@ -223,19 +223,19 @@ If you have copied the installer files into a new project, we recommend to repea
In case you chose the "Installation for contributions" option, all modules in your project
will be standard git repositories, and you can update them as usual.

cd my-silverstripe-project/sapphire
cd my-silverstripe-project/framework
git pull

### Updating modules via piston or download ###

For the "Installation for a new project" option, modules like `sapphire` or `cms`
For the "Installation for a new project" option, modules like `framework` or `cms`
are added as plain files without a direct link to their originating repository.
If these plain files are managed by piston, the update process is simple:

cd my-silverstripe-project
piston update sapphire
piston update framework
# Use "svn" instead of "git" for subversion repositories
git add sapphire/*
git add framework/*
git commit -m "udpated dependencies"

For file downloads without piston, you can simply download the source code again and replace it.
Expand Down Expand Up @@ -283,4 +283,4 @@ See [piston.rubyforge.org](http://piston.rubyforge.org/import.html).
* [Collaboration on Git](/misc/collaboration-on-git)
* [Pro git - free online book](http://progit.org/book/)
* [Git cheat sheet - github.com](https://github.com/guides/git-cheat-sheet)
* [Git - SVN Crash Course - git.or.cz](http://git.or.cz/course/svn.html)
* [Git - SVN Crash Course - git.or.cz](http://git.or.cz/course/svn.html)
16 changes: 8 additions & 8 deletions docs/en/installation/lighttpd.md
Expand Up @@ -14,8 +14,8 @@ Silverstripe. Replace "yoursite.com" and "/home/yoursite/public_html/" below.
url.access-deny += ( ".ss" )
static-file.exclude-extensions += ( ".ss" )

# Deny access to Sapphire command-line interface
$HTTP["url"] =~ "^/sapphire/cli-script.php" {
# Deny access to SilverStripe command-line interface
$HTTP["url"] =~ "^/framework/cli-script.php" {
url.access-deny = ( "" )
}

Expand All @@ -27,11 +27,11 @@ Silverstripe. Replace "yoursite.com" and "/home/yoursite/public_html/" below.
# Rewrite URLs so they are nicer
url.rewrite-once = (
"^/.*\.[A-Za-z0-9]+.*?$" => "$0",
"^/(.*?)(\?|$)(.*)" => "/sapphire/main.php?url=$1&$3"
"^/(.*?)(\?|$)(.*)" => "/framework/main.php?url=$1&$3"
)

# Show SilverStripe error page
server.error-handler-404 = "/sapphire/main.php"
server.error-handler-404 = "/framework/main.php"
}


Expand All @@ -53,14 +53,14 @@ of Silverstripe on the same host, you can use something like this (be warned, it
url.rewrite-once = (
"(?i)(/copy1/.*\.([A-Za-z0-9]+))(.*?)$" => "$0",
"(?i)(/copy2/.*\.([A-Za-z0-9]+))(.*?)$" => "$0",
"^/copy1/(.*?)(\?|$)(.*)" => "/copy1/sapphire/main.php?url=$1&$3",
"^/copy2/(.*?)(\?|$)(.*)" => "/copy2/sapphire/main.php?url=$1&$3"
"^/copy1/(.*?)(\?|$)(.*)" => "/copy1/framework/main.php?url=$1&$3",
"^/copy2/(.*?)(\?|$)(.*)" => "/copy2/framework/main.php?url=$1&$3"
)
$HTTP["url"] =~ "^/copy1/" {
server.error-handler-404 = "/copy1/sapphire/main.php"
server.error-handler-404 = "/copy1/framework/main.php"
}
$HTTP["url"] =~ "^/copy2/" {
server.error-handler-404 = "/copy2/sapphire/main.php"
server.error-handler-404 = "/copy2/framework/main.php"
}
}

Expand Down
4 changes: 2 additions & 2 deletions docs/en/installation/nginx.md
Expand Up @@ -15,10 +15,10 @@ Now you need to setup a virtual host in Nginx with the following configuration s
index index.html index.php;

if (!-f $request_filename) {
rewrite ^/(.*?)(\?|$)(.*)$ /sapphire/main.php?url=$1&$3 last;
rewrite ^/(.*?)(\?|$)(.*)$ /framework/main.php?url=$1&$3 last;
}

error_page 404 /sapphire/main.php;
error_page 404 /framework/main.php;

location ~ \.php$ {
fastcgi_pass 127.0.0.1:9000;
Expand Down
4 changes: 2 additions & 2 deletions docs/en/installation/upgrading.md
Expand Up @@ -12,7 +12,7 @@ Never update a website on the live server without trying it on a development cop
* Backup your website
* Download the new release and uncompress it to a temporary folder
* Leave custom folders like *mysite* or *themes* in place.
* Identify system folders in your webroot (`cms`, `sapphire` and any additional modules).
* Identify system folders in your webroot (`cms`, `framework` 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)
Expand All @@ -37,4 +37,4 @@ upgrade than customisations that use sneaky tricks, such as the subsites module.
## Related

* [Release Announcements](http://groups.google.com/group/silverstripe-announce/)
* [Blog posts about releases on silverstripe.org](http://silverstripe.org/blog/tag/release)
* [Blog posts about releases on silverstripe.org](http://silverstripe.org/blog/tag/release)
6 changes: 3 additions & 3 deletions docs/en/installation/windows-manual-iis-6.md
Expand Up @@ -138,13 +138,13 @@ At the moment, all URLs will have index.php in them. This is because IIS does no
# URLs with query strings
# Don't catch successful file references
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)\?(.+)$ /sapphire/main.php?url=$1&$2
RewriteRule ^(.*)\?(.+)$ /framework/main.php?url=$1&$2
# URLs without query strings
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ /sapphire/main.php?url=$1
RewriteRule ^(.*)$ /framework/main.php?url=$1

Friendly URLs should now be working when you browse to your site.

Remember that IIRF works on a per-virtual host basis. This means for each site you want IIRF to work for, you need to add a new entry to **Web Sites** in **inetmgr.exe**.

Thanks to **kcd** for the rules: [http://www.silverstripe.org/installing-silverstripe/show/10488#post294415](http://www.silverstripe.org/installing-silverstripe/show/10488#post294415)
Thanks to **kcd** for the rules: [http://www.silverstripe.org/installing-silverstripe/show/10488#post294415](http://www.silverstripe.org/installing-silverstripe/show/10488#post294415)
4 changes: 2 additions & 2 deletions docs/en/misc/coding-conventions.md
Expand Up @@ -2,7 +2,7 @@

This document provides guidelines for code formatting and documentation
to developers contributing to SilverStripe. It applies to all PHP files
in the sapphire/ and cms/ modules, as well as any supported additional modules.
in the framework/ and cms/ modules, as well as any supported additional modules.

Coding standards are an important aspect for every software project,
and facilitate collaboration by making code more consistent and readable.
Expand Down Expand Up @@ -440,4 +440,4 @@ See [security](/topics/security) for conventions related to handing security per
## License

Parts of these coding conventions were adapted from [Zend Framework](http://framework.zend.com/manual/en/coding-standard.overview.html),
which are licensed under BSD (see [license](http://framework.zend.com/license)).
which are licensed under BSD (see [license](http://framework.zend.com/license)).

0 comments on commit 6563690

Please sign in to comment.