Simple Documentation

描述

This plugin helps webmasters/developers to provide documentation through the wordpress dashboard.

This plugins allows you to share 4 types of content:

  • “Link” It is a simple link with a custom title and url which will open in a new tab
  • “Video” Allow you to put an embed code from websites like Youtube, Vimeo, ScreenR (all the ones which gives you iframe based code)
  • “Quick Note” This a short text which intend to help by giving a short tip! (for longer content use Links!)
  • “File” Upload a file to the wordpress installation and display the link. (The file link can be filled manually if you upload content by FTP).

As an administrator, you can add, edit or remove content, choose the number of items displayed per page in the widget, the targeted backend user role and customize the widget title and welcome message.

Backend Users and Administrators can pin items to highlight them.

I’m currently working on rewriting this plugin from scratch in order to improve its reliability and make it easier to maintain. Thanks for your patience.

Features

  • Multisite support
  • Import / Export

Languages

Contribute

You can submit issues and pull request on Github

螢幕截圖

  • Simple Documentation in your dashboard
  • Main editor. Choose between different type of content
  • Setting page

安裝

The installation is not tricky. It’s simple as activating the plugin and Add content !
Hit the import/export button to copy your installation on multiple WP installations.

常見問題

What’s happenning when I delete this plugin ?

All the data stored in your database and WordPress options are also deleted ! When the plugin is desactivated, all data remains in your database.

How to add code snippets to my notes ?

You must add your code snippet between <code> tags.

評價

2017年7月16日
While using WP 4.8, this plugin installed, activated, but does not work. I edited the first example doc they had, but when I went to add a new one, it simply overwrote the first one with a blank document. So, both were now gone and I cannot add anymore. Broken.
2016年9月3日
This plug-in is exactly what I need to bring some documentation for my clients right to the WordPress backend dashboard. I only miss the possibility to add images to the documentation.
2016年9月3日
I've been using this off and on for a couple of years and it just keeps getting better. Run into a few issues along the way, but nothing insurmountable. Thank you @mathieuhays
閱讀全部15個評價

貢獻者及開發者

“Simple Documentation” 是一個開源的軟體。以下的人對這個外掛作出了貢獻。

貢獻者

Simple Documentation 外掛目前已有 1 個本地化語言版本。 感謝所有譯者為這個外掛做出的貢獻。

將 Simple Documentation 外掛本地化為台灣繁體中文版。

對開發相關資訊感興趣?

任何人均可瀏覽程式碼、查看 SVN 存放庫,或透過 RSS 訂閱開發記錄

修改日誌

1.2.8

  • Fix potential plugin conflict

1.2.7

  • [Security] Fix vulnerability

1.2.6

  • Fix bug when trying to add empty item
  • Add compatibility with translate.wordpress.org

1.2.5

  • Fix bug when using the editor in “Text” mode

1.2.4

  • Fix file attachment edition issues

1.2.3

1.2.2

  • Remove slashes appearing after editing an item.

1.2.1

  • User restriction issue fix.

1.2.0

  • Re-order by Drag & Drop
  • Per item user limitation
  • Serbo-Croatian adapted from version 1.1.8 version. (Provided by Borisa Djuraskovic)

1.1.8

  • German translation improved
  • Text edition. Correction.

Thanks to Alexander Pfabel and Vernon Fowler.

1.1.7

1.1.6

  • Video and File edition Fix
  • Retina support on Menu icon
  • Loading statement added on edit/add buttons.

1.1.5

  • Now you can add code snippets in note using <code> tag.
  • <br> tag fix on note and video

1.1.4

  • Edit field MySQL optimization
  • Quick note and Video now support br tag
  • Menu position conflicts fixed

1.1.3

  • Field edition fix.
  • Basic html support added to quick note content. (a,strong,b,em,i)

1.1.2

  • MP6 optimization on modal box
  • Cache issue fix

1.1.1

  • CSS version fix

1.1.0

  • Multisite basic support
  • Import / Export feature added
  • String issues fixed.
  • Welcome, Pinned and All items customization added.

1.0.4

  • Welcome message now support HTML tags
  • Video height issue fixed

1.0.3

  • Add Welcome message customization
  • Custom role support

1.0.2

  • Icons fix

1.0.1

  • Plugin’s Name and Description Fix

1.0

  • Initial Version