浏览代码

Improved markdown and tweaked descriptions (#293)

* Update call_block.md

* Update conference_center.md

* Update voicemail_transcription.md

* Update voicemail.md

* Update cdr_statistics.md

* Update upgrade.md

* Create place_holder

* Added screenshot

* Delete source/_static/images/advanced/variables/place_holder

* Added screemshot

* Update variables.md
Anthony 5 月之前
父节点
当前提交
5110ca9ea2

二进制
source/_static/images/advanced/variables/fusionpbx_variables1.png


二进制
source/_static/images/advanced/variables/fusionpbx_variables2.png


+ 20 - 15
source/advanced/upgrade.md

@@ -31,16 +31,20 @@ video](https://youtu.be/QUB3u9pZ7ks).
 
 
 ## **Update the source from command line**
 ## **Update the source from command line**
 
 
+```
     cd /var/www/fusionpbx 
     cd /var/www/fusionpbx 
     git pull
     git pull
     chown -R www-data:www-data
     chown -R www-data:www-data
+```
 
 
 ## **Back to the GUI**
 ## **Back to the GUI**
 
 
+```
     *Upgrade Database with advanced -> upgrade schema
     *Upgrade Database with advanced -> upgrade schema
     *Update permissions
     *Update permissions
     *Update the menu
     *Update the menu
     *Logout and back in
     *Logout and back in
+```
 
 
 ## How to Upgrade
 ## How to Upgrade
 
 
@@ -55,7 +59,7 @@ video](https://youtu.be/QUB3u9pZ7ks).
 
 
 ### **Step 1: Update FusionPBX Source**
 ### **Step 1: Update FusionPBX Source**
 
 
-- GUI -\> Advanced -\> Upgrade (doesn\'t update all files)
+- **Advanced** > **Upgrade** run **Source Code** (doesn't update all files).
 
 
 Used to update FusionPBX to the latest release.
 Used to update FusionPBX to the latest release.
 
 
@@ -64,7 +68,7 @@ Used to update FusionPBX to the latest release.
   Login into the web interface with a user account assigned to the
   Login into the web interface with a user account assigned to the
   superadmin group.
   superadmin group.
   Login to the console with either the ssh, the locally.
   Login to the console with either the ssh, the locally.
-  Backup It\'s a good idea to make a backup. If using sqlite, your
+  Backup It's a good idea to make a backup. If using sqlite, your
   backup will easily include the SQL database.
   backup will easily include the SQL database.
 
 
 ```
 ```
@@ -106,16 +110,14 @@ Used to update FusionPBX to the latest release.
 
 
 ### Step 2: Update Freeswitch Scripts
 ### Step 2: Update Freeswitch Scripts
 
 
-:::{note}
-
+:::{note}   
 As of FusionPBX 3.8.3 (Stable Branch), the scripts should be
 As of FusionPBX 3.8.3 (Stable Branch), the scripts should be
 automatically updated when updating the Source Code, using the
 automatically updated when updating the Source Code, using the
 **Advanced** > **Upgrade** page. Any customized scripts, having the same
 **Advanced** > **Upgrade** page. Any customized scripts, having the same
 name as the default scripts, **will be overwritten.** 
 name as the default scripts, **will be overwritten.** 
 :::
 :::
 
 
-:::{tip}
-
+:::{tip}   
 An option to
 An option to
 disable this default behavior is available using **Default Setting:
 disable this default behavior is available using **Default Setting:
 switch > scripts_update > false**. Missing scripts will be restored,
 switch > scripts_update > false**. Missing scripts will be restored,
@@ -132,8 +134,7 @@ untouched.
     - Use github to get the updated files. **You have to do this from an
     - Use github to get the updated files. **You have to do this from an
   empty directory**.
   empty directory**.
 
 
-:::{note}
-
+:::{note}   
 Older versions of FusionPBX may use the /usr/local path instead of /usr/share   
 Older versions of FusionPBX may use the /usr/local path instead of /usr/share   
 :::
 :::
 
 
@@ -150,8 +151,11 @@ Older versions of FusionPBX may use the /usr/local path instead of /usr/share
 ```
 ```
 
 
 - Clean out this scripts directory
 - Clean out this scripts directory
-     - An alternative is to remove the Lua scripts. **Only do this if you
-  haven\'t customized any LUA scripts**
+     - An alternative is to remove the Lua scripts.
+
+:::{warning}   
+Only do this if you haven't customized any LUA scripts.   
+:::
 
 
 ```
 ```
     cp -R /usr/share/freeswitch/scripts /usr/local/freeswitch/scripts-bak
     cp -R /usr/share/freeswitch/scripts /usr/local/freeswitch/scripts-bak
@@ -172,8 +176,9 @@ Older versions of FusionPBX may use the /usr/local path instead of /usr/share
 
 
 ### Step 3: Upgrade Schema
 ### Step 3: Upgrade Schema
 
 
-**Note:** Many updates have changes to the database and to the Freeswitch
-  scripts. The upgrade[schema]{#schema} script
+:::{note}   
+Many updates have changes to the database and to the Freeswitch scripts.   
+:::
 
 
 **Upgrade from the GUI**
 **Upgrade from the GUI**
 - From the GUI, run **Advanced -\> Upgrade Schema** which will add any
 - From the GUI, run **Advanced -\> Upgrade Schema** which will add any
@@ -247,15 +252,14 @@ Needed if your menu disappeared.
 
 
 ### Step 6: Re-generate Settings
 ### Step 6: Re-generate Settings
 
 
-:::{note}
-
+:::{note}   
 Sometimes variable names changes. In rev 1877 **v_config_cli.php**
 Sometimes variable names changes. In rev 1877 **v_config_cli.php**
 variable names changed which caused no fax to email emails or
 variable names changed which caused no fax to email emails or
 voicemail emails to be sent. Problem was the SMTP details did not
 voicemail emails to be sent. Problem was the SMTP details did not
 exist.
 exist.
 :::
 :::
 
 
-- Go to Advanced -> Settings and then click save. This will re-generate v_config_cli.php and any other needs config files.
+- Go to **Advanced** > **Settings** and then click save. This will re-generate **v_config_cli.php** and any other needs config files.
 
 
 ## Move to a different Branch
 ## Move to a different Branch
 
 
@@ -263,6 +267,7 @@ FusionPBX has a stable and a master(development) branch. You can switch
 from stable to master but **not recomended to downgrade.**
 from stable to master but **not recomended to downgrade.**
 
 
 ### Move to the Stable Branch
 ### Move to the Stable Branch
+
 ```
 ```
     mv /var/www/fusionpbx /var/www/fusionpbx-old
     mv /var/www/fusionpbx /var/www/fusionpbx-old
     cd /var/www && git clone -b 4.4 https://github.com/fusionpbx/fusionpbx.git
     cd /var/www && git clone -b 4.4 https://github.com/fusionpbx/fusionpbx.git

+ 16 - 25
source/advanced/variables.md

@@ -2,28 +2,19 @@
 
 
 Define preprocessor switch variables here.
 Define preprocessor switch variables here.
 
 
-![image](../_static/images/advanced/fusionpbx_advanced_variables.jpg)
-
-Variables have several different categories.
-
-## Codecs
-
-## Defaults
-
-## IP Address
-
-## Music on Hold
-
-## Ringtones
-
-## Sip
-
-## Sip Profile:External
-
-## Sip Profile:Internal
-
-## Sound
-
-## Tones
-
-## Xmpp
+![image](../_static/images/advanced/variables/fusionpbx_variables2.png)
+
+List of all variable categories.
+
+- Codecs
+- Defaults
+- IP Address
+- Music on Hold
+- Ringtones
+- Security
+- Sip
+- Sip Profile:External
+- Sip Profile:Internal
+- Sound
+- Tones
+- Xmpp

+ 9 - 6
source/applications/call_block.md

@@ -4,7 +4,7 @@ The Call Block application can be used to block *inbound* or *outbound*
 calls, based on the Caller ID Name and/or Number (for inbound calls), or
 calls, based on the Caller ID Name and/or Number (for inbound calls), or
 the Destination Number (for outbound calls).
 the Destination Number (for outbound calls).
 
 
-**Creating a New Call Block**
+## Creating a New Call Block
 
 
 To create a new Call Block, click the **Add** button at the top-right of
 To create a new Call Block, click the **Add** button at the top-right of
 the Call Block list page. A simple form will be presented\...
 the Call Block list page. A simple form will be presented\...
@@ -37,14 +37,15 @@ or voicemail box, etc.
 
 
 **Description** - The reason for blocking the number (? - you decide ;).
 **Description** - The reason for blocking the number (? - you decide ;).
 
 
-*Note: Call Blocks can also be added in bulk using the Recent Calls list
-below the form.*
+:::{note}   
+Call Blocks can also be added in bulk using the Recent Calls list below the form.   
+:::
 
 
 **Outbound Call Blocking**
 **Outbound Call Blocking**
 
 
 Outbound call blocking requires an additional dialplan entry.
 Outbound call blocking requires an additional dialplan entry.
 
 
-If one doesn\'t exist already, add a new **call-direction** Outbound
+If one doesn't exist already, add a new **call-direction** Outbound
 Route to set `call_direction=outbound`.
 Route to set `call_direction=outbound`.
 
 
 ![image](../_static/images/fusionpbx_call_block1.jpg)
 ![image](../_static/images/fusionpbx_call_block1.jpg)
@@ -52,10 +53,12 @@ Route to set `call_direction=outbound`.
 **Be sure to set \*Continue\* to True, or dialplan execution will never
 **Be sure to set \*Continue\* to True, or dialplan execution will never
 reach your existing Outbound Routes!**
 reach your existing Outbound Routes!**
 
 
-*Note: The screen capture example above could be for 10-digit numbers,
+:::{note}   
+The screen capture example above could be for 10-digit numbers,
 such as those in the U.S, so you may want to adjust the regular
 such as those in the U.S, so you may want to adjust the regular
 expression used to match the destination number format being used in
 expression used to match the destination number format being used in
-your current Outbound Routes.*
+your current Outbound Routes.*   
+:::
 
 
 ## Troubleshooting
 ## Troubleshooting
 
 

+ 8 - 7
source/applications/conference_center.md

@@ -5,10 +5,12 @@ organized by cost center, geographically, or other criteria.
 
 
 ![image](../_static/images/applications/conference_center/fusionpbx_conference_center1.png)
 ![image](../_static/images/applications/conference_center/fusionpbx_conference_center1.png)
 
 
--   To Acess Conference Center goto Apps \> Conference Center
--   To view rooms click the **ROOMS** at the top right.
+-   To access the **Conference Center**, go to **Apps** > **Conference Center**
+-   To view rooms click the **ROOMS** button at the top.
 
 
->**Note:** For basic conferencing use Apps -\> Conferences
+:::{note}    
+For basic conferencing use Apps > Conferences.   
+:::
 
 
 ## Conference Center Options
 ## Conference Center Options
 
 
@@ -26,11 +28,10 @@ organized by cost center, geographically, or other criteria.
 
 
 ## Conference Center Rooms
 ## Conference Center Rooms
 
 
-Apps \> Conference Center \> Click **Rooms** at the top right. This will
-take you to the Conference Center Rooms. From here you can
+**Apps** > **Conference Center** > Click **Rooms** at the top right. This will
+take you to the **Conference Center Rooms**. 
 
 
--   Create a Room
--   Edit a Room
+From here you can create or edit a room.
 
 
 ![image](../_static/images/applications/conference_center/fusionpbx_conference_center3.png)
 ![image](../_static/images/applications/conference_center/fusionpbx_conference_center3.png)
 
 

+ 5 - 5
source/applications/voicemail.md

@@ -18,8 +18,7 @@ Here you can edit voicemail settings:
 
 
 ![Voicemail Settings Continued](../_static/images/voicemail/fusionpbx_voicemail2.jpg)
 ![Voicemail Settings Continued](../_static/images/voicemail/fusionpbx_voicemail2.jpg)
 
 
-:::{note}
-
+:::{note}   
 Starting version 4.2, remote access to voicemail by interrupting the greeting message   
 Starting version 4.2, remote access to voicemail by interrupting the greeting message   
 by pressing "*" and entering the password is disabled by default.   
 by pressing "*" and entering the password is disabled by default.   
 :::
 :::
@@ -84,8 +83,7 @@ Using switch variables provides the ability to adjust FusionPBX Voicemail featur
 | vm_say_caller_id_number   | true or false  |
 | vm_say_caller_id_number   | true or false  |
 | vm_say_date_time          | true or false  |
 | vm_say_date_time          | true or false  |
 
 
-:::{note}
-
+:::{note}   
 The 'wav' format is the default voicemail message file type. A value of 'mp3' requires *mod_shout* be installed and running.   
 The 'wav' format is the default voicemail message file type. A value of 'mp3' requires *mod_shout* be installed and running.   
 :::
 :::
 
 
@@ -94,7 +92,9 @@ When an extension is unavailable and no voicemail is configured, there is an opt
 
 
 To enable/disable this, change the option for the **not_found_message** setting in **Advanced > Default Settings > Voicemail** category to suit your preference.
 To enable/disable this, change the option for the **not_found_message** setting in **Advanced > Default Settings > Voicemail** category to suit your preference.
 
 
-Please note that enabling this option means that the call must be answered in order to play the message to the caller, and so the call will complete with a 200 OK rather than a 480 Unavailable or 486 Busy. In some jurisdictions, this could potentially be illegal as it turns an otherwise toll-free call into a chargeable one.
+:::{warning}   
+Enabling this option means that the call must be answered in order to play the message to the caller, and so the call will complete with a 200 OK rather than a 480 Unavailable or 486 Busy. In some jurisdictions, this could potentially be illegal as it turns an otherwise toll-free call into a chargeable one.   
+:::
 
 
 ## Voicemail Transcription
 ## Voicemail Transcription
 FusionPBX supports Voicemail Transcription, where emails will include a transcribed version of the voicemail the email was sent in regards to. To configure this feature, see [Voicemail Transcription](http://docs.fusionpbx.com/en/latest/applications/voicemail_transcription.html).
 FusionPBX supports Voicemail Transcription, where emails will include a transcribed version of the voicemail the email was sent in regards to. To configure this feature, see [Voicemail Transcription](http://docs.fusionpbx.com/en/latest/applications/voicemail_transcription.html).

+ 20 - 21
source/applications/voicemail_transcription.md

@@ -5,12 +5,12 @@ This document provides a step-by-step guide for setting up the email transcripti
 
 
 ## Step-by-Step
 ## Step-by-Step
 1. **Log in to FusionPBX**
 1. **Log in to FusionPBX**
-   - Access the FusionPBX administrative interface.
+   - Access the FusionPBX administrative interface.   
 
 
 2. **Check for the "Transcribe" Option**
 2. **Check for the "Transcribe" Option**
    - Navigate to **Advanced** > **Default Settings**.
    - Navigate to **Advanced** > **Default Settings**.
    - Use the drop-down filter to select "**Transcribe**".
    - Use the drop-down filter to select "**Transcribe**".
-   - If the "**Transcribe**" option is already available, skip to step **5**. Otherwise, proceed to step **3**.
+   - If the "**Transcribe**" option is already available, skip to step **5**. Otherwise, proceed to step **3**.   
 
 
 3. **Install the Transcribe and Speech Apps**
 3. **Install the Transcribe and Speech Apps**
    - SSH into your server and run the following commands:
    - SSH into your server and run the following commands:
@@ -40,19 +40,21 @@ This document provides a step-by-step guide for setting up the email transcripti
 - Click **Reload** to apply the changes.
 - Click **Reload** to apply the changes.
 
 
 6. **Enable Transcription for a Single Extension**
 6. **Enable Transcription for a Single Extension**
-- Navigate to **Accounts** > **Extensions**.
-- Select the desired extension.
-- Set **Transcription Enabled** to **True**.
+   - Navigate to **Accounts** > **Extensions**.
+   - Select the desired extension.
+   - Set **Transcription Enabled** to **True**.
 
 
 7. **Enable Transcription by Default for All Extensions**
 7. **Enable Transcription by Default for All Extensions**
-- Navigate to **Advanced** > **Default Settings**.
-- Use the drop-down filter to select "**Voicemail**".
-- Enable the **transcription_enabled_default** setting.
+   - Navigate to **Advanced** > **Default Settings**.
+   - Use the drop-down filter to select "**Voicemail**".
+   - Enable the **transcription_enabled_default** setting.
 
 
 8. **Test the Service**
 8. **Test the Service**
-- Leave a voicemail for the enabled extension to verify that the transcription works correctly.
+   - Leave a voicemail for the enabled extension to verify that the transcription works correctly.
 
 
-> **Note**: The primary function handling voicemail transcriptions is defined in [transcribe.php](https://github.com/fusionpbx/fusionpbx/blob/master/app/email_queue/resources/functions/transcribe.php).
+:::{note}   
+The primary function handling voicemail transcriptions is defined in [transcribe.php](https://github.com/fusionpbx/fusionpbx/blob/master/app/email_queue/resources/functions/transcribe.php).   
+:::
 
 
 ---
 ---
 
 
@@ -63,9 +65,8 @@ Uses API services to transcribe voicemails into text for use in the app-sms and
 ## IBM Watson API
 ## IBM Watson API
 Sign up and language information is located on [IBM Watson's Site](https://cloud.ibm.com/catalog/services/speech-to-text).
 Sign up and language information is located on [IBM Watson's Site](https://cloud.ibm.com/catalog/services/speech-to-text).
 
 
-:::{warning}
-
-We cannot use mod_shout to record voicemails because the transcription service needs an uncompressed version of the audio. Therefore, we will record in WAV and then use LAME to re-encode in MP3. This could cause added resource utilization to your system.
+:::{warning}   
+We cannot use mod_shout to record voicemails because the transcription service needs an uncompressed version of the audio. Therefore, we will record in WAV and then use LAME to re-encode in MP3. This could cause added resource utilization to your system.   
 :::
 :::
 
 
 **Go to Advanced > Default Settings.**  
 **Go to Advanced > Default Settings.**  
@@ -80,10 +81,9 @@ Add the following entries:
 | voicemail | transcribe_enabled   | boolean| true               | True    |
 | voicemail | transcribe_enabled   | boolean| true               | True    |
 | voicemail | json_enabled         | boolean| true               | True    |
 | voicemail | json_enabled         | boolean| true               | True    |
 
 
-:::{note}
-
+:::{note}   
 Watson URL used for testing was:   
 Watson URL used for testing was:   
-https://example.url.api.us-south.speech-to-text.watson.cloud.ibm.com/instances/{GUID}/v1/recognize?model=en-US_Telephony&smart_formatting=true*
+https://example.url.api.us-south.speech-to-text.watson.cloud.ibm.com/instances/{GUID}/v1/recognize?model=en-US_Telephony&smart_formatting=true*   
 :::
 :::
 
 
 **List of available IBM Watson speech-to-text models**:  
 **List of available IBM Watson speech-to-text models**:  
@@ -106,8 +106,8 @@ Add the following entries:
 | voicemail | azure_key            | text   | {your azure key}      | True    |
 | voicemail | azure_key            | text   | {your azure key}      | True    |
 | voicemail | azure_server_region  | text   | {your server region}  | True    |
 | voicemail | azure_server_region  | text   | {your server region}  | True    |
 | voicemail | transcribe_language  | text   | en-US                 | True    |
 | voicemail | transcribe_language  | text   | en-US                 | True    |
-| voicemail | transcribe_enabled   | boolean| true                 | True    |
-| voicemail | json_enabled         | boolean| true                 | True    |
+| voicemail | transcribe_enabled   | boolean| true                  | True    |
+| voicemail | json_enabled         | boolean| true                  | True    |
 
 
 Click "Reload" at the top of the page.
 Click "Reload" at the top of the page.
 
 
@@ -142,9 +142,8 @@ Recommend using Azure as an alternative to Bing.
 Sign up and language information is located on [Microsoft Site](https://www.microsoft.com/cognitive-services/en-us/Speech-api/documentation/API-Reference-REST/BingVoiceRecognition).  
 Sign up and language information is located on [Microsoft Site](https://www.microsoft.com/cognitive-services/en-us/Speech-api/documentation/API-Reference-REST/BingVoiceRecognition).  
 Note: The Bing Speech API is deprecated as of October 2018; this works for now but needs to be ported to [the new API](https://github.com/MicrosoftDocs/azure-docs/blob/master/articles/cognitive-services/Speech-Service/how-to-migrate-from-bing-speech.md).
 Note: The Bing Speech API is deprecated as of October 2018; this works for now but needs to be ported to [the new API](https://github.com/MicrosoftDocs/azure-docs/blob/master/articles/cognitive-services/Speech-Service/how-to-migrate-from-bing-speech.md).
 
 
-:::{warning}
-
-We cannot use mod_shout to record voicemails because the transcription service needs an uncompressed version of the audio. Therefore, we will record in WAV and then use LAME to re-encode in MP3. This could cause added resource utilization to your system.
+:::{warning}   
+We cannot use mod_shout to record voicemails because the transcription service needs an uncompressed version of the audio. Therefore, we will record in WAV and then use LAME to re-encode in MP3. This could cause added resource utilization to your system.   
 :::
 :::
 
 
 **Go to Advanced > Default Settings.**  
 **Go to Advanced > Default Settings.**  

+ 1 - 1
source/status/cdr_statistics.md

@@ -4,7 +4,7 @@ Call Detail Records Statics summarize the call information.
 
 
 ![image](../_static/images/Status/cdr_statistics/fusionpbx_call_detail_record_statistics.png)
 ![image](../_static/images/Status/cdr_statistics/fusionpbx_call_detail_record_statistics.png)
 
 
-# Definitions
+## Definitions
 
 
 -   Hours: Specific hour in that day.
 -   Hours: Specific hour in that day.
 -   Date: Specific date in that month.
 -   Date: Specific date in that month.