DOC Document code moved from cms to framework #625

GuySartorelli · 2024-11-11T03:14:21Z

Issue

Don't hardcode SiteTree in CMSMain silverstripe-cms#2947

GuySartorelli · 2024-11-11T03:15:18Z

en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/Customise_CMS_Tree.md

Note the rest of the docs on this page will be retouched in silverstripe/silverstripe-cms#2951

GuySartorelli · 2024-11-11T03:15:55Z

en/08_Changelogs/6.0.0.md

+
+- The `SiteTree.description` configuration property has been renamed to [`class_description`](api:SilverStripe\ORM\DataObject->class_description).
+    This configuration has been added to `DataObject` along with the corresponding [`classDescription()`](api:SilverStripe\ORM\DataObject::classDescription()) and [`i18n_classDescription()`](api:SilverStripe\ORM\DataObject::i18n_classDescription()) methods.
+- The [`Hierarchy`](api:SilverStripe\ORM\Hierarchy\Hierarchy) extension now has a bunch of configuration and methods which used to be exclusive to `SiteTree`.


Part of silverstripe/silverstripe-cms#2951 will be updating the CMS Tree docs which will explain more about Hierarchy and how it's used - when that happens this note will link to that page.

This note will link to that page? I'm not sure what this means? Does that mean you need to add something else to this PR?

When silverstripe/silverstripe-cms#2951 is done, it will include new documentation about how Hierarchy works. I will be adding a link to that new page to this bullet point (something like "see for more details")

