upd

2025-04-14 16:07:37 +05:00 · 2025-04-14 16:07:37 +05:00 · 641f0fafca
commit 641f0fafca
parent 3dc40fe066
14 changed files with 581 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1,5 @@
+/env
+/site
+/venv
+docs\Admin manuals\QueryAnalyzer
+docs\Admin manuals\Проведение тестирование сайта\
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.8"
+
+python:
+  install:
+    - requirements: mkdocs/requirements.txt
+    
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally set the version of Python and requirements required to build your docs
+# python:
+#    version: "3.8"
+#    install:
+#    - requirements: mkdocs/requirements.txt
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@ -0,0 +1,10 @@
+{
+    "markdown-table-formatter.limitLastColumnLength": "Follow editor's wordWrapColumn",
+    "markdown-table-formatter.globalColumnSizes": "Same Table Size",
+    "markdown.copyFiles.destination": {
+      "/docs/**/*": "media/${fileName}"
+    },
+    "cSpell.words": [
+      "автоматического"
+    ]
+  }
--- a/README.md
+++ b/README.md
@ -0,0 +1,61 @@
+# MkDocs
+## Инструкция по установке есть на сайте MkDocs.
+
+### Надо установить:
+
+python python.org
+pip – менеджер пакет (ставится, обычно, вместе с питоном)
+mkdocs – пакет с движком mkdocs
+
+`pip install mkdocs`
+Полезные ссылки:
+
+mkdocs.org
+
+### плагины MkDocs
+
+Темы MkDocs
+
+markdown дополнения
+
+Тема
+В проекте используется тема material.
+
+Для установки запускаем:
+
+`pip install mkdocs-material`
+Полезные ссылки:
+
+Настройки темы material
+Плагины из темы material
+Проект темы material на GitHub
+Плагины
+В проекте используются плагины:
+
+search – встроенный плагин поиска.
+img2fig – отображение картинок в отдельном теге с подписью внизу.
+pip install mkdocs-img2fig-plugin
+
+Для разработки и проверки документации можно использовать команды
+* `mkdocs serve` (с созданием pdf файлов)
+* `mkdocs serve -f dev.yml` (без создания pdf файлов)
+* `mkdocs build -f admin-manuals.yml` (с созданием  pdf файла с инструкциями для администратора)
+
+Перед запуском надо установить mkdocs и его расширения. Сделать это можно при помощи команды, запущенной в папке mkdocs
+```
+pip install -r requirements.txt
+```
+
+Чтобы включить увеличение изображения, необходимо добавить . Если не работает (а это происходит при работе плагина img2fig), то использовать html-вариант. Автоматический конвертер первого варианта во второй (zoom.py) есть в bitedo-doc и документации ERP.
+```
+а) ![Рис 1](examplel.png)
+б) <img alt="Рис 1" src="examplel.png" class="zoom"/>
+```
+
+В случае ошибки **no library called "cairo" was found** необходимо скачать библиотеки:
+
+https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer
+
+https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases
+
+Если при запуске команды **mkdocs serve -f dev.yml** появляется ошибка что данная команда не определена, то в переменнах средах укажите путь: **C:\Users\User\AppData\Roaming\Python\Python310\Scripts**
--- a/admin-manuals.yml
+++ b/admin-manuals.yml
@ -0,0 +1,79 @@
+site_name: Руководство администратора приложения Lexema
+repo_url: http://gogs.lexema.ru/zpavel/sample-docs
+edit_uri: _edit/master/docs/
+nav:
+
+markdown_extensions:
+    - toc:
+        separator: "_"
+        permalink: "#"
+        slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: "lower", percent_encode: true}}
+    - attr_list
+    - admonition
+    - sane_lists
+    - pymdownx.highlight
+    - pymdownx.superfences
+    - def_list
+
+extra_css:
+    - css/extra.css
+
+extra_javascript:
+    - javascripts/extra.js
+
+plugins:
+    - search:
+        lang: ['ru', 'en']
+    - section-index
+    - include-markdown
+    - literate-nav:
+        nav_file: SUMMARY.md
+        # Для пдфки видимо свой файл оглавления сделать не получится 
+    - with-pdf:
+        author: Ксения Шабанова, Павел Зюзин, Ксения Имамутдинова, Альбина Янгирова, Тимур Мирзакаев, Марина Халиуллина, Регина Лапина
+        copyright: ООО "Лексема"
+        #
+        #cover: false
+        #back_cover: true
+        #cover_title: TITLE TEXT
+        cover_subtitle: Версия 20221018-15
+        #custom_template_path: TEMPLATES PATH
+        #
+        toc_title: Оглавление
+        #heading_shift: false
+        # toc_level: 3
+        #ordered_chapter_level: 2
+        #excludes_children:
+        #    - 'release-notes/:upgrading'
+        #    - 'release-notes/:changelog'
+        #
+        #exclude_pages:
+        #    - 'bugs/'
+        #    - 'appendix/contribute/'
+        #convert_iframe:
+        #    - src: IFRAME SRC
+        #      img: POSTER IMAGE URL
+        #      text: ALTERNATE TEXT
+        #    - src: ...
+        #two_columns_level: 3
+        #
+        #render_js: true
+        #headless_chrome_path: headless-chromium
+        #
+        output_path: pdf/admin-manual.pdf
+        #enabled_if_env: ENABLE_PDF_EXPORT
+        #
+        #debug_html: true
+        #show_anchors: true
+        #verbose: true
+
+theme:
+    name: material
+    features:
+        - navigation.instant
+    language: ru
+    palette:
+        primary: white
+
+docs_dir: docs
+site_dir: site  
--- a/custom_theme/404.html
+++ b/custom_theme/404.html
@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block content %}
+
+    <div class="row-fluid">
+      <div id="main-content" class="span12">
+        <h1 id="404-page-not-found" style="text-align: center">404 - Страница не найдена</h1>
+      </div>
+    </div>
+
+{% endblock %}
--- a/dev.yml
+++ b/dev.yml
@ -0,0 +1,61 @@
+site_name: Что нового
+#repo_url: http://gogs.lex.lan/yangirova_as/Dokumentooborot
+nav:
+
+markdown_extensions:
+    - toc:
+        separator: "_"
+        permalink: "#"
+        slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: "lower", percent_encode: true}}
+    - attr_list
+    - admonition
+    - sane_lists
+    - pymdownx.highlight
+    - pymdownx.superfences
+    - def_list
+    - pymdownx.details
+    - pymdownx.tasklist:
+        custom_checkbox: true
+    - pymdownx.tabbed:
+        alternate_style: true
+
+
+extra_css:
+    - css/extra.css
+
+extra_javascript:
+    - javascripts/extra.js
+
+plugins:
+    - glightbox:
+        zoomable: true
+    - search:
+        lang: ['ru', 'en']
+    - section-index
+    - include-markdown
+    - mkdocs-video
+    - literate-nav:
+        nav_file: SUMMARY.md
+
+theme:
+  name: material
+  palette:
+    primary: green
+    accent: orange
+  
+  features:  
+    - navigation.instant
+    - navigation.top
+    - navigation.tracking
+    - toc.follow
+    - toc.integrate
+    - search.suggest
+    - header.autohide
+    - navigation.path
+    - navigation.tabs.sticky
+
+  language: ru
+  
+
+docs_dir: docs
+site_dir: site
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@ -0,0 +1 @@
+- [Что нового](index.md)
--- a/docs/css/extra.css
+++ b/docs/css/extra.css
@ -0,0 +1,86 @@
+  
+  ol.oldec {
+	list-style-type: decimal;
+  }
+  ol.oldec li {
+	list-style-type: decimal;
+  }
+  ol.oldec li:before {
+	list-style-type: decimal;
+  }
+  
+  .md-grid {
+    max-width: 98%;
+  }
+
+  ul.uldisc {
+	list-style-type: disc;
+  }
+
+  ul.ulcircle {
+	list-style-type: circle;
+  }
+
+  img {
+    border: 1px solid #9f9f9f;
+    transition: transform ease-in-out 0.5s;
+  }
+  
+  img:active[src*="#zoom"] {    
+    cursor: zoom-out;
+    position: fixed;
+    top: 50%;
+    left: 50%;
+    /* bring your own prefixes */
+    transform: translate(-50%, -50%);
+    margin-top: 75px;
+    margin-bottom: auto;
+    margin-left: auto;
+    margin-right: auto;
+    width: 1200px;
+    height: auto;
+  }
+  
+  img[src*="#zoom"] {
+    cursor: zoom-in;
+  }
+
+  .center {
+    display: block;
+    margin-left: auto;
+    margin-right: auto;
+    }
+
+  .zoom {
+    transition: transform ease-in-out 0.5s;
+    cursor: zoom-in;
+  }
+
+  .image-zoom-large {
+    cursor: zoom-out;
+    z-index: 100;
+    position: absolute;
+    left: 50%;
+    /*  */
+    transform: translate(-50%, 0%);
+    text-align: center;
+    margin-top: 0px;
+    margin-bottom: auto;
+    margin-left: auto;
+    margin-right: auto;
+    width: 1100px;
+    height: auto;
+    box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19);
+  }
+
+  table {
+    word-break: break-word;
+  }
+
+tbody tr:nth-child(odd) {
+  background-color: #f3f3f3;
+  /* color: #fff; */
+}
+/* tbody td:first-child {
+  font-weight: bold
+} */
--- a/docs/index.md
+++ b/docs/index.md
@ -0,0 +1,47 @@
+# Что нового
+
+## РЕЛИЗ 20250307-24:
+
+??? "РЕЛИЗ 20250307-24:"
+
+    **Версия платформы**:  
+    ecosoft-lexema8@4.29.0  
+
+    **MSSQL**:  
+    ecosoft-lexema8-CommonDocuments@2.30.83  
+    ecosoft-lexema8-docflow-documents-lib@2.200.7  
+
+    **POSTGRESQL**:  
+    ecosoft-lexema8-AdminConsole@3.1.40   
+    ecosoft-lexema8-CommonDocuments@3.3.179  
+    ecosoft-lexema8-docflow-documents-lib@3.3.7   
+    ecosoft-lexema8-odata-lib@3.1.262   
+
+    **Мобильное приложение**
+
+    * Добавлена поддержка табличных атрибутов  
+    * Добавлена поддержка динамического аттрибута "Длинный текст (мемо)"  
+    * Текст и рабочие кнопки вынесены из зоны пересечения с фронтальной камерой и панелью навигации  
+    * Исправлена цветовая гамма отображения атрибутов при работе в темном режиме телефона  
+
+    **Конструктор документов**
+
+    * Реализована возможность вычисление динамического атрибута в документе в зависимости от заполнения табличной части
+    * Реализована настройка показывающая всегда предпросмотр вложений 
+
+    **Делопроизводство**
+
+    * Во входящих документах добавлена проверка на обязательное заполнение полей с даты и номером регистрации документа 
+    * В исходящий и ОРД документы добавлены проверки на наличие действия "Зарегистрировать" в маршруте
+
+    **Общие функции**
+
+    * В поисковой системе реализована возможность поиска по динамическим атрибутам документов.
+    * Разработан функционал позволяющая автоматически добавлять вложение в карточку контрагента из документа "Проверка контрагента"  
+    * Разработан функционал позволяющий направить документ определенной группе пользователей на ознакомление при отправке документа от инициатора
+    * Разработана настройка позволяющая отключить проверку наличия банковских реквизитов в договорах
+    * Разработана возможность переименовать лист ознакомления с документом
+    * Установлен запрет на добавление других пользователей на этапе инициирования документа 
+    * Разработана возможность задавать срок исполнения документа в зависимости от статичных полей дата и дата-время
+
+
--- a/docs/javascripts/extra.js
+++ b/docs/javascripts/extra.js
@ -0,0 +1,32 @@
+!function() {
+	const myTitle = {
+		'note': 'Примечание',
+		'caution': 'Осторожно',
+		'info': 'Информация',
+		'danger': 'Опасно',
+		'hint': 'Совет',
+		'warning': 'Внимание',
+		'question': 'Вопрос'
+	}
+
+	for (let item of document.getElementsByClassName('admonition-title')) {
+		if (item.parentNode.classList[1] && myTitle[item.parentNode.classList[1]]) {
+			item.firstChild.nodeValue = myTitle[item.parentNode.classList[1]];
+		}
+    
+	}
+
+	for (let item of document.getElementsByClassName('imgPreview')) {
+		item.onclick = function(s) {
+			window.open(s.target.src, '_blank').focus();
+		}
+	}
+
+	document.querySelectorAll('.zoom').forEach(item => {
+		item.addEventListener('click', function () {
+			this.classList.toggle('image-zoom-large');
+		})
+	});
+
+	//console.log('HI');
+}();
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -0,0 +1,68 @@
+site_name: Что нового
+#repo_url: http://gogs.lex.lan/l8-base/ECM-administrator-manuals.git
+nav:
+
+markdown_extensions:
+    - toc:
+        separator: "_"
+        permalink: "#"
+        slugify: !!python/name:pymdownx.slugs.uslugify
+    - attr_list
+    - admonition
+    - sane_lists
+    - pymdownx.highlight
+    - pymdownx.superfences
+    - def_list
+    - pymdownx.details
+    - pymdownx.tabbed:
+        alternate_style: true
+    - pymdownx.tasklist:
+        custom_checkbox: true
+
+extra_css:
+    - css/extra.css
+
+extra_javascript:
+    - javascripts/extra.js
+
+plugins:
+    - glightbox:
+        zoomable: true
+    - search:
+        lang: ['ru', 'en']
+    - section-index
+    - include-markdown
+    - mkdocs-video
+    - literate-nav:
+        nav_file: SUMMARY.md
+    - with-pdf:
+        author: Павел Зюзин, Ксения Шабанова, Альбина Янгирова, Ксения Имамутдинова, Тимур Мирзакаев, Марина Халиуллина, Регина Лапина
+        copyright: ООО "Лексема"
+        
+        cover: false
+        back_cover: true
+        cover_title: TITLE TEXT
+        cover_subtitle: Версия  20221018-14
+        custom_template_path: TEMPLATES PATH
+        
+        output_path: pdf\LexemaECM-manual.pdf
+        toc_title: Оглавление
+theme:
+  name: material
+  palette:
+    primary: green
+    accent: orange
+  
+  features:  
+    - navigation.instant
+    - navigation.top
+    - navigation.tracking
+    - toc.follow
+    - toc.integrate
+    - navigation.tabs.sticky
+    - search.suggest
+    - header.autohide
+    - navigation.path
+
+docs_dir: docs
+site_dir: site
--- a/mkdocs/requirements.txt
+++ b/mkdocs/requirements.txt
@ -0,0 +1,17 @@
+mkdocs==1.4.0
+mkdocs-literate-nav
+mkdocs-section-index
+mkdocs-include-markdown-plugin
+
+mkdocs-video
+mkdocs-material==8.5.8
+mike
+
+weasyprint==52.5
+mkdocs-with-pdf
+
+mkdocs-bootswatch
+
+pymdown-extensions
+
+mkdocs-glightbox==0.4.0
--- a/user-manuals.yml
+++ b/user-manuals.yml
@ -0,0 +1,80 @@
+site_name: Что нового
+repo_url: http://gogs.lex.lan/l8-base/Dokumentooborot
+edit_uri: _edit/master/docs/
+nav:
+
+markdown_extensions:
+    - toc:
+        separator: "_"
+        permalink: "#"
+        slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: "lower", percent_encode: true}}
+    - attr_list
+    - admonition
+    - sane_lists
+    - pymdownx.highlight
+    - pymdownx.superfences
+    - def_list
+
+extra_css:
+    - css/extra.css
+
+extra_javascript:
+    - javascripts/extra.js
+
+plugins:
+    - search:
+        lang: ['ru', 'en']
+    - section-index
+    - include-markdown
+    - literate-nav:
+        nav_file: SUMMARY.md
+    - with-pdf:
+        author: Альбина Янгирова, Ксения Шабанова, Ксения Имамутдинова, Тимур Мирзакаев, Марина Халиуллина
+        copyright: ООО "Лексема"
+        #
+        #cover: false
+        #back_cover: true
+        #cover_title: TITLE TEXT
+        cover_subtitle: Версия 0.0.1
+        #custom_template_path: TEMPLATES PATH
+        #
+        toc_title: Оглавление
+        #heading_shift: false
+        #toc_level: 3
+        #ordered_chapter_level: 2
+        #excludes_children:
+        #    - 'release-notes/:upgrading'
+        #    - 'release-notes/:changelog'
+        #
+        #exclude_pages:
+        #    - 'bugs/'
+        #    - 'appendix/contribute/'
+        #convert_iframe:
+        #    - src: IFRAME SRC
+        #      img: POSTER IMAGE URL
+        #      text: ALTERNATE TEXT
+        #    - src: ...
+        #two_columns_level: 3
+        #
+        #render_js: true
+        #headless_chrome_path: headless-chromium
+        #
+        output_path: pdf/user-manual.pdf
+        #enabled_if_env: ENABLE_PDF_EXPORT
+        #
+        #debug_html: true
+        #show_anchors: true
+        #verbose: true
+
+theme:
+    name: material
+    features:
+        - navigation.instant
+    language: ru
+    palette:
+        primary: white
+
+docs_dir: docs
+site_dir: site
+   
+