From 7312a54eae5d315d87de39c5853a7aa17750fa83 Mon Sep 17 00:00:00 2001 From: Liang Ding Date: Thu, 18 Sep 2014 16:09:23 +0800 Subject: [PATCH] GitBook --- doc/README.txt | 2 + doc/zh_CN/conf.html | 32 ------------- doc/zh_CN/dev/index.html | 79 ------------------------------- doc/zh_CN/editor.html | 35 -------------- doc/zh_CN/faq.html | 67 -------------------------- doc/zh_CN/features.html | 26 ---------- doc/zh_CN/index.html | 41 ---------------- doc/zh_CN/keyboard_shortcuts.html | 47 ------------------ doc/zh_CN/motivation.html | 40 ---------------- doc/zh_CN/multiplayer.html | 25 ---------- doc/zh_CN/setup.html | 47 ------------------ 11 files changed, 2 insertions(+), 439 deletions(-) create mode 100644 doc/README.txt delete mode 100644 doc/zh_CN/conf.html delete mode 100644 doc/zh_CN/dev/index.html delete mode 100644 doc/zh_CN/editor.html delete mode 100644 doc/zh_CN/faq.html delete mode 100644 doc/zh_CN/features.html delete mode 100644 doc/zh_CN/index.html delete mode 100644 doc/zh_CN/keyboard_shortcuts.html delete mode 100644 doc/zh_CN/motivation.html delete mode 100644 doc/zh_CN/multiplayer.html delete mode 100644 doc/zh_CN/setup.html diff --git a/doc/README.txt b/doc/README.txt new file mode 100644 index 0000000..9e67291 --- /dev/null +++ b/doc/README.txt @@ -0,0 +1,2 @@ +* User Guide: https://www.gitbook.io/book/88250/wide-user-guide +* Developer Guide: https://www.gitbook.io/book/88250/wide-dev-guide \ No newline at end of file diff --git a/doc/zh_CN/conf.html b/doc/zh_CN/conf.html deleted file mode 100644 index 97b969d..0000000 --- a/doc/zh_CN/conf.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - Wide - 配置 - - - -

配置

- - 
-{
-    "Server": "{IP}:7070", 运行的 IP，端口   
-    "StaticServer": "http://{IP}:7070", 静态资源服务 IP，端口
-    "EditorChannel": "ws://{IP}:7070", 编辑器消息通道
-    "OutputChannel": "ws://{IP}:7070", 输出窗口消息通道
-    "ShellChannel": "ws://{IP}:7070", Shell 消息通道
-    "StaticResourceVersion": "201409032040", 静态资源版本    
-    "MaxProcs": 4, Go 协程并行处理数量，可等于 Go CPU 核数
-    "RuntimeMode": "dev", 运行模式，dev 为开发模式，prod 为生产模式
-    "Pwd": "{pwd}", 工作目录，设置为 "{pwd}" 将自动获取
-    "Users": [
-        {
-            "Name": "admin", 用户名
-            "Password": "admin", 用户密码
-            "Workspace": "{pwd}/data/user_workspaces/admin" 用户工作空间（GOPATH）
-        }
-    ]
-}
-
- - diff --git a/doc/zh_CN/dev/index.html b/doc/zh_CN/dev/index.html deleted file mode 100644 index 3b662b3..0000000 --- a/doc/zh_CN/dev/index.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - Wide - 开发指南 - - - -

开发指南

-

- 该文档介绍了 Wide 的核心设计原理与实现。 -

- -

- 如果您要读 Wide 的源码或者要进行修改、二次开发等，请先仔细阅读该文档。 -

- -

关键设计

-

工作空间

-

- Wide 是一个多用户的集成开发环境，每个用户的工作空间是完全隔离的： -

- -

- 例如在执行“构建 & 运行”时，Wide 会设置命令 go build 执行的环境变量 $GOPATH 为用户的工作空间，这样编译过程就是在该用户的工作空间中进行，保证其隔离性。 -

- -

会话

-

- 在 UI 上存在两种 tab：浏览器 tab；编辑器 tab。 - 用户可以在一个浏览器 tab 中打开多个编辑器 tabs，但输出窗口只有一个。这意味着一个浏览器 tab 只能有一个正在运行的用户代码的程序进程。 - 需要同时运行多个程序进程的场景可以通过打开多个浏览器 tabs 达成。 -

- - - -

WebSocket

-

- WebSocket 用于后端推送数据给前端： -

- - - 通道和会话一对一关联，也就是说如果用户新开浏览器 tab，则新建通道和其关联。 - -

事件与通知

-

- 每个会话都有一个对应的事件队列，当接收到事件时取出该事件并转为通知，再通过通知窗口通道推送给前端。 - 还存在一个全局事件队列，入队的事件将分发到每个用户的事件队列中，以便进行通知广播。 -

