Robse Client Manual

説明

When a web agency hands a site over, the client’s first question is usually
“where do I click to change this?”. A PDF sent by email gets lost. Robse Client
Manual keeps the answer inside the admin, next to the screens the client uses.

You write the manuals in the block editor. Your clients read them. Only
administrators can create, edit or delete a manual; editors, authors and other
roles can only read.

Features

  • Any number of manuals, with contents. The reading screen lists the manuals
    on the left and builds an “On this page” list from the H2 and H3 headings.
    Set the order with the Order field.
  • Search. A keyword search across every manual, with the matching passage
    highlighted.
  • Choose who sees each manual. Pick roles per manual (for example, only
    Editors). Leave it empty to show it to everyone. People who can see no manual
    do not get the menu at all.
  • “How to use this screen”. Link a manual to admin screens such as the Posts
    list or the Media Library. Those screens then show a button in the toolbar and
    a tab in the Help panel that open the manual. Administrators can see each
    screen’s ID in the Help panel, so any screen — including ones added by other
    plugins — can be linked.
  • Dashboard notice. A notice at the top of the Dashboard points new users to
    the manual. Its title, text and button, and the menu label, can be changed.
  • Print or save as PDF. Print a single manual, or all of them with a cover
    and contents, one manual per page.
  • Export and import. Save every manual to a JSON file and import it on the
    next client’s site, so you do not rewrite the same instructions for every
    project.
  • Starter manuals. On first activation, four short manuals are created in
    the site language: Getting started, Writing a post, Adding images and Logging
    out.

The plugin makes no external requests and adds nothing to the front end of
the site.

インストール

  1. Install the plugin from Plugins > Add New, or upload the robse-client-manual
    folder to /wp-content/plugins/.
  2. Activate it. A Client Manual menu appears with four starter manuals.
  3. Edit the starter manuals for your client’s site, or add your own from
    Client Manual > Add New.
  4. Give your client an Editor account (an Administrator could edit the manuals).

FAQ

Who can edit the manuals?

Only users with the manage_options capability — normally administrators.
Everyone else can only read the manuals they are allowed to see.

How do I change the order?

Use the Order field in the editor’s sidebar. Lower numbers come first. The
starter manuals use 10, 20, 30 and 40.

The screen I want is not in the list of screens

Open that screen as an administrator, open Help at the top right and choose
the “Manual link” tab. It shows the screen ID. Enter it under “Other screen
IDs” in the manual’s Display settings box.

The block editor does not show the toolbar or the Help panel, so the button
cannot appear while a post is being edited in it.

Images are missing after an import

Image URLs in the content still point to the site the manuals were exported
from. Replace the images after importing if that site is not reachable.

Is the imported content filtered?

Yes. Imported content is passed through wp_kses_post(), so scripts and other
unsafe markup are removed even when an administrator imports the file.

What happens to the manuals if I delete the plugin?

They stay in the database. Deleting the plugin removes only its settings. Move
the manuals to the Trash first if you want them gone.

I used version 2.0.0 from robse.jp

Install this version over it. Settings and per-manual visibility are carried
over automatically.

評価

このプラグインにはレビューがありません。

貢献者と開発者

Robse Client Manual はオープンソースソフトウェアです。以下の人々がこのプラグインに貢献しています。

貢献者

“Robse Client Manual” は1ロケールに翻訳されています。 翻訳者のみなさん、翻訳へのご協力ありがとうございます。

“Robse Client Manual” をあなたの言語に翻訳しましょう。

開発に興味がありますか ?

コードを閲覧するか、SVN リポジトリをチェックするか、開発ログを RSS で購読してみてください。

変更履歴

2.1.1

  • Fix help tabs and search excerpts on sites without the optional PHP mbstring extension.
  • Move the Client Manual menu below the standard administration menus while preserving access and links.

2.1.0

  • First release on WordPress.org.
  • Interface translated through translate.wordpress.org (written in English).
  • Internal prefix changed from rcm to robse_cm; settings and visibility from 2.0.0 are migrated.
  • Removed the code that hid updates for this plugin.

2.0.0

  • Multiple manuals with contents, in-page contents, previous/next links and ordering.
  • Search across manuals.
  • Per-manual visibility by role.
  • “How to use this screen” toolbar button and Help tab.
  • Settings for the Dashboard notice and the menu label.
  • Print one or all manuals (save as PDF).
  • Export and import as JSON.

1.2.0

  • Dashboard notice, administrator-only editing and a starter manual.