tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #7444 from open-sausages/pulls/4/fix-docs-paths

Browse Source 
Fixed docs paths (fixes #7075)
This commit is contained in:
Damian Mooyman 2017-10-10 09:53:17 +13:00 committed by GitHub
commit 5d6a10ca58
9 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/02_Developer_Guides/01_Templates/02_Common_Variables.md
View File

@ -355,7 +355,8 @@ While you can achieve breadcrumbs through the `$Level(<level>)` control manually
$Breadcrumbs
```
By default, it uses the template defined in `cms/templates/BreadcrumbsTemplate.ss`
By default, it uses the template defined in `templates/BreadcrumbsTemplate.ss`
of the `silverstripe/cms` module.
```ss
@ -367,7 +368,8 @@ By default, it uses the template defined in `cms/templates/BreadcrumbsTemplate.s
```
<div class="info" markdown="1">
To customise the markup that the `$Breadcrumbs` generates, copy `cms/templates/BreadcrumbsTemplate.ss` to
To customise the markup that the `$Breadcrumbs` generates, copy `templates/BreadcrumbsTemplate.ss`
from the `silverstripe/cms` module to
`mysite/templates/BreadcrumbsTemplate.ss`, modify the newly copied template and flush your SilverStripe cache.
</div>

4
docs/en/02_Developer_Guides/03_Forms/Field_types/03_HTMLEditorField.md
View File

@ -90,7 +90,7 @@ then set the currently active config using `set_active()`.
<div class="notice" markdown='1'>
Currently the order in which the `_config.php` files are executed depends on the module directory names. Execution
order is alphabetical, so if you set a TinyMCE option in the `aardvark/_config.php`, this will be overridden in
`framework/admin/_config.php` and your modification will disappear.
`vendor/silverstripe/framework/admin/_config.php` and your modification will disappear.
</div>
## Adding and removing capabilities
@ -163,7 +163,7 @@ from the HTML source by the editor.
<div class="notice" markdown="1">
The default setting for the CMS's `extended_valid_elements` we are overriding here can be found in
`framework/admin/_config.php`.
`vendor/silverstripe/framework/admin/_config.php`.
</div>
## Writing custom plugins

2
docs/en/02_Developer_Guides/05_Extending/01_Extensions.md
View File

@ -142,7 +142,7 @@ If the `Extension` needs to modify an existing method it's a little trickier. It
customise has provided an *Extension Hook* in the place where you want to modify the data. An *Extension Hook* is done
through the `extend()` method of the [Extensible](api:SilverStripe\Core\Extensible) trait.
**framework/security/Member.php**
**Member.php**
```php

2
docs/en/02_Developer_Guides/10_Email/index.md
View File

@ -41,7 +41,7 @@ to `*text*`).
```
<div class="info" markdown="1">
The default HTML template for emails is named `GenericEmail` and is located in `framework/templates/SilverStripe/Email/`.
The default HTML template for emails is named `GenericEmail` and is located in `vendor/silverstripe/framework/templates/SilverStripe/Email/`.
To customise this template, copy it to the `mysite/templates/Email/` folder or use `setHTMLTemplate` when you create the
`Email` instance.
</div>

2
docs/en/02_Developer_Guides/11_Integration/02_RSSFeed.md
View File

@ -167,7 +167,7 @@ Then in our controller, we add a new action which returns a the XML list of `Pla
### Customizing the RSS Feed template
The default template used for XML view is `framework/templates/RSSFeed.ss`. This template displays titles and links to
The default template used for XML view is `vendor/silverstripe/framework/templates/RSSFeed.ss`. This template displays titles and links to
the object. To customise the XML produced use `setTemplate`.
Say from that last example we want to include the Players Team in the XML feed we might create the following XML file.

20
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md
View File

@ -29,9 +29,9 @@ Note: For each core module (e.g. `framework` and `cms`), a separate `npm install
## Building
All "source" files for the frontend logic are located in `framework/client/src`.
The base CMS interface has its own folder with `framework/admin/client/src`.
If you have the `cms` module installed, there's additional files in `cms/client/src`.
All "source" files for the frontend logic are located in `vendor/silverstripe/framework/client/src`.
The base CMS interface has its own folder with `vendor/silverstripe/framework/admin/client/src`.
If you have the `cms` module installed, there's additional files in `vendor/silverstripe/cms/client/src`.
All build commands are run through `npm`. You can check the module's
`package.json` for available commands.
@ -243,8 +243,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
`framework/admin/javascript/src/ModelAdmin.js`, while something modifying all forms (including ModelAdmin forms)
would be better suited in `framework/admin/javascript/src/LeftAndMain.EditForm.js`.
`vendor/silverstripe/framework/admin/javascript/src/ModelAdmin.js`, while something modifying all forms (including ModelAdmin forms)
would be better suited in `vendor/silverstripe/framework/admin/javascript/src/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`.
@ -256,7 +256,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 `framework/thirdparty`) takes care of this transparently -
`jQuery.ondemand` (located in `vendor/silverstripe/framework/thirdparty`) takes care of this transparently -
so as a developer just declare your dependencies through the [Requirements](api:SilverStripe\View\Requirements) API.
## Client-side routing
@ -265,7 +265,7 @@ SilverStripe uses the HTML5 browser history to modify the URL without a complete
window refresh. We us the below systems in combination to achieve this:
* [Page.js](https://github.com/visionmedia/page.js) routing library is used for most
cms sections, which provides additional SilverStripe specific functionality via the
`admin/client/src/lib/Router.js` wrapper.
`vendor/silverstripe/admin/client/src/lib/Router.js` wrapper.
The router is available on `window.ss.router` and provides the same API as
described in the
[Page.js docs](https://github.com/visionmedia/page.js/blob/master/Readme.md#api).
@ -543,10 +543,10 @@ 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 `framework/admin/images/sprites/src/btn-icons`,
These icon identifiers relate to icon files in `vendor/silverstripe/framework/admin/images/sprites/src/btn-icons`,
and are sprited into a single file through SCSS and [sprity](https://www.npmjs.com/package/sprity)
(sprites are compiled with `yarn run build`). There are classes set up to show the correct sprite via
background images (see `framework/admin/scss/_sprites.scss`).
background images (see `vendor/silverstripe/framework/admin/scss/_sprites.scss`).
Input: `<a href="..." class="ss-ui-button" data-icon="add" />Button text</a>`
@ -589,7 +589,7 @@ Note: You can see any additional HTTP headers through the web developer tools in
The CMS tree for viewing hierarchical structures (mostly pages) is powered
by the [jstree](http://jstree.com) library. It is configured through
`framework/admin/javascript/src/LeftAndMain.Tree.js`, as well as some
`client/src/legacy/LeftAndMain.Tree.js` in the `silverstripe/admin` module, as well as some
HTML5 metadata generated on its container (see the `data-hints` attribute).
For more information, see the [Howto: Customise the CMS tree](/developer_guides/customising_the_admin_interface/how_tos/customise_cms_tree).

3
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/04_Preview.md
View File

@ -88,7 +88,8 @@ to the `LeftAndMain.extra_requirements_javascript` [configuration value](../conf
```
In order to find out which configuration values are available, the source code
is your best reference at the moment - have a look in `framework/admin/javascript/src/LeftAndMain.Preview.js`.
is your best reference at the moment - have a look in `LeftAndMain.Preview.js`
in the `silverstripe/admin` module.
To understand how layouts are handled in the CMS UI, have a look at the
[CMS Architecture](cms_architecture) guide.

2
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/Customise_CMS_Tree.md
View File

@ -4,7 +4,7 @@
The CMS tree for viewing hierarchical structures (mostly pages) is powered
by the [jstree](http://jstree.com) library. It is configured through
`framework/admin/javascript/src/LeftAndMain.Tree.js`, as well as some
`client/src/legacy/LeftAndMain.Tree.js` in the `silverstripe/admin` module, as well as some
HTML5 metadata generated on its container (see the `data-hints` attribute).
The tree is rendered through [LeftAndMain::getSiteTreeFor()](api:SilverStripe\Admin\LeftAndMain::getSiteTreeFor()),

3
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/Extend_CMS_Interface.md
View File

@ -24,7 +24,8 @@ 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 `framework/admin/templates/Includes/LeftAndMain_Menu.ss`
Copy the template markup of the base implementation at `templates/SilverStripe/Admin/Includes/LeftAndMain_Menu.ss`
from the `silverstripe/admin` module
into `mysite/templates/Includes/LeftAndMain_Menu.ss`. It will automatically be picked up by
the CMS logic. Add a new section into the `<ul class="cms-menu-list">`