CSM-Wiki

可通信状态机（CSM）是一个基于JKI状态机（JKISM）的LabVIEW应用框架。本仓库用于存储CSM的文档和示例代码。

• 可通讯状态机(CSM)框架源码
• Wiki地址

_本仓库使用了以下的开源项目或服务_：

• 使用 visual-studio-code 作为编辑器
• 使用 copilot 作为提示工具,并补充部分内容
• 使用 markdownlint 用于 markdown 文件的语法检查
• 通过 GitHub Pages 服务发布页面
• 使用 Jekyll 静态网站生成器
• 使用 sighingnow/jekyll-gitbook 主题
• 使用 untra/polyglot ,一个Jekyll插件，用于多语言支持
• 使用 gildesmarais/jekyll-loading-lazy ,一个Jekyll插件，用于惰性加载图片资源，提高网页相应速度

TODO LIST

网站部分：- [@nevstop](https://github.com/nevstop)
- [√] HOME 页面(md-page[√]) - English[100%] | Chinese [100%]
      CSM框架的介绍; CSM框架的特点; CSM框架的应用场景; CSM框架的下载链接; 开源资源使用说明
- 404 页面(md-page[√]) - English[50%] | Chinese [50%]
      404页面
- [HIDE] About 页面(md-page[√]) - English[-] | Chinese [-]  ??? 和HOME页面重复了, 是否需要保留
      关于CSM框架的介绍
- Contributors 页面(md-page[√]) - English[100%] | Chinese [100%]
      如何参与到项目中来; 项目的贡献者列表
- [√] Download 页面(md-page[√]) - English[100%] | Chinese [100%]
      下载CSM框架的最新版本的链接; 历史版本的更新记录
- 和其他框架比较的页面(md-page[√]) - English[-] | Chinese [50%]
      本身的特点; 和JKISM的比较; 和DQMH/SMO/AFW等框架的比较
- FAQ 页面(md-page[√]]) - English[-] | Chinese [100%]
      常见问题的解答

文档部分：
- JKISM内容介绍
  - JKISM的介绍(md-page[√]) - English[-] | Chinese [1%]
        介绍JKISM的概念和用法; 介绍 JKISM 的优势；介绍 JKISM 的不足; 介绍 JKISM 的应用场景
  - JKISM的推荐用法(md-page[√]) - English[-] | Chinese [1%]
        介绍JKISM的Best Practice

- 基础内容部分 - [@KivenJia](https://github.com/KivenJia)
  - CSM的基本概念(md-page[-]) - English[-] | Chinese [80%]
        CSM 中所有的基本概念，其他地方用到的都是基于这里的概念来解释的
  - CSM模块间的通讯(md-page[-]) - English[-] | Chinese [60%]
        模块间的同步消息；模块间的异步消息；模块间的状态
  - 创建CSM的复用模块(md-page[-]) - English[-] | Chinese [60%]
        创建CSM的复用模块的方法
  - 调用CSM的模块(md-page[-]) - English[-] | Chinese [60%]
    - 被CSM框架调用: 使用字符串方式进行调用；使用CSM的API进行调用；指向用到的函数
    - 被其他框架调用：使用CSM的API进行调用;指向用到的函数
  - CSM的参数传递(md-page[-]) - English[-] | Chinese [40%]
        参数传递在CSM中的特殊性；不同场景目前应该使用的方式

- 进阶内容部分
  - CSM内置的错误处理机制(md-page[√]) - English[-] | Chinese [1%]
        举例说明如何使用CSM内置的错误处理机制
  - 工作者模式(worker Mode)(md-page[√]) - English[-] | Chinese [1%]
        说明工作者模式设计的思路；举例说明如何使用工作者模式
  - 责任链模式(Chain Mode)(md-page[√]) - English[-] | Chinese [1%]
        说明责任链模式设计的思路；举例说明如何使用责任链模式

- 预留的插件机制
  - Addon 接口(md-page[√]) - English[-] | Chinese [-]
        addon留下接口的位置；如何给CSM添加addon
  - Template 接口(md-page[√]) - English[-] | Chinese [-]
        template留下接口的位置；如何给CSM添加template
  - Tools 接口(md-page[√]) - English[-] | Chinese [-]
        tools留下接口的位置；如何给CSM添加tools

- (还未实现) LabVIEW的CSM Plugin
  - (TODO) STRING右键：弹出模块、消息列表，并快速填写(md-page[-]) - English[-] | Chinese [-]
        (待功能实现后补充)
  - (TODO) STRING右键：替换为SafeString(md-page[-]) - English[-] | Chinese [-]
        (待功能实现后补充)

- 调试工具/调试方法
  - CSM内置的全局事件(md-page[-]) - English[-] | Chinese [10%]
        说明CSM内置的全局事件包含的功能；如何使用全局事件；介绍函数
  - JKISM State Editor(md-page[-]) - English[-] | Chinese [0%]
        介绍JKISM State Editor的功能；介绍如何使用JKISM State Editor
  - CSM Global Log Window(md-page[-]) - English[-] | Chinese [50%]
        介绍CSM Global Log Window的功能
  - CSM State Dashboard Window(md-page[-]) - English[-] | Chinese [50%]
        介绍CSM State Dashboard Window的功能
  - CSM State Table Window(md-page[-]) - English[-] | Chinese [50%]
        介绍CSM State Table Window的功能
  - (TODO) CSM Test Panel(md-page[-]) - English[-] | Chinese [-]
        (待功能实现后补充)

- Addon/Plugins
  - MassData参数支持(md-page[-]) - English[-] | Chinese [-]
        说明MassData应用的场景, 链接到REPO
  - API String参数支持(md-page[-]) - English[-] | Chinese [-]
        说明API String应用的场景, 链接到REPO
  - INI/静态参数支持(md-page[-]) - English[-] | Chinese [-]
        说明INI/静态参数应用的场景, 链接到REPO

- 应用列表
  - Continuous Measurement and Logging Project(md-page[-]) - English[90%] | Chinese [90%]
  - <<补充其他的项目>>

- References - [@nevstop](https://github.com/nevstop)
  - CSM Palette(md-page[√]) - English[60%] | Chinese [60%]
        介绍所有CSM的函数
  - CSM Template(md-page[√]) - English[60%] | Chinese [60%]
        介绍CSM的Event模板; 介绍CSM的No-Event模板