Nothing to add for this PR. It's just a note about why this bullet point doesn't currently link away to more details (because there isn't appropriate docs for that right now) and seems a bit vague on its own.

en/08_Changelogs/6.0.0.md

GuySartorelli · 2024-11-25T01:06:49Z

Yup, forgot to update this. The whole "actually using it" thing was gonna be done in minors originally. Will update this now.

en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/Customise_CMS_Tree.md

GuySartorelli · 2024-11-25T02:06:41Z

en/_images/page_node_normal.png

Not used anymore in favour of the new screenshots

status-flag.png shouldn't include the fluent icons since most install won't have those, so this may confuse people why their site does not have them

status-flags-custom.png has misaligned text in the badges

status-flag.png shouldn't include the fluent icons since most install won't have those, so this may confuse people why their site does not have them

I've explicitly mentioned fluent as a thing that can add status flags, and pointed out that those status flags specifically come from there. Fluent is a supported module. I don't see anything wrong with including them in this screenshot and I don't think it's a valuable use of my time to retake this one.

Having it there also provides an example of multiple status flags in the breadcrumbs in CMSMain which would otherwise not be shown. I don't want to add a custom one in this screenshot - that's what status-flags-custom.png is for.

status-flags-custom.png has misaligned text in the badges

It's a screenshot of how it looks.

emteknetnz · 2024-11-26T00:01:45Z

en/_images/page_node_normal.png

status-flag.png shouldn't include the fluent icons since most install won't have those, so this may confuse people why their site does not have them

status-flags-custom.png has misaligned text in the badges

emteknetnz · 2024-11-26T00:02:42Z

en/08_Changelogs/6.0.0.md

+
+This is already used to show what locale the data is in for models localised using [`tractorcow/silverstripe-fluent`](https://github.com/tractorcow-farm/silverstripe-fluent/), and what versioned stage it's in for models using the [`Versioned`](api:SilverStripe\Versioned\Versioned) extension.
+
+Status flags are displayed in breadcrumbs at the top of edit forms in the CMS, in the site tree for `CMSMain`, for each row in a grid field, and in [``]() and [``]().


and in ]() and [

Looks like you've forgotten to fill in some text and links here

Oops, will fix this.

emteknetnz · 2024-11-26T00:03:48Z

en/08_Changelogs/6.0.0.md

+
+- The `SiteTree.description` configuration property has been renamed to [`class_description`](api:SilverStripe\ORM\DataObject->class_description).
+    This configuration has been added to `DataObject` along with the corresponding [`classDescription()`](api:SilverStripe\ORM\DataObject::classDescription()) and [`i18n_classDescription()`](api:SilverStripe\ORM\DataObject::i18n_classDescription()) methods.
+- The [`Hierarchy`](api:SilverStripe\ORM\Hierarchy\Hierarchy) extension now has a bunch of configuration and methods which used to be exclusive to `SiteTree`.


This note will link to that page? I'm not sure what this means? Does that mean you need to add something else to this PR?

emteknetnz · 2024-11-26T00:10:57Z

en/02_Developer_Guides/15_Customising_the_Admin_Interface/07_Status_Flags.md

+    private static array $db = [
+        'IsPublishScheduled' => 'Boolean',
+    ];
+
+    public function getStatusFlags(bool $cached = true): array
+    {
+        $this->beforeExtending('updateStatusFlags', function (array &$flags) {
+            if ($this->IsPublishScheduled) {
+                $flags['scheduledtopublish'] = _t(__CLASS__ . 'SCHEDULE_PUBLISH', 'Scheduled To publish');


Suggested change

private static array $db = [

'IsPublishScheduled' => 'Boolean',

];

public function getStatusFlags(bool $cached = true): array

{

$this->beforeExtending('updateStatusFlags', function (array &$flags) {

if ($this->IsPublishScheduled) {

$flags['scheduledtopublish'] = _t(__CLASS__ . 'SCHEDULE_PUBLISH', 'Scheduled To publish');

private static array $db = [

'MyColour' => 'Varchar',

];

public function getStatusFlags(bool $cached = true): array

{

$this->beforeExtending('updateStatusFlags', function (array &$flags) {

if (in_array($this->MyColour, ['Red', 'Green'])) {

$flags['mycolour'] = $this->MyColour;

I think it's better to just use arbitary example data rather than using "IsPublishScheduled" which kind of implies there's "scheduled publishing" functionality somewhere in the CMS, and I think we should just avoid "publishing" in general here as that's related to Versioning, and the point of this is we're abstracting out something that's traditionally been there mostly just there to provide versioned status badges

Also I don't think including the _t() function here is helpful as that's another concept all together, and I think the example should only be demonstrating the primary things it's trying to demonstrate

The simpler the example is the easier it is to follow

As discussed in person since the problem you had was the word "published" because it's similar to versioning concepts I've just reworked it to avoid that word while still giving a meaningful example that hints at the sorts of use cases this might have.

I think using _t() in examples promotes best practice but as discussed will leave it out for the sake of getting this merged.

I've also updated the screenshot so it reflects the custom flag from the example.

emteknetnz · 2024-11-26T00:13:09Z

en/02_Developer_Guides/15_Customising_the_Admin_Interface/07_Status_Flags.md

+You can include additional context which will be displayed when hovering over your status flags. This is done using an associative array where the main text of the flag is in the `text` key, and the additional information is in the `title` key:
+
+```php
+namespace App\Model;


I think this example should be changed like I've recommended above i.e. just use "MyColour" and don't use _t()

GuySartorelli marked this pull request as draft November 11, 2024 03:14

GuySartorelli mentioned this pull request Nov 11, 2024

Don't hardcode SiteTree in CMSMain silverstripe/silverstripe-cms#2947

Closed

7 tasks

GuySartorelli commented Nov 11, 2024

View reviewed changes

GuySartorelli force-pushed the pulls/6/move-from-cms branch from a0b6045 to f5e36bf Compare November 14, 2024 04:21

GuySartorelli marked this pull request as ready for review November 14, 2024 04:40

GuySartorelli force-pushed the pulls/6/move-from-cms branch from f5e36bf to b11c4d8 Compare November 21, 2024 00:19

emteknetnz requested changes Nov 25, 2024

View reviewed changes

en/08_Changelogs/6.0.0.md Outdated Show resolved Hide resolved

GuySartorelli force-pushed the pulls/6/move-from-cms branch from b11c4d8 to a4a1491 Compare November 25, 2024 02:04

GuySartorelli commented Nov 25, 2024

View reviewed changes

en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/Customise_CMS_Tree.md Outdated Show resolved Hide resolved

GuySartorelli force-pushed the pulls/6/move-from-cms branch from a4a1491 to cd521d7 Compare November 25, 2024 02:06

GuySartorelli commented Nov 25, 2024

View reviewed changes

emteknetnz requested changes Nov 26, 2024

View reviewed changes

GuySartorelli force-pushed the pulls/6/move-from-cms branch from cd521d7 to a488f00 Compare November 26, 2024 05:27

DOC Document code moved from cms to framework

2923bbe

GuySartorelli force-pushed the pulls/6/move-from-cms branch from a488f00 to 2923bbe Compare November 26, 2024 05:30

emteknetnz approved these changes Nov 26, 2024

View reviewed changes

emteknetnz merged commit edf38cd into silverstripe:6 Nov 26, 2024
3 checks passed

emteknetnz deleted the pulls/6/move-from-cms branch November 26, 2024 06:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC Document code moved from cms to framework #625

DOC Document code moved from cms to framework #625

GuySartorelli commented Nov 11, 2024

GuySartorelli Nov 11, 2024

GuySartorelli Nov 11, 2024

emteknetnz Nov 26, 2024

GuySartorelli Nov 26, 2024 •

edited

Loading

GuySartorelli commented Nov 25, 2024

GuySartorelli Nov 25, 2024

emteknetnz Nov 26, 2024

GuySartorelli Nov 26, 2024 •

edited

Loading

GuySartorelli Nov 26, 2024

emteknetnz Nov 26, 2024

emteknetnz Nov 26, 2024

GuySartorelli Nov 26, 2024

GuySartorelli Nov 26, 2024

emteknetnz Nov 26, 2024

emteknetnz Nov 26, 2024

GuySartorelli Nov 26, 2024

emteknetnz Nov 26, 2024

GuySartorelli Nov 26, 2024


		This is already used to show what locale the data is in for models localised using [`tractorcow/silverstripe-fluent`](https://github.com/tractorcow-farm/silverstripe-fluent/), and what versioned stage it's in for models using the [`Versioned`](api:SilverStripe\Versioned\Versioned) extension.

		Status flags are displayed in breadcrumbs at the top of edit forms in the CMS, in the site tree for `CMSMain`, for each row in a grid field, and in [``]() and [``]().

DOC Document code moved from cms to framework #625

DOC Document code moved from cms to framework #625

Conversation

GuySartorelli commented Nov 11, 2024

Issue

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuySartorelli Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

GuySartorelli commented Nov 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuySartorelli Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuySartorelli Nov 26, 2024 •

edited

Loading

GuySartorelli Nov 26, 2024 •

edited

Loading