- -

- 通知中的消息需要国际化处理。在语言配置文件中以 notification_ 为前缀，事件代码（event code）为后缀的项即通知消息。 -

- -

代码辅助

- - - - 代码辅助功能满足工作空间隔离。 - - -

编码规范

- - diff --git a/doc/zh_CN/editor.html b/doc/zh_CN/editor.html deleted file mode 100644 index 0c11c41..0000000 --- a/doc/zh_CN/editor.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - - Wide -编辑器 - - - -

编辑器

- -

Tabs

- - -

文件保存

- 在下面几种情况发生时会保存编辑器内容： - - 我们基本可以认为在写代码时文件是实时自动保存的。 - - diff --git a/doc/zh_CN/faq.html b/doc/zh_CN/faq.html deleted file mode 100644 index 7e78112..0000000 --- a/doc/zh_CN/faq.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Wide - 常见问题与解答 - - - -

常见问题与解答

- - - - diff --git a/doc/zh_CN/features.html b/doc/zh_CN/features.html deleted file mode 100644 index 24091af..0000000 --- a/doc/zh_CN/features.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - Wide -特性列表 - - - -

特性列表

- - - - diff --git a/doc/zh_CN/index.html b/doc/zh_CN/index.html deleted file mode 100644 index aec72cb..0000000 --- a/doc/zh_CN/index.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - Wide - 文档首页 - - - -

Wide

-

- Wide 是一个基于 Web 的团队 Golang IDE。 -

- -

动机

- -

特性

- - 完整特性列表。 - -

使用指南

- - -

开发指南

-

FAQ

- - diff --git a/doc/zh_CN/keyboard_shortcuts.html b/doc/zh_CN/keyboard_shortcuts.html deleted file mode 100644 index cb5d4d1..0000000 --- a/doc/zh_CN/keyboard_shortcuts.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - Wide - 键盘快捷键 - - - -

键盘快捷键

- -

编辑器

- - -

焦点

- - -

运行

- - - TBD: - - - diff --git a/doc/zh_CN/motivation.html b/doc/zh_CN/motivation.html deleted file mode 100644 index 399a38d..0000000 --- a/doc/zh_CN/motivation.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - Wide - 动机 - - - -

Wide 的由来

- - - - - diff --git a/doc/zh_CN/multiplayer.html b/doc/zh_CN/multiplayer.html deleted file mode 100644 index a0a3ad1..0000000 --- a/doc/zh_CN/multiplayer.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - Wide - 多用户 - - - -

多用户

-

- 支持多个用户同时使用一个 Wide 服务器，每个用户有自己独立的源代码仓库，编码/运行/调式都是在自己的工作空间中进行，不会影响其他用户。 -

- -

工作空间

-

- Wide 的工作空间就是 Go 中的 workspaces，每个用户的工作空间路径可在 wide.json 中进行配置。 -

- -

运行时

-

- 用户在运行程序时进程是跑在服务器上的，所以多用户同时运行程序时最常见的问题就是资源冲突（比如网络端口），目前这个问题只能靠用户自行规避。 -

- - - diff --git a/doc/zh_CN/setup.html b/doc/zh_CN/setup.html deleted file mode 100644 index c91dd8d..0000000 --- a/doc/zh_CN/setup.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - Wide - 安装 - - - -

安装

- -

基础安装

-
    -
  1. 下载 Wide 安装包
    2. -
  2. 解压到安装路径 {wide}，例如 /root/wide
    3. -
  3. 配置 {wide}/conf/wide.json（可选，默认配置应该可以工作）
    4. -
- -

多用户配置

- 前提：需要安装 git。 -
    -
  1. 初始化主库：在 {wide}/data/workspace/src 下执行 git init
    2. -
  2. 添加用户：修改 {wide}/conf/wide.json 中的 Users
    3. -
  3. 添加用户库：在 {wide}/data/user_workspaces/{user}/ 中 git clone 主库
    4. -
- -

从源码安装

- 前提： -
    -
  1. 搭建好 Go 开发环境
    2. -
  2. 安装好 git
    3. -
- - 步骤： -
    -
  1. 通过 git clone 或下载 zip 包方式获取 Wide 源码（项目地址：https://github.com/b3log/wide）
    2. -
  2. 获取依赖，在 Wide 源码目录下执行： -
      -
    • go get -u
      • -
    • go get -u github.com/88250/ide_stub
      • -
    • go get -u github.com/nsf/gocode
      • -
    -
  3. 编译：在 Wide 源码目录下执行 go build
    4. -
  4. 配置 {wide}/conf/wide.json（可选，默认配置应该可以工作）
    5. -
  5. 运行可执行文件 wide 或 wide.exe
    6. -
- -