/ep_table_of_contents

Table of contents for Etherpad

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Publish Status Backend Tests Status

Builds a table of contents into the Etherpad interface

Enable under settings. Create headings, watch the TOC populate in real time.

Configuration

If you want to have the TOC shown by default, add following snippet to your settings.json:

"ep_toc": {
  "disable_by_default": false
},

You can also set this on a per-pad basis by setting the URL parameter toc to true or false.

If you want to have a button in the toolbar to toggle the TOC, add following snippet to your settings.json:

"ep_toc": {
  "show_button": true
},

License

Copyright 2014, John McLear

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.