Gisqus (#155)

* Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix codings * Fix disqus integration * Add gitignore * Add gitignore * Preparing for gisqus
Kanaduchi · Jan 18, 2022 · a4cc8df · a4cc8df
1 parent a6d4e33
commit a4cc8df
Show file tree

Hide file tree

Showing 21 changed files with 575 additions and 63 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+![VW coding](docs/assets/logo.png)  
+
+## Adding codings
+
+You can use the template below to add new codings
+
+```
+    ### Name of coding / adaptation
+
+    !!! tip ""
+        Tip/info message
+
+    !!! warning ""
+        Some warning message
+
+    ``` yaml
+    Block XX → Adaptation:
+    Name of volume/folder:
+    - Name of parameter: activate
+    → Apply
+    ```
+
+    ??? note "Collapsibale list"
+        This information is displayed collapsed on the site
+
+    > Login-password: 000000 (if applicable)
+```
+
+Path for images: `/docs/images`  
+Path to firmwares: `/docs/firmwares`  
+Path to parameter files: `/docs/parameters`  
+
+Insert image to the page:  
+![Screenshot](../images/MQB/odis-e-tires.png) 
+
+Insert file to the page:  
+[(Сборка для Skoda)](../firmwares/TMC-zz.rar)  
+
+## Adding localizations
+
+If you want to help in translating this site to English language, please contribute a localization!   
+
+Follow these steps to add a localization:
+1. Copy particular file in /docs directory to new with lang suffix. Example: drive.md → drive.en.md 
+2. Start translating the strings
+3. Edit mkdocs.yaml and edit the following variables:
+Make sure that all navigation items translated correctly
+```yaml
+nav_translations:
+    en:
+```
+5. Create a PR with your localization updates.
+
diff --git a/README.en.md b/README.en.md
@@ -0,0 +1,15 @@
+![VW coding](docs/assets/logo.png)
+
+## Description
+
+This site is build with Markdown language.
+
+## Contributing
+
+If you want to add new codings or languages see [CONTRIBUTING.md][contributing]
+
+## Supporting
+
+If you like this project you can support it by online transfer to our wallet using Yandex transfer system:   
+    <iframe src="https://yoomoney.ru/quickpay/button-widget?targets=%D0%9F%D0%BE%D0%B4%D0%B4%D0%B5%D1%80%D0%B6%D0%BA%D0%B0%20%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0%20vwcoding.ru&default-sum=100&button-text=11&yoomoney-payment-type=on&button-size=s&button-color=orange&successURL=vwcoding.ru&quickpay=small&account=4100110582992748&" width="127" height="25" frameborder="0" allowtransparency="true" scrolling="no"></iframe>
+
diff --git a/README.md b/README.md
@@ -1,41 +1,5 @@
 ![VW coding](docs/assets/logo.png)  
 
-## ENGLISH DESCRIPTION
-
-This site is build with Markdown language. You can use the template below to add new codings
-
-```
-    ### Name of coding / adaptation
-
-    !!! tip ""
-        Tip/info message
-
-    !!! warning ""
-        Some warning message
-
-    ``` yaml
-    Block XX → Adaptation:
-    Name of volume/folder:
-    - Name of parameter: activate
-    → Apply
-    ```
-
-    ??? note "Collapsibale list"
-        This information is displayed collapsed on the site
-
-    > Login-password: 000000 (if applicable)
-```
-
-### Translation
-
-If you want to help in translating this site to English please do follow steps:  
-
-1. Copy particular file to new with en suffix. Example: drive.md → drive.en.md  
-2. Translate text in drive.en.md to English language  
-3. Create PR and Merge it  
-4. Translation will be automatically applied to the site  
-
-
 ## ОПИСАНИЕ
 
 Данный сайт построен с использованием языка разметки Markdown.  
@@ -64,9 +28,12 @@ If you want to help in translating this site to English please do follow steps:
     > логин-пароль 000000 (если есть)
 ```
 
-Путь для хранения изображений:
-Путь до прошивок:
-Путь до параметрий:
+Путь для хранения изображений: `/docs/images`  
+Путь до прошивок: `/docs/firmwares`  
+Путь до параметрий: `/docs/parameters`  
 
-Пример вставки изображений на страницу сайта:
+Пример вставки изображений на страницу сайта:  
+![Screenshot](../images/MQB/odis-e-tires.png) 
 
+Пример вставки файлов на страницу сайта:  
+[(Сборка для Skoda)](../firmwares/TMC-zz.rar)  
diff --git a/docs/MQB/fixConfirmationCode.md b/docs/MQB/fixConfirmationCode.md
diff --git a/docs/MQB/headDeviceFunctions.md b/docs/MQB/headDeviceFunctions.md
@@ -78,14 +78,10 @@ D = Delphi Краткая версия модуля
     В зависимости от устройства (RAM / CPU) обновление занимает от 20 до 60 минут  
 
 После обновления прошивки на панели будет мигать глонасс — это нормально, не бойтесь.  
-Так же может появиться ошибка "Подтверждение изменения по установке" - нужно будет подтвердить обновление прошивки кодом.  
 
-``` yaml
-Блок 5F → Адаптация:
-> Подтверждение изменения установки (Confirmation of installation change)  
-Код из адаптации нужно внести в XOR генератор (http://mib-helper.com/im-so-xory/) и получить ответный код  
-> Ввести полученный код и подтвердить изменение
-```
+!!! warning ""
+    После обновления прошивки может появиться ошибка "Подтверждение изменения по установке". Необходимо будет подтвердить обновление прошивки кодом.  
+    [Инструкция и XOR калькулятор](../../xorCalculator)
 
 ### Активация Telnet соединения
 

diff --git a/docs/MQB/tiresCoding.md b/docs/MQB/tiresCoding.md
@@ -1,5 +1,4 @@
 ---
 template: ./tiresGenerator.html
 title: Генератор параметрии шин
-
 ---
diff --git a/docs/history.md b/docs/history.md
@@ -1,8 +1,13 @@
 ---
 disqus: ""
+giscus: ""
 ---
 # История изменений
 
+### 18.01.2022
+1. Добавлен XOR калькулятор
+2. Структура сайта переделана под использование Giscus системы комментариев
+
 ### 03.01.2022
 1. Обновление структуры сайта
 2. Добавлен новый раздел с eeprom кодированием

diff --git a/docs/index.en.md b/docs/index.en.md
@@ -1,8 +1,10 @@
 ---
 title: Coding of VW cars
+template: ./main.en.html
 hide:
   - toc
 disqus: ""
+giscus: ""
 ---
 
 <style>
@@ -18,7 +20,7 @@ disqus: ""
 
 !!! info "Translation is in progress"
     Currently this site is written in Russian language.  
-    It is not possible to translate whole pages it to other languages due to restrictions of MKdocs.
+    If you want to help in translating pages to English language please [follow the instructions](https://github.com/Kanaduchi/vwcoding/blob/master/CONTRIBUTING.md)
 
 !!! danger "Warning!"
     Sharing information from this site is allowed only with the copyright notice and link to this resource.  

diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,7 @@
 hide:
   - toc
 disqus: ""
+giscus: ""
 ---
 
 <style>

diff --git a/docs/longCoding.en.md b/docs/longCoding.en.md
@@ -1,10 +1,14 @@
 ---
 title: Long-coding calculator
+template: ./main.en.html
 hide:
   - toc
 ---
-
-# Long-coding calculator
+
+<style>
+  .md-typeset h1 {
+    display: none;
+</style>
 
 Numeration of Bytes and bits are always starting with 0. Bits can be manually set to "1" to enable a specific bit in binary code.  
 

diff --git a/docs/longCoding.md b/docs/longCoding.md
@@ -4,8 +4,6 @@ hide:
   - toc
 ---
 
-# Калькулятор длинного кодирования
-
 Нумерация байтов и битов всегда начинается с 0. В битах можно вручную проставлять "1" для включения определенного бита в двоичном коде.  
 
 Порядок в битах идет с конца, например,  

diff --git a/docs/main.en.md b/docs/main.en.md
@@ -2,4 +2,5 @@
 template: ./home.en.html
 title: Coding of VW cars
 disqus: ""
+giscus: ""
 ---
diff --git a/docs/main.md b/docs/main.md
@@ -2,4 +2,5 @@
 template: ./home.html
 title: Кодирование автомобилей VAG
 disqus: ""
+giscus: ""
 ---
diff --git a/docs/questions.en.md b/docs/questions.en.md
@@ -1,3 +1,6 @@
-
+---
+template: ./main.en.html
+title: Coding of VW cars
+---
 # Feedback
 If you have any ideas and questions you can leave feedback here in the comments
diff --git a/docs/xorCalculator.en.md b/docs/xorCalculator.en.md
@@ -0,0 +1,32 @@
+---
+template: ./main.en.html
+title: Coding of VW cars
+hide:
+  - toc
+---
+
+<style>
+  .md-typeset h1 {
+    display: none;
+</style>
+
+# XOR Calculator
+
+After changing firmware of Main Unit you can get `1555 / B201A Checking Software Version Management` fault code in the 5F control module.
+XOR calculator is used to confirm firmware.
+
+To confirm changing of firmware you need to:
+1. Read current value from adaptation channel:
+``` yaml
+Блок 5F → Adaptation:
+- Confirmation of installation change
+```
+2. Copy this value to calculator below and generate confirmation key
+3. Write confirmation key to the adaptation:
+``` yaml
+Блок 5F → Adaptation:
+- Confirmation of installation change: confirmation key
+→ Save
+```
+
+--8<-- "overrides/xorCoding.en.html"
diff --git a/docs/xorCalculator.md b/docs/xorCalculator.md
@@ -0,0 +1,26 @@
+---
+title: XOR Калькулятор
+hide:
+  - toc
+---
+
+# XOR Калькулятор
+
+Данный калькулятор используется для подтверждения прошивки ГУ на автомобилях VW. 
+После смены прошивки в блоке A5 может появиться ошибка `1555 / B201A - Подтверждение изменения по установке`.
+
+Для подтверждения изменений прошивки необходимо:
+1. Считать код из адаптации:
+``` yaml
+Блок 5F → Адаптация:
+- Подтверждение изменения установки (Confirmation of installation change)  
+```
+2. Внести код в калькулятор и сгенерировать код подтверждения
+3. Записать код в адаптацию:
+``` yaml
+Блок 5F → Адаптация:
+- Подтверждение изменения установки (Confirmation of installation change): сгенерированный код
+→ Применить
+```
+
+--8<-- "overrides/xorCoding.html"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,17 +5,13 @@ site_author: Kanaduchi
 site_url: http://www.vwcoding.ru
 
 # Hot news
-hot_news_date: 03.01.2022
+hot_news_date: 17.01.2022
 hot_news_title: Все ваши предложения и новые идеи можно присылать на [email protected]
 hot_news_title_en: Fill free to send all your ideas and updates to [email protected]
 hot_news: >
-  1. <a href='https://vwcoding.ru/MQB/rearLights'>Задние динамические поворотники для Tiguan 2021 с фарами IQ Light</a><br>
-  2. <a href='https://vwcoding.ru/MQB/pACC'>SWaP для ACC и pACC</a><br>
-  3. <a href='https://vwcoding.ru/MQB/2Q0_assistants.md'>Кодирование 2Q0* камеры ассистентов</a><br>
+  1. <a href='https://vwcoding.ru/xorCalculator'>Добавлен XOR калькулятор</a>
 hot_news_en: >
-  1. <a href='https://vwcoding.ru/MQB/rearLights'>Back dynamic IQ Lights for Tiguan 2021</a><br>
-  2. <a href='https://vwcoding.ru/MQB/pACC'>SWaP for ACC & pACC</a><br>
-  3. <a href='https://vwcoding.ru/MQB/2Q0_assistants.md'>Coding of 2Q0* camera</a><br>
+  1. <a href='https://vwcoding.ru/en/xorCalculator'>XOR calculator</a>
 
 # Repository
 repo_name: Kanaduchi/vwcoding
@@ -77,6 +73,12 @@ extra_css:
 
 extra:
   disqus: https-mqb-readthedocs-io
+  giscus:
+    enable: false
+    repo: Kanaduchi/vwcoding
+    repo_id: MDEwOlJlcG9zaXRvcnkyMTQ4NTE3Njk=
+    category: General
+    category_id: MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyNjYxNjIy
   alternate:
     - name: Русский
       link: ./
@@ -100,12 +102,45 @@ plugins:
           Платформа PQ26: PQ26 platform
           Платформа PQ35: PQ35 platform
           Калькулятор длинного кодирования: Long-coding calculator
+          XOR калькулятор: XOR calculator
           Инструменты и адаптеры: Instruments and adapters
           Список инструментов: Adapters
           Инструкция ODIS E: ODIS E instruction
           Обратная связь: Feedback
           История изменений: History of changes
           Поддержать проект: Support of project
+
+          Ассистенты водителя: Drive assistance
+          Активация ACC и pACC: ACC & PACC activation
+          Кодирование ACC: ACC coding
+          Кодирование 3Q* камеры: Coding of 3Q* cameras
+          Кодирование 2Q* камеры: Coding of 2Q* cameras
+          Прошивки камеры ассистентов: Assistance camera firmwares
+          Системы активной безопасности: Safety features
+          Настройка профилей движения (FPA): Configuration of FPA profiles
+          Движение и управление: Driving
+          Парковка и маневрирование: Parking
+          Эстетическая подсветка: Estetic lights
+          Кодирование подсветки: Coding of estetic lights
+          Кодирование зон освещения: Zones of estetic lights
+          Установка RGB подсветки: RGB estetic lihts
+          Зеркала и стеклоочистители: Wash and mirrors
+          Отпирание и запирание: Open and Closing
+          Освещение: Lights
+          Кодирование фонарей: General codings
+          Передние фонари: Front lights
+          Задние фонари: Rear lights
+          Звук: Sound
+          Климат: Climate
+          Приборная панель: Control panel
+          Головное устройство: Main unit
+          Кодирование: General coding
+          Активация TMC: Activation of TMC
+          SWaP коды для CM и DM: SWap for DM and CM units
+          Снятие защиты и SWaP для Pro: Unlocking and SWaP of Pro
+          Шины: Tires
+          Генератор параметрии: Parameter generation
+          Дооснащение: Addons
           Eeprom память: Eeprom memory
   - search:
       lang:
@@ -165,6 +200,7 @@ nav:
       - Платформа PQ26: PQ26/main.md
       - Платформа PQ35: PQ35/main.md
       - Калькулятор длинного кодирования: longCoding.md
+      - XOR калькулятор: xorCalculator.md
       - Инструменты и адаптеры:
           - Список инструментов: programs.md
           - Инструкция ODIS E: odis-e.md
@@ -249,4 +285,5 @@ nav:
           - Приборная панель: PQ35/Tiguan/instrPanel.md
           - Мультимедиа: PQ35/Tiguan/multimedia.md
   - Калькулятор длинного кодирования: longCoding.md
+  - XOR калькулятор: xorCalculator.md
   - Поддержать проект: https://yoomoney.ru/to/4100110582992748/100
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     hide:
       - toc
     disqus: ""
+    giscus: ""
     ---
     <style>
@@ Expand Down @@