Skip to content

Commit 8bf8883

Browse files
briankwestclaude
andcommitted
Remove in-body TOC lists manual-wide; use the auto right-rail TOC everywhere
Drop the manual "## Table of Contents" lists from Parts 1-8 and the appendices (36 pages), matching the Part 9 cleanup. Docusaurus renders an automatic right-rail TOC from the headings on every page; the manual lists were redundant and added a "Table of Contents" self-link as the first right-rail entry. The whole manual now relies on the single clean auto TOC. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent a602093 commit 8bf8883

36 files changed

Lines changed: 0 additions & 771 deletions

docs/applications/conferencing.mdx

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,6 @@ sidebar_label: "20. Conferencing"
1111

1212
FreeSWITCH multi-party audio and video conferencing is provided by `mod_conference`. Callers are bridged into named rooms; each room is governed by a profile that sets codec parameters, audio behaviors, and video mixing options. All configuration lives in `autoload_configs/conference.conf.xml` and `autoload_configs/conference_layouts.conf.xml`.
1313

14-
## Table of Contents
15-
16-
- [Conference Model](#conference-model)
17-
- [conference.conf.xml](#conference-conf-xml)
18-
- [Advertise Block](#advertise-block)
19-
- [Caller Controls](#caller-controls)
20-
- [Profile Parameters](#profile-parameters)
21-
- [Conference Flags](#conference-flags)
22-
- [Member Flags (Profile)](#member-flags-profile)
23-
- [Bundled Profiles](#bundled-profiles)
24-
- [Video Layouts](#video-layouts)
25-
- [Layout Definitions](#layout-definitions)
26-
- [Layout Groups](#layout-groups)
27-
- [The conference Dialplan Application](#the-conference-dialplan-application)
28-
- [Argument Syntax](#argument-syntax)
29-
- [Member Flags at Join Time](#member-flags-at-join-time)
30-
- [Bridge Mode](#bridge-mode)
31-
- [Default Dialplan Conference Extensions](#default-dialplan-conference-extensions)
32-
- [The conference API](#the-conference-api)
33-
- [Membership, Mute, and State](#api-membership-mute)
34-
- [Audio: Energy, AGC, and Volume](#api-audio-energy)
35-
- [Sounds and Playback](#api-sounds-playback)
36-
- [Video](#api-video)
37-
- [Recording](#api-recording)
38-
- [Outbound Dial](#api-outbound-dial)
39-
- [Locking, PIN, and Vars](#api-locking-pin-vars)
40-
- [Listing and Status](#api-listing-status)
41-
42-
---
43-
4414
## Conference Model {#conference-model}
4515

4616
A conference room is identified by a name string. When the `conference` dialplan application is invoked with `roomname@profilename`, FreeSWITCH looks up `profilename` in `conference.conf.xml` and creates the room (if it does not already exist) using that profile's parameters. Subsequent callers who dial the same room name join the existing instance.

docs/applications/fax-t38.mdx

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,6 @@ sidebar_label: "24. Fax and T.38"
1111

1212
FreeSWITCH delivers fax functionality through `mod_spandsp`, a module built on the SpanDSP library. It exposes two dialplan applications for sending and receiving fax documents over audio (G.711) and T.38 (UDPTL), a T.38 gateway mode for bridging between fax endpoints that negotiate different transport types, and a set of channel variables that control behavior at the session level.
1313

14-
## Table of Contents
15-
16-
- [Overview](#overview)
17-
- [Module Configuration](#module-configuration)
18-
- [spandsp.conf.xml Structure](#spandspconfxml-structure)
19-
- [Fax Settings Parameter Reference](#fax-settings-parameter-reference)
20-
- [Receiving a Fax with rxfax](#receiving-a-fax-with-rxfax)
21-
- [Sending a Fax with txfax](#sending-a-fax-with-txfax)
22-
- [T.38 Protocol Support](#t38-protocol-support)
23-
- [T.38 Negotiation via rxfax and txfax](#t38-negotiation-via-rxfax-and-txfax)
24-
- [T.38 Gateway Mode](#t38-gateway-mode)
25-
- [Channel Variable Reference](#channel-variable-reference)
26-
- [Input Variables](#input-variables)
27-
- [Result Variables](#result-variables)
28-
- [Completion Hooks](#completion-hooks)
29-
- [Default Dialplan Examples](#default-dialplan-examples)
30-
31-
---
32-
3314
## Overview {#overview}
3415

3516
`mod_spandsp` must be loaded before fax applications are available. It registers the `rxfax`, `txfax`, `stopfax`, and `t38_gateway` applications and reads its configuration from `autoload_configs/spandsp.conf.xml` at load time and on module reload.

docs/applications/ivr-menus.mdx

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,6 @@ sidebar_label: "21. IVR Menus"
1111

1212
The IVR menu system lets you define prompt-driven digit-collection menus in XML, load them through `mod_dptools`, and invoke them from the dialplan with the `ivr` application. Each menu plays a greeting, collects one or more digits, and dispatches the caller to an action based on what was pressed. Menus can be nested arbitrarily: a digit can launch a submenu, return the caller to the top of the current menu, or back up one level in the stack.
1313

14-
## Table of Contents
15-
16-
- [IVR Menu Model](#ivr-menu-model)
17-
- [Configuration File](#configuration-file)
18-
- [Menu Definition: the `<menu>` Element](#menu-definition-the-menu-element)
19-
- [`<menu>` Attribute Reference](#menu-attribute-reference)
20-
- [Sound and TTS Prefixes](#sound-and-tts-prefixes)
21-
- [PIN Protection](#pin-protection)
22-
- [Callbacks on Failure and Timeout](#callbacks-on-failure-and-timeout)
23-
- [Entries: the `<entry>` Element](#entries-the-entry-element)
24-
- [`<entry>` Action Reference](#entry-action-reference)
25-
- [Digit Patterns and Regular Expressions](#digit-patterns-and-regular-expressions)
26-
- [Nesting Submenus](#nesting-submenus)
27-
- [Invoking a Menu from the Dialplan](#invoking-a-menu-from-the-dialplan)
28-
- [The Bundled Demo IVR](#the-bundled-demo-ivr)
29-
30-
---
31-
3214
## IVR Menu Model {#ivr-menu-model}
3315

3416
An IVR menu is a named XML element that specifies:

docs/applications/queues-fifo-callcenter.mdx

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,6 @@ sidebar_label: "22. Queues: FIFO and Call Center"
1111

1212
FreeSWITCH provides two distinct mechanisms for queuing inbound calls: `mod_fifo`, a lightweight first-in-first-out holding application, and `mod_callcenter`, a full agent-management system with routing strategies, tiers, and lifecycle tracking. This chapter covers the operator-facing configuration of both and explains when each is appropriate.
1313

14-
## Table of Contents
15-
16-
- [Choosing Between FIFO and Call Center](#choosing-between-fifo-and-call-center)
17-
- [mod_fifo: Configuration and the fifo Application](#mod_fifo-configuration-and-the-fifo-application)
18-
- [fifo.conf.xml Settings](#fifoconfxml-settings)
19-
- [Declaring a FIFO Node](#declaring-a-fifo-node)
20-
- [Outbound Members](#outbound-members)
21-
- [The fifo Dialplan Application](#the-fifo-dialplan-application)
22-
- [FIFO Channel Variables](#fifo-channel-variables)
23-
- [The fifo_track_call Application](#the-fifo_track_call-application)
24-
- [mod_fifo API Commands](#mod_fifo-api-commands)
25-
- [mod_callcenter: Concepts and Loading](#mod_callcenter-concepts-and-loading)
26-
- [Call Center Queue Configuration](#call-center-queue-configuration)
27-
- [Queue Parameter Reference](#queue-parameter-reference)
28-
- [Agent Configuration](#agent-configuration)
29-
- [Agent Parameter Reference](#agent-parameter-reference)
30-
- [Tier Assignment](#tier-assignment)
31-
- [Tier Parameter Reference](#tier-parameter-reference)
32-
- [The callcenter Dialplan Application](#the-callcenter-dialplan-application)
33-
- [Global Settings for mod_callcenter](#global-settings-for-mod_callcenter)
34-
- [mod_callcenter API Commands](#mod_callcenter-api-commands)
35-
- [callcenter_config agent](#callcenter_config-agent)
36-
- [callcenter_config tier](#callcenter_config-tier)
37-
- [callcenter_config queue](#callcenter_config-queue)
38-
- [callcenter_break](#callcenter_break)
39-
40-
---
41-
4214
## Choosing Between FIFO and Call Center {#choosing-between-fifo-and-call-center}
4315

4416
| Capability | `mod_fifo` | `mod_callcenter` |

docs/applications/utility-applications.mdx

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,6 @@ sidebar_label: "23. Utility Applications"
1111

1212
This chapter documents the operator-facing utility modules that ship with FreeSWITCH. Each module is treated as a self-contained unit: its configuration file (where one exists), the dialplan applications it registers, the API commands it exposes, and the parameters or arguments those applications accept. The dialplan applications introduced here (`db`, `hash`, `limit`, `valet_park`, and others) are also summarized in the [dptools reference](../dialplan/dptools-reference.mdx).
1313

14-
## Table of Contents
15-
16-
- [mod_db: Persistent Key-Value Store and Call Limiting](#mod_db-persistent-key-value-store-and-call-limiting)
17-
- [mod_hash: In-Memory Shared State and limit_hash Backend](#mod_hash-in-memory-shared-state-and-limit_hash-backend)
18-
- [mod_limit: Backward-Compatibility Shim](#mod_limit-backward-compatibility-shim)
19-
- [mod_valet_parking: Valet Call Parking](#mod_valet_parking-valet-call-parking)
20-
- [mod_esf: Multicast Paging](#mod_esf-multicast-paging)
21-
- [mod_fsv: Video File Recording and Playback](#mod_fsv-video-file-recording-and-playback)
22-
- [mod_spy: User Call Monitoring](#mod_spy-user-call-monitoring)
23-
24-
---
25-
2614
## mod_db: Persistent Key-Value Store and Call Limiting {#mod_db-persistent-key-value-store-and-call-limiting}
2715

2816
`mod_db` provides two distinct services: a persistent SQL-backed key-value store accessible from the dialplan via the `db` application, and the `db` backend for the core `limit` subsystem. Data survives a module reload but is cleared on process restart (records belonging to the local hostname are deleted at startup).

docs/applications/voicemail.mdx

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,6 @@ sidebar_label: "19. Voicemail"
1111

1212
The `mod_voicemail` module provides integrated voicemail for FreeSWITCH, supporting per-user mailboxes defined in the user directory, caller-side recording, subscriber-side playback and configuration menus, and email delivery of messages with optional audio attachments.
1313

14-
## Table of Contents
15-
16-
- [Getting Started](#getting-started)
17-
- [Profile Configuration](#profile-configuration)
18-
- [Profile Parameter Reference](#profile-parameter-reference)
19-
- [DTMF Key Bindings](#dtmf-key-bindings)
20-
- [Email Sub-element](#email-sub-element)
21-
- [Storage and Database Options](#storage-and-database-options)
22-
- [User Directory Integration](#user-directory-integration)
23-
- [Per-User Parameters](#per-user-parameters)
24-
- [The voicemail Dialplan Application](#the-voicemail-dialplan-application)
25-
- [Leave-Message Mode](#leave-message-mode)
26-
- [Check-Mailbox Mode](#check-mailbox-mode)
27-
- [Channel Variables](#channel-variables)
28-
- [Email Notification](#email-notification)
29-
- [Email Template Variables](#email-template-variables)
30-
- [Default Dialplan Entries](#default-dialplan-entries)
31-
- [Global Settings](#global-settings)
32-
33-
---
34-
3514
## Getting Started {#getting-started}
3615

3716
**Prerequisites:** `mod_voicemail` must be loaded. Confirm it appears in `autoload_configs/modules.conf.xml`. The module reads its configuration from `autoload_configs/voicemail.conf.xml`.

docs/configuration-system/module-loading.mdx

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,6 @@ Functionality in FreeSWITCH comes from modules. This chapter documents how
1313
modules are selected for loading at startup, the special early and late load
1414
files, and how to load, unload, and reload modules from the console.
1515

16-
## Table of Contents
17-
- [Build-time vs Runtime Module Selection](#build-time-vs-runtime-module-selection)
18-
- [modules.conf.xml](#modulesconfxml)
19-
- [The Default Load Set](#the-default-load-set)
20-
- [Loggers](#loggers)
21-
- [Multi-Faceted](#multi-faceted)
22-
- [Event Handlers](#event-handlers)
23-
- [Endpoints](#endpoints)
24-
- [Applications](#applications)
25-
- [Dialplan Interfaces](#dialplan-interfaces)
26-
- [Codec Interfaces](#codec-interfaces)
27-
- [File Format Interfaces](#file-format-interfaces)
28-
- [Languages](#languages)
29-
- [Say](#say)
30-
- [Optional Modules (Shipped Commented Out)](#optional-modules-shipped-commented-out)
31-
- [Early and Late Loading](#early-and-late-loading)
32-
- [Module Categories](#module-categories)
33-
- [Managing Modules at Runtime](#managing-modules-at-runtime)
34-
3516
## Build-time vs Runtime Module Selection
3617

3718
FreeSWITCH separates module availability into two distinct stages: compilation

docs/configuration-system/variables-and-core-settings.mdx

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,6 @@ Two files hold the values that apply to the whole system: `vars.xml`, which
1313
defines the global preprocessor variables, and `switch.conf.xml`, which sets the
1414
core runtime parameters. This chapter documents both.
1515

16-
## Table of Contents
17-
- [Global Variables in vars.xml](#global-variables-in-varsxml)
18-
- [Dynamically Calculated Variables](#dynamically-calculated-variables)
19-
- [Commonly Edited Variables](#commonly-edited-variables)
20-
- [Core Settings in switch.conf.xml](#core-settings-in-switchconfxml)
21-
- [Core Settings Reference](#core-settings-reference)
22-
- [Console Key Bindings](#console-key-bindings)
23-
- [Logging Configuration](#logging-configuration)
24-
- [Log Levels](#log-levels)
25-
- [mod_console](#mod_console)
26-
- [mod_logfile](#mod_logfile)
27-
- [mod_syslog](#mod_syslog)
28-
- [Enabling Logger Modules](#enabling-logger-modules)
29-
3016
## Global Variables in vars.xml
3117

3218
`vars.xml` is included first by `freeswitch.xml`, so the preprocessor variables it

docs/configuration-system/xml-configuration.mdx

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,6 @@ document is split across many files that a preprocessor assembles before the XML
1414
is parsed. This chapter explains how the assembly works, the preprocessor
1515
instructions, the variable syntax, and the document's top-level sections.
1616

17-
## Table of Contents
18-
- [The Root Document](#the-root-document)
19-
- [The Preprocessor](#the-preprocessor)
20-
- [Preprocessor Commands](#preprocessor-commands)
21-
- [Inline Comment Form](#inline-comment-form)
22-
- [Include Files and Partials](#include-files-and-partials)
23-
- [Preprocessor Variables](#preprocessor-variables)
24-
- [The Top-Level Sections](#the-top-level-sections)
25-
- [The Compiled Document](#the-compiled-document)
26-
- [Editing and Reloading](#editing-and-reloading)
27-
2817
## The Root Document
2918

3019
The entry point is `freeswitch.xml` in the configuration root. It defines the

docs/dialplan/dptools-reference.mdx

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,6 @@ sidebar_label: "14. Dialplan Application Reference"
1111

1212
This chapter is a reference for the dialplan applications you invoke with `<action application="..." data="..."/>` inside an extension condition. It covers every application registered by `mod_dptools`, which provides the core call-control, audio, DTMF, variable, and logging applications. A handful of these are advanced or internal helpers (for example `park_state`, `acknowledge_call`, `recovery_refresh`, `reuse_caller_profile`, `set_media_stats`, `capture_text`, `vad_test`, and the `video_*` overlay apps) that operators rarely call directly; they are included here for completeness and noted as such. Applications provided by companion modules (`mod_conference`, `mod_voicemail`, `mod_fifo`, `mod_valet_parking`, `mod_hash`, `mod_db`, `mod_lua`, `mod_spy`, `mod_esf`, `mod_fsv`) are covered in the Feature Applications section; those modules must be loaded before the applications become available.
1313

14-
## Table of Contents
15-
16-
1. [Call Control](#call-control)
17-
2. [Audio and Prompts](#audio-and-prompts)
18-
3. [DTMF and Signaling](#dtmf-and-signaling)
19-
4. [Feature Applications](#feature-applications)
20-
5. [Variables, Logging, and Meta-binding](#variables-logging-and-meta-binding)
21-
6. [Examples](#examples)
22-
7. [Dial Strings and Call Origination](#dial-strings-and-call-origination)
23-
8. [Call Transfers and Feature Codes](#call-transfers-and-feature-codes)
24-
25-
---
26-
2714
## Call Control {#call-control}
2815

2916
These applications establish, route, and tear down call legs. They operate directly on the signaling and media state of the channel.

0 commit comments

Comments
 (0)