Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC Update syntax for callout blocks #180

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/en/01_Managing_your_website/00_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,8 @@ The Navigation toolbar area shows various data relating to individual pages such

The Action toolbar at the bottom of the page allows you to save, publish (make publicly available), unpublish (return to draft), unpublish and archive (remove from site tree) or add to a campaign.

[note]
Depending on your CMS setup you may see further functionality provided by modules in the Action toolbar.
[/note]
> [!NOTE]
> Depending on your CMS setup you may see further functionality provided by modules in the Action toolbar.

![SS4 publishing options](../_images/publishing-options.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,15 @@ Navigate to the tab ***Users*** and click the button ***Add Member***.

In the **New Member** section, you can edit the user's details. The two most important parts of the user's details are the email (which is also used for logging in) and password.

[note]
By default, an email address can only be used once in the system. It is not possible for multiple users to share the same email address.
[/note]
> [!NOTE]
> By default, an email address can only be used once in the system. It is not possible for multiple users to share the same email address.

![User details](../_images/user-details.png)

[note]
Users can be in multiple groups. If you delete a user from a group, they are only removed from that group, not from the system. To fully delete a user from the system, you need to be in the root of Security.

Click the link ***Security*** in the breadcrumbs or click the button ***Back*** which is shown as a left arrow icon.
[/note]
> [!NOTE]
> Users can be in multiple groups. If you delete a user from a group, they are only removed from that group, not from the system. To fully delete a user from the system, you need to be in the root of Security.
>
> Click the link ***Security*** in the breadcrumbs or click the button ***Back*** which is shown as a left arrow icon.

## Changing a user's password

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ Security groups are collections of users, and whatever permissions they have app

One of the ways that the two can be used together is to assign similar roles to different groups. You only need to define an "editor" role once, but by applying the "editor" role to different groups with different access to different pages, so if you assigned the "editor" role to both the marketing team and development team security groups, the marketing team would be able to edit the marketing pages, and the development team would be able to edit the development pages, but they would not be able to edit each other's pages.

[note]
Groups represent a group of members, and you can assign a Group with a set of roles which are descriptors for various permissions in the system e.g. a group which has the "Administrator" role, allows access to the CMS.
[/note]
> [!NOTE]
> Groups represent a group of members, and you can assign a Group with a set of roles which are descriptors for various permissions in the system e.g. a group which has the "Administrator" role, allows access to the CMS.

## Using roles

Expand All @@ -57,9 +56,8 @@ To navigate back to the Roles section either click the link ***Security*** in th

![Creating roles](../_images/creating-roles.png)

[note]
A role can have any number of permissions. For example, an author typically has "Access to Site Content," (they can access the "Site Content" section in the CMS; the part where all content is managed), "Access to Files & Images," (they can browse the "Files and Images" section in the CMS, organise assets in folders, upload new assets, etc.), and "Change site structure," (they can change the location for a page in the site tree and manage the site structure and navigation).
[/note]
> [!NOTE]
> A role can have any number of permissions. For example, an author typically has "Access to Site Content," (they can access the "Site Content" section in the CMS; the part where all content is managed), "Access to Files & Images," (they can browse the "Files and Images" section in the CMS, organise assets in folders, upload new assets, etc.), and "Change site structure," (they can change the location for a page in the site tree and manage the site structure and navigation).

## Editing roles

Expand All @@ -80,9 +78,8 @@ Unlike roles, there are no basic groups that typically apply to all sites. Inste
3. In the ***Members*** tab add the group name in the **Group Name** field.
4. Click the button ***Create***.

[note]
We recommend you set up a top-level group for your entire site, as well as for each section that is managed by specific people.
[/note]
> [!NOTE]
> We recommend you set up a top-level group for your entire site, as well as for each section that is managed by specific people.

You can nest groups, and create sub-groups which may represent different roles. The parent group acts as a place to organise different subgroups. In this case, it's probably best not to add members directly to the parent group.

Expand All @@ -96,18 +93,16 @@ You can nest groups, and create sub-groups which may represent different roles.

If you wish to add a new member instead of choosing from an already established member, click the button ***Add Member***.

[note]
Users can be in multiple groups. If you delete a user from a group, they are only removed from that group, not from the system. To fully delete a user, you need to be in the root of Security. To reach the security group root click the link ***Security*** or the ***Back*** button which is shown as a left arrow in the Navigation toolbar.
[/note]
> [!NOTE]
> Users can be in multiple groups. If you delete a user from a group, they are only removed from that group, not from the system. To fully delete a user, you need to be in the root of Security. To reach the security group root click the link ***Security*** or the ***Back*** button which is shown as a left arrow in the Navigation toolbar.

## Editing and deleting groups

1. To edit a group, click the Group Name list item. This opens the group details. You can change the Group name, and add, edit or delete members.
2. To delete a group, click the ***Delete*** button shown as a trash icon.

[note]
Note that a single user can belong to more than one group and that deleting a group does not delete its members.
[/note]
> [!NOTE]
> Note that a single user can belong to more than one group and that deleting a group does not delete its members.

## Assigning roles to security group members

Expand Down
5 changes: 2 additions & 3 deletions docs/en/01_Managing_your_website/03_Changing_Your_Password.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,5 @@ summary: Guidance on how to change the password of your Silverstripe CMS account
4. Enter your current, new and confirmed password.
5. Click the button ***Save***.

[note]
You can also update your e-mail address and name.
[/note]
> [!NOTE]
> You can also update your e-mail address and name.
15 changes: 6 additions & 9 deletions docs/en/01_Managing_your_website/04_Session_Manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ The session manager module allows members to manage (see active and revoke) logi

When logging in with *_Keep me signed in for 30 days_*" checked, a session will remain active on that device for the full 30 days unless it is terminated prior to that allocated timeframe. Without this option checked, a session will only last for the duration of your browser session.

[notice]
You should not use the "Keep me signed in" functionality when working on a device shared with other users (e.g.: internet café computer or a public library workstation).
[/notice]
> [!WARNING]
> You should not use the "Keep me signed in" functionality when working on a device shared with other users (e.g.: internet café computer or a public library workstation).

![Silverstripe CMS log in form](../_images/session-manager-logging-in.png)

Expand All @@ -37,16 +36,14 @@ There is various data associated with every login session that can be used to id
* Last active time
* Sign-in time

[notice]
A member can only view login sessions for their own profile. No one else will have access to view your sessions.
[/notice]
> [!WARNING]
> A member can only view login sessions for their own profile. No one else will have access to view your sessions.

## Revoking access

To remove access for a session associated with a device, click the **Log out** link next to the session you want to remove. This session will be immediately removed and anyone viewing the CMS using this session will need to log back in.

Administrators can also revoke _all_ active sessions for _all_ users by triggering the `dev/tasks/InvalidateAllSessions` task either in the browser or via the CLI. Note that this will also revoke the session of the user activating the task, so if this is triggered via the browser, that user will need to log back in to perform further actions.

[notice]
With exception to the invalidate all sessions task, a member can only revoke access for their _own_ profile. No one else will have access to remove your sessions.
[/notice]
> [!WARNING]
> With exception to the invalidate all sessions task, a member can only revoke access for their _own_ profile. No one else will have access to remove your sessions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ For example, if you'd like to create a new page in the "About Us" section of you

![Adding a page](../../_images/adding-a-page.png)

[note]
Different page types will usually have different content fields to fill in, and may also have a slightly different layout when the page is viewed. Depending on the functionality of your site, you may also be able to create "News Article" page types etc.
[/note]
> [!NOTE]
> Different page types will usually have different content fields to fill in, and may also have a slightly different layout when the page is viewed. Depending on the functionality of your site, you may also be able to create "News Article" page types etc.

Don't worry if you create your page in the wrong location. Pages can be moved and re-ordered easily, see [Reordering Pages](reordering_pages/) to learn more.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ You can preview how the current snapshot looked on the site, by switching to **P
3. Click the button ***Revert to this version***, once you have located the snapshot that you want to roll back to.
4. The page will be rolled back to this version. Click the button ***Publish*** to make it live.

[note]
When a page is rolled back to the previous version, it is only rolled back in the backend CMS as a draft. To show the rolled back page on the public-facing website, it needs to be published.
[/note]
> [!NOTE]
> When a page is rolled back to the previous version, it is only rolled back in the backend CMS as a draft. To show the rolled back page on the public-facing website, it needs to be published.

## Comparing Snapshots

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,12 @@ introduction: You can hide a page so it will not appear in the website navigatio
If you are changing the search visibility on an existing page, it may take a few weeks for the page to disappear from search engine results.
5. Click the button ***Publish***.

[note]
You can see which pages are hidden by the page names colored grey in the site tree.
[/note]
> [!NOTE]
> You can see which pages are hidden by the page names colored grey in the site tree.

Only people who have access to the full page URL will be able to find the page. However, you can still link to the page from other pages, see [Inserting links](../creating_and_editing_content/inserting_links) to learn more.

![Page visibility](../../_images/Hiding-Pages.png)

[note]
You can either choose to hide the page from the menus or from search engines, you do not need to do both.
[/note]
> [!NOTE]
> You can either choose to hide the page from the menus or from search engines, you do not need to do both.
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ summary: Performing actions on multiple pages at once.
2. Select the action **Publish** to perform from the dropdown field.
3. Select any number of pages you want to publish, and click the button ***Go*** to perform the selected action.

[note]
Available pages for the selected action will have checkbox fields beside them.
[/note]
> [!NOTE]
> Available pages for the selected action will have checkbox fields beside them.

### Archiving multiple pages

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,8 @@ If your website includes other features specific to all pages you may see other

![Editing page fields](../../_images/Page-Fields.png)

[note]
Every time you click the button ***Save*** or ***Publish*** a snapshot of the page is saved in history, which you can then revert to at any time, see [Rolling Back Pages](../pages/rolling_back_pages) to learn more.
[/note]
> [!NOTE]
> Every time you click the button ***Save*** or ***Publish*** a snapshot of the page is saved in history, which you can then revert to at any time, see [Rolling Back Pages](../pages/rolling_back_pages) to learn more.

## Formatting content

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ introduction: If you've made some substantial changes to a page, and want to che

# Previewing changes

[note]
Remember when editing content to save your page regularly.
[/note]
> [!NOTE]
> Remember when editing content to save your page regularly.

Click the button ***Save*** in the publishing bar.

Expand All @@ -21,11 +20,10 @@ You can either:

![Preview mode site draft](../../_images/preview-draft-published.png)

[note]
Some data doesn't have draft and published states. When editing data like that you might instead see the simple ***Preview*** state.

![Preview mode no draft or published states](../../_images/preview-unversioned.png)
[/note]
> [!NOTE]
> Some data doesn't have draft and published states. When editing data like that you might instead see the simple ***Preview*** state.
>
> ![Preview mode no draft or published states](../../_images/preview-unversioned.png)

## Previewing your changes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ Files can be displayed or linked to from multiple places. This means that by upd

You can either upload files within the Files section or directly from pages through the HTML editor. The Files section supports a range of different file types which are typical for use on the web including images, videos, and documents. See [Web content best practices](/creating_pages_and_content/web_content_best_practices/) for additional tips on how to prepare files for use on the web.

[note]
By default, uploaded files are placed in the "Uploads" directory.
If you place an image in a page, and later move or rename that image the CMS will automatically keep track of those changes, so your webpage will remain unchanged—you don't even have to republish the page.
[/note]
> [!NOTE]
> By default, uploaded files are placed in the "Uploads" directory.
> If you place an image in a page, and later move or rename that image the CMS will automatically keep track of those changes, so your webpage will remain unchanged—you don't even have to republish the page.

## Uploading images

Expand All @@ -34,15 +33,13 @@ You should now see the files you uploaded within your chosen folder.

![Uploaded files](../../_images/files-uploaded.png)

[note]
This same process can be used for filetypes other than images, see [Linking Documents](linking_documents/) to learn more.
[/note]
> [!NOTE]
> This same process can be used for filetypes other than images, see [Linking Documents](linking_documents/) to learn more.

## Uploading images from a page

[note]
Pages that contain a HTML editor allow you to place files into the content area, some pages don't have a HTML editor area by default and might require a different [Page type](/creating_pages_and_content/pages/creating_new_pages/) or for a Content Block to be added.
[/note]
> [!NOTE]
> Pages that contain a HTML editor allow you to place files into the content area, some pages don't have a HTML editor area by default and might require a different [Page type](/creating_pages_and_content/pages/creating_new_pages/) or for a Content Block to be added.

1. Navigate to your page within the **Pages** section.
2. In the HTML editor click on the button ***Insert from Files*** which is shown as an image icon.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ summary: Linking to internal and external content using hyperlinks.

## Inserting links

[note]
Instead of "Click here" or "Click here to read more about widgets" as the link text, it would be better to say "Read more about widgets". You can also add additional information in the link description field (available to screen readers), although it's best practice that the description is different from the link text and provides additional clarification (otherwise screen readers will read the text twice).
[/note]
> [!NOTE]
> Instead of "Click here" or "Click here to read more about widgets" as the link text, it would be better to say "Read more about widgets". You can also add additional information in the link description field (available to screen readers), although it's best practice that the description is different from the link text and provides additional clarification (otherwise screen readers will read the text twice).

1. You can either type out the link text in the HTML editor or select where you want the link to be added and enter the **Link text** later.
2. Click and drag across the text that you'd like to add a link to, to highlight it.
Expand All @@ -22,9 +21,8 @@ Instead of "Click here" or "Click here to read more about widgets" as the link t
2. Select a page from the **Select a page** dropdown field.
3. Select a page to link and click the button ***Insert link***.

[note]
There are different processes for internal and external links. When pages are moved or deleted, the links on other pages of the site will be automatically changed to the new pages location. This allows you to move pages around without worrying about breaking the site's structure or checking the site for broken links.
[/note]
> [!NOTE]
> There are different processes for internal and external links. When pages are moved or deleted, the links on other pages of the site will be automatically changed to the new pages location. This allows you to move pages around without worrying about breaking the site's structure or checking the site for broken links.

### Anchor on a page

Expand Down Expand Up @@ -56,6 +54,5 @@ Enter the following link specifications:
* Select a file from the CMS.
2. Click the button ***Insert link***.

[note]
You can also add hyperlinks to documents that you have uploaded to your website, such as a PDF file, DOC file, audio file, video file, or any sort of file that is not a webpage. See [Images and documents](images_and_documents) to learn more.
[/note]
> [!NOTE]
> You can also add hyperlinks to documents that you have uploaded to your website, such as a PDF file, DOC file, audio file, video file, or any sort of file that is not a webpage. See [Images and documents](images_and_documents) to learn more.
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ summary: Inserting and resizing images in your content.
4. Locate the image(s) you'd like to insert, and click the button ***Open***.
5. Once the image(s) have uploaded, click the button ***Insert file***. You can select the image in the HTML editor and drag the drag handles to resize to your required size.

[note]
Image files for a website must be in either JPG, GIF, PNG or WebP format. If your image currently exists in a Word or Publisher file, you must first save the image as one of these file types.
[/note]
> [!NOTE]
> Image files for a website must be in either JPG, GIF, PNG or WebP format. If your image currently exists in a Word or Publisher file, you must first save the image as one of these file types.

## Setting the alignment of an image

Expand Down
Loading