Форматирование

client.rst

@@ -8,7 +8,7 @@
     :http-equiv=Content-Type: text/html; charset=utf-8
 
 =======================================
-Клиент websocket
+Клиент WebSocket
 =======================================
 
 Инициализация
@@ -17,10 +17,9 @@
 .. index:: Новый
 .. function:: Новый("AddIn.WebSocket.Client");
 
-    Синоним: New()
+    Синоним: **New()**
 
     Инициализация внешнего компонента (Клмент). Полученный таким образом объект используется для дальнейшего взаимодействия.
-
 
 Пример использования:
 
@@ -29,20 +28,105 @@
 
     Клиент = Новый("AddIn.WebSocket.Client");
 
-Получение сообщений
+Подключение к серверу
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. index:: Подключиться
+.. function:: Подключиться(АдресСервера)
+
+    Синоним: **Connect()**
+
+    Выполняет подключение к серверу, блокируется вызов до решения о подключение. Состояние подключения можно определить свойством ``Статус``
+
+    После подключение прием и отправка сообщений выполняется в фоновом режиме соответствующими методами ``Получить`` и ``Отправить``.
+
+    Параметры:
+
+    **АдресСервера** - **Строка** - Полный адрес сервера с протоколом и портом, например ``wss://echo.websocket.org``
+
+Пример использования:
+
+.. code-block:: bsl
+   :linenos:
+    
+    АдресСервера = "wss://echo.websocket.org";
+
+	Попытка
+		Клиент.Подключиться(АдресСервера);				
+	Исключение
+		
+		Описание = ОписаниеОшибки();
+		ТекстОшибки =  Клиент.ОписаниеОшибки();
+		
+		ТекстОписания = Описание + ": " + ТекстОшибки;
+		
+		ВызватьИсключение ТекстОписания;
+		
+	КонецПопытки;
+    
+Отключение от сервера
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. index:: Отключиться
+.. function:: Отключиться()
+
+    Синоним: Disconnect()
+
+    Выполняет отключение от сервера.
+
+Пример использования:
+
+.. code-block:: bsl
+   :linenos:
+    
+    Клиент.Отключиться();
+    
+Отправка сообщения
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. index:: Отправить
+.. function:: Отправить(ТелоСообщения)
+
+    Синоним: **Send()**
+
+    Добавляет сообщение для фоновой отправки клиенту
+
+    Параметры:
+
+    **ТелоСообщения** - **Строка** - Тело отправляемого сообщения
+
+Пример использования:
+
+.. code-block:: bsl
+   :linenos:
+    
+    ТелоСообщения = "Hello World 1C";
+
+    Сервер.Отправить(ТелоСообщения);	
+
+Получение сообщения
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. index:: Получить
 .. function:: Получить(Таймаут, Данные)
 
-    Синоним: Receive()
-    Возвращает: Булево - Признак принятия сообщения. Истина, если сообщение принято 
+    Синоним: **Receive()**
 
-    Таймаут - Число - Количество миллисекунд, на которое заблокировать вызов и ожидать сообщения. Если 0 - ждать бесконечно.
+    Получает принятое сообщение в фоновом режиме, если сообщений нет ждет ``Таймаут`` миллисекунд, или ждет до появления сообщения, если ``Таймаут=0``
+
+    **Возвращаемое значение:**
+
+    Тип: **Булево**
+
+    Описание: Признак принятия сообщения. Истина, если сообщение принято 
+
+    Параметры:
+
+    **Таймаут** - **Число** - Количество миллисекунд, на которое заблокировать вызов и ожидать сообщения. Если 0 - ждать бесконечно.
 
-    Данные - Строка - Полученные данные
+    **Данные** - **Строка** - Полученные данные
 
-    Получает принятое сообщение в фоновом режиме, если сообщений нет ждет Таймаут миллисекунд, или ждет до появления сообщения, если Таймаут=0
+
 
 Пример использования:
 
@@ -70,4 +154,56 @@
 
     КонецЦикла;
 
