Wiki. Table of content

Transcription

1 Wiki Table of content View and Edit modes... 2 Share an article... 3 Settings... 4 Change the name... 5 Set up permissions... 6 The default behavior... 7 Create an article... 8 Modify an article Article types Article statuses... 13

2 2 View and Edit modes Wiki provides 2 different view modes, View and Edit ones. View mode provides a way to see active and invisible articles only. This mode doesn t have an ability to add or edit articles, only view features are available. Video mode is recommended for customers, support team members, etc. Edit mode provides a way to add or edit articles, display disabled articles as well. In this mode additional data is available on admin page as well. This mode is recommended for administrators. Edit mode can be enabled with settings on Stores > Configuration > General > Wiki page. See Settings for more details.

3 3 Share an article All articles can be viewed not only by clicking on their row on Wiki grid page but also as a separate page. That s useful for sharing articles with other administrators. For that click on View link with the right mouse button and click copy the url. Video and Link articles will be copied as external links to their original source but Page articles will be shown on a separate page with a link back to Wiki grid.

4 4 Settings The extension settings are located on Stores > Configuration > General > Wiki page. Title a title that s displayed in admin for the extension. See Change the name. Edit Mode disable/enable edit mode. See View and Edit modes. Allow Group a list of customer groups that can see the edit mode. See Set up permissions. Allow User a list of users who can see the edit mode. See Set up permissions. Action an action for Wiki button. See The default behavior. Permission settings can be found on System > User Roles page. See Set up permissions. Flush cache after any changes to apply them.

5 5 Change the name The default title of the extension is Wiki. The title is visible on every admin page in the left menu as the bottom element (if the administrator has rights to see it), on Wiki grid page as the title, on Permission list page (ACL) and on Stores > Configuration page. It can be changed in the settings for branding or similar purposes. See Settings for more details.

6 6 Set up permissions The extension has several permission levels and settings to display it to appropriate admin users only. On permission configuration page you can configure access for Settings page to make it visible for super admins only. There you can also configure permissions for the main Wiki button in the left menu and access to the other pages with View settings. The settings are good for configuring visibility of the extension. If an administrator tries to get to unavailable for them page, they will see an error message. On Stores > Configuration > General > Wiki page you can configure Edit mode permissions. Edit mode is a superb way to work with wiki articles. To make it available to administrators you have the following settings: You can make it available to a specific customer groups and/or certain customers. It works as All of selected user groups + selected Users have an ability to use the edit mode. If none of them selected, all administrators will have edit mode enabled.

7 7 The default behavior You can modify behavior of the Wiki link in the left menu. The default behavior is open a list of available articles. It can be changes to open a selected article (a page article will be opened in the same tab as an article page, a link/video article will be opened as a new tab with the content) on Stores > Configuration > General > Wiki page. If not the default behavior was selected, it disables Wiki grid page, by the url/the link in the left menu the selected article will be displayed instead. If an administrator has edit mode enabled, they will see Wiki grid page as usually. If a page article was selected, the page article won t have a link back to the list page.

8 8 Create an article Creation and modification articles are possible only when edit mode is enabled for the current administrator. To add a new article, open Wiki grid page and click on Add New Article. Create screen. Article # an article number. It may be any number that you want to set for that article. The number is displayed on Wiki grid page in # column. When you create a new article, the fields will be filled out with an auto-suggested number. The auto-suggested number is counted on visible articles (enabled) only. Title an article title. It s displayed on Wiki grid page and on Page article pages. Description a short description that will be displayed on Wiki grid page. Status an article status, can be Disabled/Invisible/Enabled. See Article statuses. Type an article type, can be Video/Link/Page. See Article types. Content fields depend on a selected type. Link a link field, use it to set a link to a YouTube video or an external source. Displayed for Video and Link articles only.

9 9 Content a WYSIWYG field, use it to write page articles. The field supports copy/past styles. You can add links to other articles there. Use {{block class="oxislab\wiki\block\adminhtml\link" caption="custom_title" id="article_id"}} for that. Id must be an article id, you can see it on Wiki grid page when you have edit mode enabled. caption a custom title for the link. If it s missed, the article title will be used instead. Only visible (Enabled and Invisible) articles will be shown on the article page.

10 10 Modify an article Creation and modification articles are possible only when edit mode is enabled for the current administrator. To modify an article, click on Edit link below View. The edit screen is similar to create one but has some new elements. Created at a date of creation. Updated at a date of the last modification. Preview is a link for testing the article, it mimics the behavior of clicking on View link or a row on Wiki grid page.

11 11 Article types 1. Link A link article has a link to external resource. By clicking on a row/an article link, the link will be opened in a new tab. Note: Page and Video articles can be viewed immediately on Wiki grid page without refreshing the page. A page article can nave links to other articles inside of it and they will have the same features. 2. Video A video article has a link to YouTube or Vimeo. By clicking on a row/an article link, a video player will be run with the provided video source.

12 12 3. Page A page article has its own content and may have links to other articles. By clicking on a row/an article link, a page will be shown.

13 13 Article statuses There are 3 statues: 1. Disabled the article is not visible on Wiki grid page and in other articles as a link. It will be visible on Wiki grid page when you ve logged in as an administrator who has Edit mode enabled. 2. Invisible the article isn t visible on Wiki grid page but visible in other articles as a link. It will be visible on Wiki grid page as well when you ve logged in as an administrator who has Edit mode enabled. 3. Enabled the article is visible on Wiki grid page and in other articles as a link.