cleword-ide

安装

在VSCode插件市场搜索Cleword IDE，选择Cleword Lab开发的一项。如果VSCode内部无法搜索到插件，可以直接到这里选择右侧的Download Extension下载.vsix包，并按如下图示步骤从VSIX安装。

install from vsix instruction

建议升级至最新版VSCode。

按下Ctrl+Alt+Win/Meta+N或者选择菜单文件→新建文件...（注意是后面带...的选项），然后选择「新建项目」。根据目前VSCode的状态，会有如下三种情况：

如果选择的目录里包含project.json，这说明这个目录可能已经是一个Cleword YAML项目，插件会询问是否要覆盖。如果确定要覆盖（或者原本并没有project.json文件），会弹出三种预置的模板；选择Custom 自定义会弹出新建项目的表单。

new project form

其中：

「项目名称」和「项目描述」就是新项目的名称/描述。
「项目学习系统」：
- 「名称」指学习系统的名称。注意：虽然目前(2021.11.24)这一栏的内容对项目本身的呈现并没有实际的影响，但是建议填与系统相关的名字（e.g. Blackboard则填「Blackboard」「blackboard」「黑板」等）。
- 「URL」指学习系统的URL。注意：这个URL并不一定是学习系统首页的URL，例如Surfer的首页是https://surfer.cleword.cn，但是Surfer系统的URL是https://surfer.cleword.cn/#/system。不清楚该填什么的时候，建议询问对应系统的开发人员。
- 插件自带三个不同的学习系统的配置：对话式课堂「Surfer」，Python课堂「Thallo」和黑板课堂「Blackboard」。这个选项仅仅用于下面的「名称」「URL」等栏的自动填充，新建项目时还是以栏中的实际内容为准。
- 选择「使用本地Schema目录」时，「Schema」一栏指定本地的Schema目录的名字。使用本地Schema时，需要开发者手动保存对应学习系统的Schema到本地并自行维护。插件并不会自动从学习系统下载Schema，因为Schema地址跟学习系统的地址没有强相关的联系。

注意：目前插件并不会自动初始化Git/Mercurial/Fossil等版本管理软件仓库。如果需要版本管理，要另外手动初始化。

使用键盘快捷键Ctrl+Cmd/Win/Meta+R，或者使用Ctrl/Command+Shift+P唤起VSCode命令执行窗口后选择Cleword IDE: Preview Project。在打开了多个文件夹的时候，顶端会出现文件夹选择窗口，用于选择需要预览的项目。

有时会希望直接从项目里的某个非课程入口的文件开始预览。目前插件支持通过如下四种操作进行预览：

安装插件之后重新加载VSCode，底部状态栏会出现新增的两项：

其中：

No active ClewordPub user（或者未登录 ClewordPub）：该项表示当前没有已经登录的用户。此时点击此项可以开始登录。目前支持通过邮箱和短信验证码登录。登录之后，此项会显示当前用户的名称。
- 登出时，通过左下角的用户按钮通过图示的方法登出。
- Cleword IDE支持同时登录多个帐号。如果需要登录多个帐号，点击该项会弹出用户选择列表，此时可以点击Login...登录新的帐号。
  
  这个列表也可以用于切换当前使用的用户。
Currently no upload（或者目前无上传任务）：该项表示当前没有正在上传的文件。登录之后点击此项，可以开始上传资源。
- 同时可以使用编辑器右上角的按钮上传资源：
- 上传时会在底部状态栏看到目前上传的状况。
- 上传成功后会将地址复制在剪贴板里，可以直接粘贴在文档内使用。

点击状态栏的「热重载未开启」或「No Hot Reload」按钮可以开启热重载。热重载将自动开始预览正在编辑的 CleYAML 文件。

npm run compile
vsce package

Q: 为什么预览时播放不了视频？
- A: 如果你使用了微软官方发布的 VSCode 安装包，那么这可能是由于官方发布的安装包不包含视频播放所必须的第三方库；为此，建议 Windows 和 macOS 用户使用VSCodium。