-    Сообщить("Закончен прием сообщений");
+    Сообщить("Закончен прием сообщений");
+    
+Статус
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. index:: Статус
+.. function:: Статус
+
+    Синоним: **Status**
+
+    **Возвращаемое значение:**
+
+    Тип: **Число**
+
+    Описание: Текущий статус подключения
+
+    ``-1`` - Ошибка подключения
+
+    ``0`` - Не подключено
+
+    ``1`` - Подключено
+
+Пример использования:
+
+.. code-block:: bsl
+   :linenos:
+    
+    Если Клиент.Статус = 1 Тогда
+        // Можно выполнять отправку данных
+    КонецЕсли;
+
+Сервер
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. index:: Сервер
+.. function:: Сервер
+
+    Синоним: **Server**
+
+    **Возвращаемое значение:**
+
+    Тип: **Строка**
+
+    Описание: Хранит адрес текущего соединения
+
+Пример использования:
+
+.. code-block:: bsl
+   :linenos:
+    
+    Если Клиент.Статус = 1 Тогда
+        Сообщить("Сейчас подключено к серверу: " + Клиент.Адрес);
+    КонецЕсли;

errors.rst

@@ -18,7 +18,11 @@
 .. index:: ОписаниеОшибки
 .. function:: ОписаниеОшибки()
 
-    Получает список кодов ошибок компоненты и их расшифровок. Возвращяемое значение: ТаблицаЗначений
+    **Возвращаемое значение:**
+
+    Тип: **Строка**
+
+    Описание: Получает текстовое описание ошибки.
 
 .. code-block:: bsl
    :linenos:

index.rst

@@ -24,10 +24,9 @@ WebSocket клиент и сервер для 1С. Внешний компоне
 
     server
 
-    tests
-
     errors
 
+    tests
 
 Другое
 ==================

init.rst

@@ -8,7 +8,7 @@
     :http-equiv=Content-Type: text/html; charset=utf-8
 
 ===================================================
-Инициализация и подключение внешнего компонента
+Подключение компоненты
 ===================================================
 
 &НаСервере
@@ -17,11 +17,11 @@
 .. index:: ПодключитьВнешнююКомпоненту
 .. function:: ПодключитьВнешнююКомпоненту()
 
-    Синоним: AttachAddIn()
+    Синоним: **AttachAddIn()**
 
     Подключает компоненты, выполненные по технологии Native API. 
     Компонент может храниться в информационной базе или макете конфигурации в виде двоичных данных или в ZIP-архиве.
-    Для режимов запуска "Тонкий клиент" и "Веб-клиент", компонент должен быть предварительно установлен методом УстановитьВнешнююКомпоненту. 
+    Для режимов запуска "Тонкий клиент" и "Веб-клиент", компонент должен быть предварительно установлен методом ``УстановитьВнешнююКомпоненту()``. 
 
 Пример использования:
 
@@ -41,14 +41,15 @@
 .. index:: УстановитьВнешнююКомпоненту
 .. function:: УстановитьВнешнююКомпоненту()
 
-    Синоним: InstallAddIn()
+    Синоним: **InstallAddIn()**
 
-    Доставляет объект внешнего компонента с сервера на клиент, после чего он становится доступен для метода ПодключитьВнешнююКомпоненту().
+    Доставляет объект внешнего компонента с сервера на клиент, после чего он становится доступен для метода ``ПодключитьВнешнююКомпоненту()``.
 
     Примечание:
 
     Метод работает только с компонентами, хранящимися в архиве.
-    Если для конфигурации свойство РежимИспользованияМодальности установлено в НеИспользовать, следует использовать метод НачатьУстановкуВнешнейКомпоненты. 
+
+    Если для конфигурации свойство РежимИспользованияМодальности установлено в НеИспользовать, следует использовать метод ``НачатьУстановкуВнешнейКомпоненты()``. 
 
 Пример использования:
 
