From 656369008c87574302eb0f824991e8bd21c86425 Mon Sep 17 00:00:00 2001 From: Simon Welsh Date: Sun, 25 Mar 2012 10:16:59 +1300 Subject: [PATCH] API-CHANGE Update docs to match renaming of sapphire to framework --- docs/en/changelogs/3.0.0.md | 15 ++++++------ docs/en/howto/extend-cms-interface.md | 6 ++--- docs/en/howto/phpunit-configuration.md | 20 ++++++++-------- docs/en/installation/from-source.md | 24 +++++++++---------- docs/en/installation/lighttpd.md | 16 ++++++------- docs/en/installation/nginx.md | 4 ++-- docs/en/installation/upgrading.md | 4 ++-- docs/en/installation/windows-manual-iis-6.md | 6 ++--- docs/en/misc/coding-conventions.md | 4 ++-- docs/en/misc/contributing.md | 10 ++++---- docs/en/misc/index.md | 2 +- docs/en/misc/release-process.md | 6 ++--- docs/en/reference/cms-architecture.md | 14 +++++------ docs/en/reference/director.md | 4 ++-- docs/en/reference/execution-pipeline.md | 8 +++---- docs/en/reference/staticpublisher.md | 4 ++-- docs/en/reference/tablelistfield.md | 2 +- docs/en/reference/templates.md | 2 +- docs/en/reference/urlvariabletools.md | 2 +- docs/en/topics/commandline.md | 14 +++++------ docs/en/topics/configuration.md | 4 ++-- docs/en/topics/css.md | 4 ++-- docs/en/topics/datamodel.md | 8 +++---- docs/en/topics/directory-structure.md | 2 +- docs/en/topics/email.md | 4 ++-- docs/en/topics/environment-management.md | 4 ++-- docs/en/topics/forms.md | 6 ++--- docs/en/topics/i18n.md | 6 ++--- docs/en/topics/module-development.md | 6 ++--- docs/en/topics/modules.md | 10 ++++---- ...re-test.md => create-silverstripe-test.md} | 4 ++-- docs/en/topics/testing/index.md | 18 +++++++------- docs/en/topics/testing/why-test.md | 4 ++-- docs/en/topics/widgets.md | 8 +++---- docs/en/tutorials/1-building-a-basic-site.md | 4 ++-- .../5-dataobject-relationship-management.md | 24 +++++++++---------- 36 files changed, 142 insertions(+), 141 deletions(-) rename docs/en/topics/testing/{create-sapphire-test.md => create-silverstripe-test.md} (98%) diff --git a/docs/en/changelogs/3.0.0.md b/docs/en/changelogs/3.0.0.md index a8d4e33e5..468c91d3a 100644 --- a/docs/en/changelogs/3.0.0.md +++ b/docs/en/changelogs/3.0.0.md @@ -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 @@ -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. @@ -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 @@ -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). @@ -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'); diff --git a/docs/en/howto/extend-cms-interface.md b/docs/en/howto/extend-cms-interface.md index f5021d373..51a3bf8ed 100644 --- a/docs/en/howto/extend-cms-interface.md +++ b/docs/en/howto/extend-cms-interface.md @@ -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/ @@ -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 ... @@ -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) \ No newline at end of file + * [Topics: Rich Text Editing](../topics/rich-text-editing) diff --git a/docs/en/howto/phpunit-configuration.md b/docs/en/howto/phpunit-configuration.md index 401244d79..be9841827 100644 --- a/docs/en/howto/phpunit-configuration.md +++ b/docs/en/howto/phpunit-configuration.md @@ -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 @@ -61,7 +61,7 @@ for unit and functional tests. Example `phpunit-unittests-only.xml`: - + mysite/tests/unit @@ -83,8 +83,8 @@ This applies for all thirdparty code - sapphire/dev/ - sapphire/thirdparty/ + framework/dev/ + framework/thirdparty/ cms/thirdparty/ @@ -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 @@ -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 `` flag in your `phpunit.xml` (see [Appenix C: "Setting PHP INI settings"](http://www.phpunit.de/manual/current/en/appendixes.configuration.html)): @@ -136,4 +136,4 @@ or through a `` flag in your `phpunit.xml` (see [Appenix C: "Setting PHP IN
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. -
\ No newline at end of file + diff --git a/docs/en/installation/from-source.md b/docs/en/installation/from-source.md index 0d3941409..6e046cf35 100644 --- a/docs/en/installation/from-source.md +++ b/docs/en/installation/from-source.md @@ -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)) @@ -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 @@ -144,7 +144,7 @@ Please replace `` below with your github username. git clone git@github.com:/silverstripe-installer.git my-silverstripe-project cd my-silverstripe-project - git clone git@github.com:/sapphire.git sapphire + git clone git@github.com:/sapphire.git framework git clone git@github.com:/silverstripe-cms.git cms git clone git@github.com:/silverstripe-simple.git themes/simple @@ -152,7 +152,7 @@ Now you need to add the original repository as `upstream`, so you can keep your 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) @@ -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... @@ -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... @@ -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... @@ -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. @@ -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) \ No newline at end of file + * [Git - SVN Crash Course - git.or.cz](http://git.or.cz/course/svn.html) diff --git a/docs/en/installation/lighttpd.md b/docs/en/installation/lighttpd.md index ffbf580cd..afa9917ac 100644 --- a/docs/en/installation/lighttpd.md +++ b/docs/en/installation/lighttpd.md @@ -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 = ( "" ) } @@ -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" } @@ -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" } } diff --git a/docs/en/installation/nginx.md b/docs/en/installation/nginx.md index 6dffc781e..7f70ac27c 100644 --- a/docs/en/installation/nginx.md +++ b/docs/en/installation/nginx.md @@ -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; diff --git a/docs/en/installation/upgrading.md b/docs/en/installation/upgrading.md index 967926f00..f77f29c7a 100644 --- a/docs/en/installation/upgrading.md +++ b/docs/en/installation/upgrading.md @@ -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) @@ -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) \ No newline at end of file +* [Blog posts about releases on silverstripe.org](http://silverstripe.org/blog/tag/release) diff --git a/docs/en/installation/windows-manual-iis-6.md b/docs/en/installation/windows-manual-iis-6.md index 84476d6fb..cb94b5382 100644 --- a/docs/en/installation/windows-manual-iis-6.md +++ b/docs/en/installation/windows-manual-iis-6.md @@ -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) \ No newline at end of file +Thanks to **kcd** for the rules: [http://www.silverstripe.org/installing-silverstripe/show/10488#post294415](http://www.silverstripe.org/installing-silverstripe/show/10488#post294415) diff --git a/docs/en/misc/coding-conventions.md b/docs/en/misc/coding-conventions.md index 68296686c..62652c7c6 100644 --- a/docs/en/misc/coding-conventions.md +++ b/docs/en/misc/coding-conventions.md @@ -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. @@ -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)). \ No newline at end of file +which are licensed under BSD (see [license](http://framework.zend.com/license)). diff --git a/docs/en/misc/contributing.md b/docs/en/misc/contributing.md index cc234a6a3..69f7bd67b 100644 --- a/docs/en/misc/contributing.md +++ b/docs/en/misc/contributing.md @@ -52,7 +52,7 @@ there are any problems they will follow up with you, so please ensure they have ### Sending git pull requests -The SilverStripe core modules (`sapphire` and `cms`), as well as some of the more popular modules are in +The SilverStripe core modules (`framework` and `cms`), as well as some of the more popular modules are in git version control. SilverStripe hosts its modules on [github.com/silverstripe](http://github.com/silverstripe) and [github.com/silverstripe-labs](http://github.com/silverstripe-labs). After [installing git](http://help.github.com/git-installation-redirect) and creating a [free github.com account](https://github.com/signup/free), you can "fork" a module, which creates a copy that you can commit to (see github's [guide to "forking"](http://help.github.com/forking/)). @@ -137,7 +137,7 @@ Its contents are fetched from different releases automatically every couple of m ### Source Control In order to balance editorial control with effective collaboration, we keep -documentation alongside the module source code, e.g. in `sapphire/docs/`, +documentation alongside the module source code, e.g. in `framework/docs/`, or as code comments within PHP code. Contributing documentation is the same process as providing any other patch (see [Patches and Bugfixes](contributing#submitting-patches-bugfixes-and-enhancements)). @@ -230,9 +230,9 @@ on placing HTML blocks inside Markdown. ### Translating Documentation -Documentation is kept alongside the source code, typically in a module subdirectory like `sapphire/docs/en/`. +Documentation is kept alongside the source code, typically in a module subdirectory like `framework/docs/en/`. Each language has its own subfolder, which can duplicate parts or the whole body of documentation. -German documentation would for example live in `sapphire/docs/de/`. +German documentation would for example live in `framework/docs/de/`. The [sapphiredocs](https://github.com/silverstripe/silverstripe-sapphiredocs) module that drives [doc.silverstripe.org](http://doc.silverstripe.org) automatically resolves these subfolders into a language dropdown. @@ -257,4 +257,4 @@ a free translator account to get started, even if you just feel like fixing up a ## Related * [Installation: From Source](/installation/from-source) - * [Collaboration on Git](/misc/collaboration-on-git) \ No newline at end of file + * [Collaboration on Git](/misc/collaboration-on-git) diff --git a/docs/en/misc/index.md b/docs/en/misc/index.md index 4ba5e3492..5979f7635 100644 --- a/docs/en/misc/index.md +++ b/docs/en/misc/index.md @@ -6,7 +6,7 @@ sections. * [Coding conventions](coding-conventions): Guidelines and standards for code formatting and documentation * [Contributing](contributing): How you can be a part of the SilverStripe Open Source community * [Module release process](module-release-process): Creating and looking after a module -* [Release process](release-process): Describes the Sapphire and CMS release process +* [Release process](release-process): Describes the Framework and CMS release process * [SS markdown](ss-markdown): Markdown syntax for our technical documentation * [Subversion](subversion): Describes SilverStripe-specific information on how to handle subversion diff --git a/docs/en/misc/release-process.md b/docs/en/misc/release-process.md index ab6e9c9ba..5c7dabc1f 100644 --- a/docs/en/misc/release-process.md +++ b/docs/en/misc/release-process.md @@ -1,6 +1,6 @@ # Release Process -Describes the process followed for "core" releases (mainly the `sapphire` and `cms` modules). +Describes the process followed for "core" releases (mainly the `framework` and `cms` modules). For other modules, we've compiled a helpful guide for a good [module release process](module-release-process). ## Release Maintainer @@ -18,7 +18,7 @@ Release dates are usually not published prior to the release, but you can get a reviewing the [release milestone](http://open.silverstripe.com/roadmap) on open.silverstripe.org. Releases will be announced on the [release announcements mailing list](http://groups.google.com/group/silverstripe-announce). -Releases of the *cms* and *sapphire* modules are coupled at the moment, they follow the same numbering scheme. Module +Releases of the *cms* and *framework* modules are coupled at the moment, they follow the same numbering scheme. Module releases are documented separately in [module-release-process](module-release-process). ## Release Numbering @@ -146,4 +146,4 @@ Each [security release](http://www.silverstripe.org/security-releases/) includes | **Critical** | Critical releases require immediate actions. Such vulnerabilities allow attackers to take control of your site and you should upgrade on the day of release. *Example: Directory traversal, privilege escalation* | | **Important** | Important releases should be evaluated immediately. These issues allow an attacker to compromise a site's data and should be fixed within days. *Example: SQL injection.* | | **Moderate** | Releases of moderate severity should be applied as soon as possible. They allow the unauthorized editing or creation of content. *Examples: Cross Site Scripting (XSS) in template helpers.* | -| **Low** | Low risk releases fix information disclosure and read-only privilege escalation vulnerabilities. These updates should also be applied as soon as possible, but with an impact-dependent priority. *Example: Exposure of the core version number, Cross Site Scripting (XSS) limited to the admin interface.* | \ No newline at end of file +| **Low** | Low risk releases fix information disclosure and read-only privilege escalation vulnerabilities. These updates should also be applied as soon as possible, but with an impact-dependent priority. *Example: Exposure of the core version number, Cross Site Scripting (XSS) limited to the admin interface.* | diff --git a/docs/en/reference/cms-architecture.md b/docs/en/reference/cms-architecture.md index 127096e91..250166d18 100644 --- a/docs/en/reference/cms-architecture.md +++ b/docs/en/reference/cms-architecture.md @@ -27,7 +27,7 @@ on our [blog](http://www.silverstripe.org/the-3-0-ui-a-better-framework-for-your All CSS in the CMS UI is written in the [SCSS language extensions](http://sass-lang.com/) and the [Compass framework](http://compass-style.org/), which helps -us maintain expressive and concise style declarations. The files are located in `sapphire/admin/scss` +us maintain expressive and concise style declarations. The files are located in `framework/admin/scss` (and if you have the `cms` module installed, in `cms/scss`), and are compiled to a `css` folder on the same directory path. Changes to the SCSS files can be automatically converted by installing the ["compass" module](http://www.silverstripe.org/compass-module/) for SilverStripe, @@ -138,8 +138,8 @@ Due to the procedural and selector-driven style of UI programming in jQuery.entw it can be difficult to find the piece of code responsible for a certain behaviour. Therefore it is important to adhere to file naming conventions. E.g. a feature only applicable to `ModelAdmin` should be placed in -`sapphire/admin/javascript/ModelAdmin.js`, while something modifying all forms (including ModelAdmin forms) -would be better suited in `sapphire/admin/javascript/LeftAndMain.EditForm.js`. +`framework/admin/javascript/ModelAdmin.js`, while something modifying all forms (including ModelAdmin forms) +would be better suited in `framework/admin/javascript/LeftAndMain.EditForm.js`. Selectors used in these files should mirrow the "scope" set by its filename, so don't place a rule applying to all form buttons inside `ModelAdmin.js`. @@ -151,7 +151,7 @@ and [jQuery.delegate](http://api.jquery.com/delegate/), so takes care of dynamic Most interfaces will require their own JavaScript and CSS files, so the Ajax loading has to ensure they're loaded unless already present. A custom-built library called -`jQuery.ondemand` (located in `sapphire/thirdparty`) takes care of this transparently - +`jQuery.ondemand` (located in `framework/thirdparty`) takes care of this transparently - so as a developer just declare your dependencies through the `[api:Requirements]` API. ## Ajax Loading and Browser History @@ -231,11 +231,11 @@ To avoid repetition, we've written some helpers for various use cases: SilverStripe automatically applies a [jQuery UI button style](http://jqueryui.com/demos/button/) to all elements with the class `.ss-ui-button`. We've extended the jQuery UI widget a bit to support defining icons via HTML5 data attributes (see `ssui.core.js`). -These icon identifiers relate to icon files in `sapphire/admin/images/btn-icons`, +These icon identifiers relate to icon files in `framework/admin/images/btn-icons`, and are sprited into a single file through SCSS and the Compass framework (see [tutorial](http://compass-style.org/help/tutorials/spriting/)). Compass also creates the correct CSS classes to show those sprites via background images -(see `sapphire/admin/scss/_sprites.scss`). +(see `framework/admin/scss/_sprites.scss`). Input: `Button text` @@ -276,4 +276,4 @@ Note: You can see any additional HTTP headers through the web developer tools in * [Howto: Extend the CMS Interface](../howto/extend-cms-interface) * [Howto: Customize the CMS tree](../howto/customize-cms-tree) * [Reference: ModelAdmin](../reference/modeladmin) - * [Topics: Rich Text Editing](../topics/rich-text-editing) \ No newline at end of file + * [Topics: Rich Text Editing](../topics/rich-text-editing) diff --git a/docs/en/reference/director.md b/docs/en/reference/director.md index 9de2babde..2ab4978be 100644 --- a/docs/en/reference/director.md +++ b/docs/en/reference/director.md @@ -50,8 +50,8 @@ See [controller](/topics/controller) for examples and explanations on how the ru SilverStripe comes with certain rewrite rules (e.g. for *admin/assets*). -* [sapphire/_config.php](http://open.silverstripe.org/browser/modules/sapphire/trunk/_config.php) -* [cms/_config.php](http://open.silverstripe.org/browser/modules/cms/trunk/_config.php) +* [framework/_config.php](https://github.com/silverstripe/sapphire/blob/master/_config.php) +* [cms/_config.php](https://github.com/silverstripe/silverstripe-cms/blob/master/_config.php) ## Links diff --git a/docs/en/reference/execution-pipeline.md b/docs/en/reference/execution-pipeline.md index e42b1a3e5..588a978a2 100644 --- a/docs/en/reference/execution-pipeline.md +++ b/docs/en/reference/execution-pipeline.md @@ -27,7 +27,7 @@ The basic .htaccess file after installing SilverStripe look like this: RewriteCond %{REQUEST_URI} ^(.*)$ RewriteCond %{REQUEST_FILENAME} !-f - RewriteRule .* sapphire/main.php?url=%1&%{QUERY_STRING} [L] + RewriteRule .* framework/main.php?url=%1&%{QUERY_STRING} [L] ### SILVERSTRIPE END ### @@ -35,11 +35,11 @@ The basic .htaccess file after installing SilverStripe look like this: The `` section denies direct access to the template files from anywhere but the server itself. -The next section enables the rewriting engine and rewrites requests to `sapphire/main.php` if they meet the following +The next section enables the rewriting engine and rewrites requests to `framework/main.php` if they meet the following criteria: * URI doesn't end in .gif, .jpg, .png, .css, or .js -* The requested file doesn't exist on the filesystem `sapphire/main.php` is called with the REQUEST_FILENAME (%1) as the `url` parameter and also appends the original +* The requested file doesn't exist on the filesystem `framework/main.php` is called with the REQUEST_FILENAME (%1) as the `url` parameter and also appends the original QUERY_STRING. See the [mod_rewrite documentation](http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html) for more information on how @@ -90,4 +90,4 @@ You can access the following controller-method with /team/signup ## SSViewer template rendering -See [templates](/topics/templates) for information on the SSViewer template system. \ No newline at end of file +See [templates](/topics/templates) for information on the SSViewer template system. diff --git a/docs/en/reference/staticpublisher.md b/docs/en/reference/staticpublisher.md index ebdd40305..1ecf1190c 100644 --- a/docs/en/reference/staticpublisher.md +++ b/docs/en/reference/staticpublisher.md @@ -123,12 +123,12 @@ example](http://open.silverstripe.com/browser/modules/cms/trunk/code/staticpubli Just look for this line: - RewriteRule .* sapphire/main.php?url=%1&%{QUERY_STRING} [L] + RewriteRule .* framework/main.php?url=%1&%{QUERY_STRING} [L] And change the PHP script from main.php to static-main.php: - RewriteRule .* sapphire/static-main.php?url=%1&%{QUERY_STRING} [L] + RewriteRule .* framework/static-main.php?url=%1&%{QUERY_STRING} [L] ## Using Static Publisher With Subsites Module diff --git a/docs/en/reference/tablelistfield.md b/docs/en/reference/tablelistfield.md index d9fd64b1e..f3529e370 100644 --- a/docs/en/reference/tablelistfield.md +++ b/docs/en/reference/tablelistfield.md @@ -144,7 +144,7 @@ restriction is needed to avoid performance-hits by caching and sorting potential ### Casting -Column-values can be casted, based on the casting-types available through DBObject (sapphire/core/model/fieldtypes). +Column-values can be casted, based on the casting-types available through DBObject (framework/core/model/fieldtypes). :::php $myTableListField->setFieldCasting(array( diff --git a/docs/en/reference/templates.md b/docs/en/reference/templates.md index d68a668f6..05b84917b 100644 --- a/docs/en/reference/templates.md +++ b/docs/en/reference/templates.md @@ -86,7 +86,7 @@ If a variable returns a string, that string will be inserted into the template. the system will attempt to render the object through its forTemplate() method. If the `forTemplate()` method has not been defined, the system will return an error. -SilverStripe provides lots of properties and methods. For more details on built-in page controls and variables, see http://doc.silverstripe.org/sapphire/en/reference/built-in-page-controls +SilverStripe provides lots of properties and methods. For more details on built-in page controls and variables, see http://doc.silverstripe.org/framework/en/reference/built-in-page-controls ### Escaping diff --git a/docs/en/reference/urlvariabletools.md b/docs/en/reference/urlvariabletools.md index 0e2224bd7..74e70d2b1 100644 --- a/docs/en/reference/urlvariabletools.md +++ b/docs/en/reference/urlvariabletools.md @@ -3,7 +3,7 @@ ## Introduction This page lists a number of "page options" , "rendering tools" or "special URL variables" that you can use to debug your -sapphire applications. These are consumed in PHP using the $_REQUEST or $_GET super globals throughout the Sapphire +SilverStruoe applications. These are consumed in PHP using the $_REQUEST or $_GET super globals throughout the SilverStripe core. **General Usage** diff --git a/docs/en/topics/commandline.md b/docs/en/topics/commandline.md index 505ad2c2d..8fdfa05d8 100644 --- a/docs/en/topics/commandline.md +++ b/docs/en/topics/commandline.md @@ -10,7 +10,7 @@ The main entry point for any commandline execution is `cli-script.php`. For exam from the commandline, use this command: cd your-webroot/ - php sapphire/cli-script.php dev/build + php framework/cli-script.php dev/build Make sure that your commandline php version uses the same configuration as your webserver (run `php -i` to find out more). @@ -20,9 +20,9 @@ You can add parameters to the command by using normal form encoding. All parameters will be available in `$_GET` within SilverStripe. cd your-webroot/ - php sapphire/cli-script.php myurl myparam=1 myotherparam=2 + php framework/cli-script.php myurl myparam=1 myotherparam=2 -## SAKE: Sapphire make +## SAKE: SilverStripe make Sake is a simple wrapper around `cli-script.php`. It also tries to detect which `php` executable to use if more than one are available. @@ -35,7 +35,7 @@ If you get an error when running the command php -v, then you may not have php-c You can copy the `sake` file into `/usr/bin/sake` for easier access (this is optional): cd your-webroot/ - sudo ./sapphire/sake installsake + sudo ./framework/sake installsake Note: This currently only works on unix-like systems, not on Windows. @@ -68,7 +68,7 @@ Using this example, /Users/sminnee/Sites/mysite/ would be accessed at http://mys ## Usage -Sake will either run `./sapphire/cli-script.php` or `./cli-script.php`, depending on what's available. +Sake will either run `./framework/cli-script.php` or `./cli-script.php`, depending on what's available. It's particularly useful for running build tasks... @@ -87,7 +87,7 @@ It can also be handy if you have a long running script. You can use sake to make daemon processes for your application. -Step 1: Make a task or controller class that runs a loop. Because Sapphire has memory leaks, you should make the PHP +Step 1: Make a task or controller class that runs a loop. Because SilverStripe has memory leaks, you should make the PHP process exit when it hits some reasonable memory limit. Sake will automatically restart your process whenever it exits. The other thing you should do is include some appropriate sleep()s so that your process doesn't hog the system. The @@ -122,4 +122,4 @@ Step 3: Use sake to start and stop your process Note that sake processes are currently a little brittle, in that the pid and log files are placed in the site root -directory, rather than somewhere sensible like /var/log or /var/run. \ No newline at end of file +directory, rather than somewhere sensible like /var/log or /var/run. diff --git a/docs/en/topics/configuration.md b/docs/en/topics/configuration.md index ac27ec89d..c5c1fff83 100644 --- a/docs/en/topics/configuration.md +++ b/docs/en/topics/configuration.md @@ -62,7 +62,7 @@ Some constants are user-defineable within *_ss_environment.php*. | Name | | Description | | ---- | | ----------- | - | *TEMP_FOLDER* | | Absolute file path to store temporary files such as cached templates or the class manifest. Needs to be writeable by the webserver user. Defaults to *sys_get_temp_dir()*, and falls back to *silverstripe-cache* in the webroot. See *getTempFolder()* in *sapphire/core/Core.php* | + | *TEMP_FOLDER* | | Absolute file path to store temporary files such as cached templates or the class manifest. Needs to be writeable by the webserver user. Defaults to *sys_get_temp_dir()*, and falls back to *silverstripe-cache* in the webroot. See *getTempFolder()* in *framework/core/Core.php* | ## User-level: Member-object @@ -94,4 +94,4 @@ and `ini_set('max_execution_time', )` in your own `_config.php`. ## See Also -[Config Cheat sheet](http://www.ssbits.com/a-config-php-cheatsheet/) \ No newline at end of file +[Config Cheat sheet](http://www.ssbits.com/a-config-php-cheatsheet/) diff --git a/docs/en/topics/css.md b/docs/en/topics/css.md index 0ec2b742d..a28df9c6a 100644 --- a/docs/en/topics/css.md +++ b/docs/en/topics/css.md @@ -11,7 +11,7 @@ You are free to add `