Skip to content

Commit 3b5489b

Browse files
committed
corrected MD formatting errors
1 parent 95fbbf7 commit 3b5489b

File tree

10 files changed

+32
-32
lines changed

10 files changed

+32
-32
lines changed

docs/Asterisk-Community/Asterisk-Issue-Guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Feature requests without patches are generally not accepted through the issue tr
1818
See the forums, mailing lists, IRC channels, or this wiki. For even more information, see <http://www.asterisk.org/community>
1919
* **Support requests**: (My phone doesn't register! My database connectivity doesn't work! How do I get it to work?)
2020
Search and ask on the forums, mailing lists, and IRC. Again, see <http://www.asterisk.org/community> for more information.
21-
* **Random wishes and feature requests with no patch:** (I want Asterisk to support <insert obscure protocol or gadget>, but I don't know how to code!)
21+
* **Random wishes and feature requests with no patch:** (I want Asterisk to support `<insert obscure protocol or gadget>`, but I don't know how to code!)
2222
See the [How to request a feature section](#how-to-request-a-feature-or-improvement) for more information on requesting a feature.
2323
* **Business development requests** (I will pay you to make Asterisk support fancy unicorn protocol!)
2424
Please head to the Commercial category at <https://community.asterisk.org/>. If what you want is a specific feature or bug fixed, you may want to consider [requesting a bug bounty](/Development/Asterisk-Bug-Bounties).

docs/Configuration/Applications/Conferencing-Applications/ConfBridge/ConfBridge-CLI-Commands.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ConfBridge CLI Commands
88

99
ConfBridge offers several commands that may be invoked from the Asterisk CLI.
1010

11-
confbridge kick <conference> <channel>
11+
`confbridge kick <conference> <channel>`
1212
--------------------------------------
1313

1414
Removes the specified channel from the conference, e.g.:
@@ -19,7 +19,7 @@ Kicking SIP/mypeer-00000000 from confbridge 1111
1919
2020
```
2121

22-
On This Pageconfbridge list
22+
`On This Pageconfbridge list`
2323
---------------
2424

2525
Shows a summary listing of all bridges, e.g.:
@@ -32,7 +32,7 @@ Conference Bridge Name Users Marked Locked?
3232
3333
```
3434

35-
confbridge list <conference>
35+
`confbridge list <conference>`
3636
----------------------------
3737

3838
Shows a detailed listing of participants in a specified conference, e.g.:
@@ -45,7 +45,7 @@ SIP/mypeer-00000001 default_user 1111 sample_user_menu
4545
4646
```
4747

48-
confbridge lock <conference>
48+
`confbridge lock <conference>`
4949
----------------------------
5050

5151
Locks a specified conference so that only Admin users can join, e.g.:
@@ -56,7 +56,7 @@ Conference 1111 is locked.
5656
5757
```
5858

59-
confbridge unlock <conference>
59+
`confbridge unlock <conference>`
6060
------------------------------
6161

6262
Unlocks a specified conference so that only Admin users can join, e.g.:
@@ -67,7 +67,7 @@ Conference 1111 is unlocked.
6767
6868
```
6969

70-
confbridge mute <conference> <channel>
70+
`confbridge mute <conference> <channel>`
7171
--------------------------------------
7272

7373
Mutes a specified user in a specified conference, e.g.:
@@ -78,7 +78,7 @@ Muting SIP/mypeer-00000001 from confbridge 1111
7878
7979
```
8080

81-
confbridge unmute <conference> <channel>
81+
`confbridge unmute <conference> <channel>`
8282
----------------------------------------
8383

8484
Unmutes a specified user in a specified conference, e.g.:
@@ -89,7 +89,7 @@ Unmuting SIP/mypeer-00000001 from confbridge 1111
8989
9090
```
9191

92-
confbridge record start <conference> <file>
92+
`confbridge record start <conference> <file>`
9393
-------------------------------------------
9494

9595
Begins recording a conference. If "file" is specified, it will be used, otherwise, the Bridge Profile record_file will be used. If the Bridge Profile does not specify a record_file, one will be automatically generated in Asterisk's monitor directory. Usage:
@@ -101,7 +101,7 @@ Recording started
101101
102102
```
103103

104-
confbridge record stop <confererence>
104+
`confbridge record stop <confererence>`
105105
-------------------------------------
106106

107107
Stops recording the specified conference, e.g.:
@@ -114,7 +114,7 @@ Recording stopped.
114114
115115
```
116116

117-
confbridge show menus
117+
`confbridge show menus`
118118
---------------------
119119

120120
Shows a listing of Conference Menus as defined in confbridge.conf, e.g.:
@@ -127,7 +127,7 @@ sample_user_menu
127127
128128
```
129129

130-
confbridge show menu <menu name>
130+
`confbridge show menu <menu name>`
131131
--------------------------------
132132

133133
Shows a detailed listing of a named Conference Menu, e.g.:
@@ -147,7 +147,7 @@ Name: sample_admin_menu
147147
148148
```
149149

150-
confbridge show profile bridges
150+
`confbridge show profile bridges`
151151
-------------------------------
152152

153153
Shows a listing of Bridge Profiles as defined in confbridge.conf, e.g.:
@@ -160,7 +160,7 @@ default_bridge
160160
161161
```
162162

163-
confbridge show profile bridge <bridge>
163+
`confbridge show profile bridge <bridge>`
164164
---------------------------------------
165165

166166
Shows a detailed listing of a named Bridge Profile, e.g.:
@@ -193,7 +193,7 @@ sound_error_menu: conf-errormenu
193193
194194
```
195195

196-
confbridge show profile users
196+
`confbridge show profile users`
197197
-----------------------------
198198

199199
Shows a listing of User Profiles as defined in confbridge.conf, e.g.:
@@ -206,7 +206,7 @@ default_user
206206
207207
```
208208

209-
confbirdge show profile user <user>
209+
`confbirdge show profile user <user>`
210210
-----------------------------------
211211

212212
Shows a detailed listing of a named Bridge Profile, e.g.:

docs/Configuration/Applications/Conferencing-Applications/ConfBridge/ConfBridge-Configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ A Bridge Profile provides the following configuration options:
5353
| --- | --- | --- | --- |
5454
| type | bridge | Set this to bridge to configure a bridge profile | |
5555
| max_members | integer; e.g. 50 | Limits the number of participants for a single conference to a specific number. By default, conferences have no participant limit. After the limit is reached, the conference will be locked until someone leaves. Admin-level users are exempt from this limit and will still be able to join otherwise-locked, because of limit, conferences. | |
56-
| record_conference | yes/no | Records the conference call starting when the first user enters the room, and ending when the last user exits the room. The default recorded filename is 'confbridge-<name of conference bridge>-<start time>.wav and the default format is 8kHz signed linear. By default, this option is disabled. This file will be located in the configured monitoring directory as set in asterisk.conf | |
56+
| record_conference | yes/no | Records the conference call starting when the first user enters the room, and ending when the last user exits the room. The default recorded filename is `confbridge-<name of conference bridge>-<start time>.wav` and the default format is 8kHz signed linear. By default, this option is disabled. This file will be located in the configured monitoring directory as set in asterisk.conf | |
5757
| record_file | path, e.g. /tmp/myfiles | When record_conference is set to yes, the specific name of the recorded file can be set using this option. Note that since multiple conferences may use the same Bridge profile, this can cause issues, depending on the configuration. It is recommended to only use this option dynamically with the CONFBRIDGE() dialplan function. This allows the recorded name to be specified and a unique name to be chosen. By default, the recorded file is stored in Asterisk's spool/monitory directory, with a unique filename starting with the 'confbridge' prefix. | |
5858
| internal_sample_rate | auto, 8000, 12000, 16000, 24000, 32000, 44100, 48000, 96000, 192000 | Sets the internal native sample rate at which to mix the conference. The "auto" option allows Asterisk to adjust the sample rate to the best quality / performance based on the participant makeup. Numbered values lock the rate to the specified numerical rate. If a defined number does not match an internal sampling rate supported by Asterisk, the nearest sampling rate will be used instead. | |
5959
| mixing_interval | 10, 20, 40, 80 | Sets, in milliseconds, the internal mixing interval. By default, the mixing interval of a bridge is 20ms. This setting reflects how "tight" or "loose" the mixing will be for the conference. Lower intervals provide a "tighter" sound with less delay in the bridge and consume more system resources. Higher intervals provide a "looser" sound with more delay in the bridge and consume less resources | |
@@ -68,7 +68,7 @@ A Bridge Profile provides the following configuration options:
6868
| sound_only_person | filename | The sound played when a user is the only person in the conference. | |
6969
| sound_only_one | filename | The sound played to a user when there is only one other person in the conference. | |
7070
| sound_there_are | filename | The sound played when announcing how many users there are in a conference. | |
71-
| sound_other_in_party | filename | Used in conjunction with the sound_there_are option, used like "sound_there_are" <number of participants> "sound_other_in_party" | |
71+
| sound_other_in_party | filename | Used in conjunction with the sound_there_are option, used like `"sound_there_are" <number of participants> "sound_other_in_party"` | |
7272
| sound_place_into_conference | filename | The sound played when someone is placed into a conference, after waiting for a marked user. | |
7373
| sound_wait_for_leader | filename | The sound played when a user is placed into a conference that cannot start until a marked user enters. | |
7474
| sound_leader_has_left | filename | The sound played when the last marked user leaves the conference. | |
@@ -144,8 +144,8 @@ A Conference Menu provides the following configuration options:
144144
| Option | Values | Description | Notes |
145145
| --- | --- | --- | --- |
146146
| type | menu | Set this to menu to configure a conference menu | |
147-
| playback | (<name of audio file1>&<name of audio file2>&...) | Plays back an audio file, or a string of audio files chained together using the & character, to the user and then immediately returns them to the conference. | |
148-
| playback_and_continue | (<name of audio file 1>&<name of audio file 2>&...) | Plays back an audio file, or a series of audio files chained together using the & character, to the user while continuing the collect the DTMF sequence. This is useful when using a menu prompt that describes all of the menu options. Note that any DTMF during this action will terminate the prompt's playback. | |
147+
| playback | (`<name of audio file1>&<name of audio file2>&...`) | Plays back an audio file, or a string of audio files chained together using the & character, to the user and then immediately returns them to the conference. | |
148+
| playback_and_continue | (`<name of audio file 1>&<name of audio file 2>&...`) | Plays back an audio file, or a series of audio files chained together using the & character, to the user while continuing the collect the DTMF sequence. This is useful when using a menu prompt that describes all of the menu options. Note that any DTMF during this action will terminate the prompt's playback. | |
149149
| toggle_mute | | Toggles mute on and off. When a user is muted, they will not be able to speak to other conference users, but they can still listen to other users. While muted, DTMF keys from the caller will continue to be collected. | |
150150
| no_op | | This action does nothing. Its only real purpose exists for being able to reserve a sequence in the configuration as a menu exit sequence. | |
151151
| decrease_listening_volume | | Decreases the caller's listening volume. Everything they hear will sound quieter. | |

docs/Configuration/Applications/SMS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ All text messages are stored in /var/spool/asterisk/sms
3232

3333
A log is recorded in /var/log/asterisk/sms
3434

35-
There are two subdirectories called sc-me.<queuename> holding all messages from service centre to phone, and me-sc.<queuename> holding all messages from phone to service centre.
35+
There are two subdirectories called `sc-me.<queuename>` holding all messages from service centre to phone, and `me-sc.<queuename>` holding all messages from phone to service centre.
3636

3737
In each directory are messages in files, one per file, using any filename not starting with a dot.
3838

39-
When connected as a service centre, SMS(s) will send all messages waiting in the sc-me-<queuename> directory, deleting the files as it goes. Any received in this mode are placed in the me-sc-<queuename> directory.
39+
When connected as a service centre, SMS(s) will send all messages waiting in the `sc-me-<queuename>` directory, deleting the files as it goes. Any received in this mode are placed in the `me-sc-<queuename>` directory.
4040

41-
When connected as a client, SMS() will send all messages waiting in the me-sc-<queuename> directory, deleting the files as it goes. Any received in this mode are placed in the sc-me-<queuename> directory.
41+
When connected as a client, SMS() will send all messages waiting in the `me-sc-<queuename>` directory, deleting the files as it goes. Any received in this mode are placed in the `sc-me-<queuename>` directory.
4242

4343
Message files created by SMS() use a time stamp/reference based filename.
4444

docs/Configuration/Applications/Voicemail/Message-Waiting-Indication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Asterisk can subscribe to receive MWI from another SIP server and store it local
5959
6060
```
6161

62-
MWI received will be stored in the 1234 mailbox of the SIP_Remote context. It can be used by other phones by setting their SIP peers "mailbox" option to the <mailbox_number>@SIP_Remote. e.g. mailbox=1234@SIP_Remote
62+
MWI received will be stored in the 1234 mailbox of the SIP_Remote context. It can be used by other phones by setting their SIP peers "mailbox" option to the `<mailbox_number>@SIP_Remote`. e.g. `mailbox=1234@SIP_Remote`
6363

6464
Reception of unsolicited MWI NOTIFY with chan_sip
6565
--------------------------------------------------
@@ -72,7 +72,7 @@ A chan_sip peer can be configured to receive unsolicited MWI NOTIFY messages and
7272
7373
```
7474

75-
If the remote SIP server sends an unsolicited MWI NOTIFY message the new/old message count will be stored in the configured virtual mailbox. It can be used by any device supporting MWI by specifying mailbox=<configured value>@SIP_Remote as the mailbox for the desired SIP peer.
75+
If the remote SIP server sends an unsolicited MWI NOTIFY message the new/old message count will be stored in the configured virtual mailbox. It can be used by any device supporting MWI by specifying `mailbox=<configured value>@SIP_Remote` as the mailbox for the desired SIP peer.
7676

7777
res_external_mwi
7878
------------------
@@ -91,4 +91,4 @@ External sources can use the API provided by res_external_mwi to communicate MWI
9191
chan_pjsip
9292
-----------
9393

94-
The endpoint parameter `incoming_mwi_mailbox` (introduced in 13.18.0 and 14.7.0) takes a <`mailbox>@<context>` value. When an unsolicited NOTIFY message is received ***from*** this endpoint with an event type of `message-summary` and the `incoming_mwi_mailbox` parameter is set, Asterisk will automatically publish the new/old message counts for the specified mailbox on the internal stasis bus for any other module to use. For instance, if you have an analog phone and you specify `mailbox=userx@default` in chan_dahdi.conf, when a NOTIFY comes in on a pjsip endpoint with `incoming_mwi_mailbox=userx@default`, chan_dahdi will automatically pick that up and turn the MWI light on on the analog phone.
94+
The endpoint parameter `incoming_mwi_mailbox` (introduced in 13.18.0 and 14.7.0) takes a `<mailbox>@<context>` value. When an unsolicited NOTIFY message is received ***from*** this endpoint with an event type of `message-summary` and the `incoming_mwi_mailbox` parameter is set, Asterisk will automatically publish the new/old message counts for the specified mailbox on the internal stasis bus for any other module to use. For instance, if you have an analog phone and you specify `mailbox=userx@default` in chan_dahdi.conf, when a NOTIFY comes in on a pjsip endpoint with `incoming_mwi_mailbox=userx@default`, chan_dahdi will automatically pick that up and turn the MWI light on on the analog phone.

docs/Configuration/Channel-Drivers/SIP/Configuring-res_pjsip/PJSIP-Configuration-Sections-and-Relationships.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Reference documentation for all configuration parameters:
2828
* [Configuration options for outbound registration, provided by res_pjsip_outbound_registration](/Latest_API/API_Documentation/Module_Configuration/res_pjsip_outbound_registration)
2929
* [Configuration options for endpoint identification by IP address, provided by res_pjsip_endpoint_identifier_ip](/Latest_API/API_Documentation/Module_Configuration/res_pjsip_endpoint_identifier_ip)
3030

31-
The same documentation is available at the Asterisk CLI as well. You can use "config show help <res_pjsip module name> <configobject> <configoption>" to get help on a particular option. That help will typically describe the default value for an option as well.
31+
The same documentation is available at the Asterisk CLI as well. You can use `config show help <res_pjsip module name> <configobject> <configoption>` to get help on a particular option. That help will typically describe the default value for an option as well.
3232

3333
/// tip|Defaults
3434
For many config options, it's very helpful to understand their default behavior. For example, for the endpoint section "transport=" option, if no value is assigned then Asterisk will \*DEFAULT\* to the first configured transport in pjsip.conf which is valid for the URI we are trying to contact.

docs/Configuration/Interfaces/Back-end-Database-and-Realtime-Connectivity/ODBC/Configuring-res_odbc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Other pages on the wiki describe that process:
2222

2323
[Using Menuselect to Select Asterisk Options](/Getting-Started/Installing-Asterisk/Installing-Asterisk-From-Source/Using-Menuselect-to-Select-Asterisk-Options)
2424

25-
When using menuselect, verify that the **func_odbc** (you'll probably be using that one), **res_odbc** (required) and **res_odbc_transaction** (required) modules will be built. Then, build Asterisk and make sure those modules were built and exist in */usr/lib/asterisk/modules** (or whatever directory you use).
25+
When using menuselect, verify that the **func_odbc** (you'll probably be using that one), **res_odbc** (required) and **res_odbc_transaction** (required) modules will be built. Then, build Asterisk and make sure those modules were built and exist in **/usr/lib/asterisk/modules** (or whatever directory you use).
2626

2727
Configure res_odbc.conf to connect to your ODBC installation
2828
=============================================================

docs/Contributing-to-the-Documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -637,4 +637,4 @@ Now run `make`:
637637
$ make BRANCHES=22
638638
```
639639

640-
The main Makefile will automatically include the Makefile.<branch>.inc file for any branch listed in BRANCHES. It doesn't make sense to build more than one branch in this situation but you could if you wanted to. You'll have to make sure there's a `Makefile.<branch>.inc` file for each branch you want to build and that the paths in each file are adjusted to that branch's Asterisk files.
640+
The main Makefile will automatically include the `Makefile.<branch>.inc` file for any branch listed in BRANCHES. It doesn't make sense to build more than one branch in this situation but you could if you wanted to. You'll have to make sure there's a `Makefile.<branch>.inc` file for each branch you want to build and that the paths in each file are adjusted to that branch's Asterisk files.

0 commit comments

Comments
 (0)