@@ -61,4 +62,44 @@
 
     Если НЕ ПодключитьВнешнююКомпоненту(ПутьКомпоненты,"WebSocket", ТипВнешнейКомпоненты.Native) Тогда
         ВызватьИсключение "Ошибка подключения внешнего компонента";
-    КонецЕсли;
+    КонецЕсли;
+
+
+MANIFEST.XML
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. index:: MANIFEST
+.. only:: html
+
+    Файл предназначен для описания zip-архива файлов внешних компонент для использования на разных платформах
+
+Пример файла:
+
+.. code-block:: xml
+   :linenos:
+
+    <?xml version="1.0" encoding="UTF-8" ?>
+    <bundle xmlns="http://v8.1c.ru/8.2/addin/bundle" name="YouComponentName">
+    <component os="Windows" path="AddIn_ChrWindows_x86.exe" type="plugin" object="com.YourCompanyName.YouExtensionName.1" arch="i386" client="Firefox" clientVersion="40.*" />
+    <component os="Linux" path="AddIn_ChrLinux_x86.sh" type="plugin" object="com.YourCompanyName.YouExtensionName.1" arch="i386" client="Firefox" clientVersion="40.*" />
+    <component os="Linux" path="AddIn_ChrLinux_x86_64.sh" type="plugin" object="com.YourCompanyName.YouExtensionName.1" arch="x86_64" client="Firefox" clientVersion="40.*" />
+    <component os="Windows" path="Addin_IEWindows_x86.cab" type="plugin" object="MyComponentIE.AddInServiceEx" arch="i386" client="MSIE" />
+    <component os="Windows" path="AddIn_IEWindows_x86_64.cab" type="plugin" object="MyComponentIE.AddInServiceEx" arch="x86_64" client="MSIE" />
+    <component os="Windows" path="AddIn_ChrWindows_x86.exe" type="plugin" object="com.YourCompanyName.YouExtensionName.1" arch="i386" client="Chrome" />
+    <component os="Linux" path="AddIn_ChrLinux_x86.sh" type="plugin" object="com.YourCompanyName.YouExtensionName.1" arch="i386" client="Chrome" />
+    <component os="Linux" path="AddIn_ChrLinux_x86_64.sh" type="plugin" object="com.YourCompanyName.YouExtensionName.1" arch="x86_64" client="Chrome" />
+    <component os="MacOS" path="AddIn_SafMacOS_x86.pkg" type="plugin" object="application/component-example-1" arch="i386" client="Safari" />
+    <component os="Windows" path="AddInNative.dll" type="native" arch="i386" />
+    <component os="Windows" path="AddInNative64.dll" type="native" arch="x86_64" />
+    <component os="Linux" path="AddInNative.so" type="native" arch="i386" />
+    <component os="Linux" path="AddInNative64.so" type="native" arch="x86_64" />
+    <component os="iOS" path="AddInNative_iOS.dylib" type="native" arch="Universal" buildType="developer" />
+    <component os="iOS" path="AddInNative_iOS.a" type="native" arch="Universal" buildType="release" />
+    <component os="Android" path="libAddInNative_Android_i386.so" type="native" arch="i386" codeType="c++" />
+    <component os="Android" path="AddInNative_Android.apk" type="native" arch="i386" codeType="java" />
+    <component os="Android" path="libAddInNative_Android_ARM.so" type="native" arch="ARM" codeType="c++" />
+    <component os="Android" path="AddInNative_Android.apk" type="native" arch="ARM" codeType="java" />
+    <component os="WindowsRuntimePhone" path="AddInNative_WinRT_Phone_ARM.dll" type="native" arch="ARM" />
+    <component os="WindowsRuntimePhone" path="AddInNative_WinRT_Phone_Win32.dll" type="native" arch="i386" />
+    <component os="WindowsRuntime" path="AddInNative_WinRT_x64.dll" type="native" arch="x86_64" />
+    <component os="WindowsRuntime" path="AddInNative_WinRT_Win32.dll" type="native" arch="i386" />
+    </bundle>,