Focalboard 用户指南：从创建看板、多视图协作到分享与归档的完整上手实操

Focalboard 用户指南从创建看板、多视图协作到分享与归档的完整上手实操【免费下载链接】focalboardFocalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.项目地址: https://gitcode.com/GitHub_Trending/fo/focalboardFocalboard 是一款开源、可自托管、持续迭代更新的项目管理工具其定位是 Trello、Notion、Asana 的开源自托管替代方案。本文基于官方 Users Guide 整理覆盖从「新建看板 → 多视图管理 → 卡片编辑 → 模板复用 → 公开分享 → 归档备份」的完整操作链路并结合当前仓库的前端源码webapp/src/blocks/与webapp/src/archiver.ts讲解每一步背后的数据模型与实现原理帮助你在个人桌面版或自托管服务器实例上快速上手并理解其工作方式。1. 新建 Board从模板开始新建看板是使用 Focalboard 的第一步官方指南给出了标准流程点击侧边栏sidebar左下角的 Add Board为 Focalboard 添加一个新看板。从模板列表中挑选一个模板例如Project Tasks项目任务。此时你会看到新看板的第一个视图——一张包含所有任务的表格视图Table View。新建 Project Tasks 看板后默认显示的任务表格视图从界面可以看到模板看板自带 Name任务名、Status状态、Priority优先级、Date Created创建日期等列底部有 New按钮用于添加新任务。从源码看默认模板之所以自带这些属性是因为看板的数据结构webapp/src/blocks/board.ts中的cardProperties卡片属性模板数组承载了每个看板全部卡片共有的属性定义且createBoard()在没有任何属性时会默认注入一个名为Status、类型为select单选的属性。Focalboard 支持的属性类型非常丰富从 webapp/src/blocks/board.ts 中的PropertyTypeEnum可以看到完整清单属性类型说明text文本number数字select单选可用于看板分组见下文multiSelect多选date日期person/multiPerson单人多选 / 多人多选file文件checkbox复选框url/email/phone链接 / 邮箱 / 电话createdTime/createdBy/updatedTime/updatedBy系统自动维护的创建/更新时间与人其中每个属性模板IPropertyTemplate由id、name、type和options选项列表每个选项含id、value、color组成。1.1 切换到看板视图Board View创建完表格视图后点击侧边栏中的By Status即可看到看板的看板视图Board View——任务卡片按 Status 属性值如 No Status、Next Up、In Progress、Completed分成多列展示。按状态分组的看板视图点击视图顶部的Properties属性菜单打开Priority优先级和Date created创建日期开关即可让这两项属性显示在卡片上。通过 Properties 菜单开启 Priority 与 Date created 属性从源码结构看「属性菜单」的本质是修改视图View的visiblePropertyIds可见属性 ID 列表这一字段定义在 webapp/src/blocks/boardView.ts 的BoardViewFields中。同样地你还可以修改该视图的Group By分组依据、Filter筛选条件与Sort排序规则设置。一般来说你在 Focalboard 中做出的所有修改都会被立即保存并对其他所有用户实时可见——这也是它作为协作工具的核心体验之一。1.2 视图的数据模型一次看清 Group / Filter / Sort为什么「分组、筛选、排序」可以同时并存且互不干扰因为在 Focalboard 中每个视图就是一个独立的块Block。从 webapp/src/blocks/boardView.ts 可以看到BoardViewFields定义了视图的全部状态viewType视图类型取值为board | table | gallery | calendar即看板、表格、画廊、日历四种视图可在同一看板下并存groupById分组依据的属性 IDsortOptions排序选项数组{propertyId, reversed}visiblePropertyIds/hiddenOptionIds卡片上可见的属性 / 被折叠隐藏的分组选项filter筛选条件由FilterGroup表达见 webapp/src/blocks/filterGroup.tscardOrder未排序状态下卡片的手动排列顺序columnWidths/columnCalculations列宽与列上的聚合计算配置defaultTemplateId该视图默认使用的卡片模板。理解这一点后「新视图」的概念就非常清晰了它只是同一份卡片数据在不同分组/筛选/排序/类型参数下的另一种呈现切换视图不会改动任何卡片本身。2. 重命名看板与设置图标点击看板标题即可进入编辑状态直接修改看板名称。同时看板和卡片都可以设置图标icon——例如用 emoji 区分不同项目看板或标记卡片类别。从源码看看板的title、icon、description与showDescription都是 webapp/src/blocks/board.ts 中Board类型的内置字段而卡片的icon字段定义在 webapp/src/blocks/card.ts 的CardFields中。3. 添加新视图同一看板多种视角点击视图名称旁的下拉箭头在下拉菜单中选择Add view添加视图即可为当前看板新增一个视图。视图名称旁的下拉菜单中的 Add view 选项下拉菜单中会列出该看板已有的全部视图All Tasks、By Priority、By Status 等并提供Add View新增视图与Delete View删除视图入口。结合上文源码可知新增视图本质上是创建了一个新的view类型 Block其viewType决定呈现为看板、表格、画廊还是日历。3.1 拖拽卡片快速改变分组属性将一个卡片从某一列拖到另一列即可改变它的分组属性值。例如把任务卡片拖到Completed已完成列就相当于把该卡片的 Status 属性改为「已完成」。当看板未排序时你可以把卡片拖到某一列的指定行以精确控制卡片在列内的顺序对应源码中的cardOrder字段。当看板已排序时把卡片拖入某列后该列会按照视图设定的排序规则自动重排对应sortOptions字段你无法手动控制行位置。3.2 编辑卡片属性、评论与内容选中一张卡片即可打开卡片编辑器。一张卡片由三部分组成一组属性Properties属性对该看板内的所有卡片是通用的。看板视图可以将「单选Select」类型的属性作为分组依据把卡片分成不同列展示。一组评论Comments适合记录重要的变更或里程碑节点便于团队回溯上下文。一组内容Content卡片内容可以由 Markdown 文本和图片组成适合记录详细规格、设计决策等长文本信息。按ESC键或点击卡片编辑器对话框之外的区域即可关闭卡片编辑器。从源码看「卡片」的数据模型webapp/src/blocks/card.ts由icon、properties属性键值对、contentOrder内容块排列顺序、isTemplate是否为模板组成而「内容块」的类型定义在 webapp/src/blocks/block.ts 的contentBlockTypes中包括text、image、divider、checkbox、h1、h2、h3、list-item、attachment、quote、video等。也就是说卡片里一段 Markdown、一张图、一个视频附件本质都是挂在卡片下的独立内容块Block通过contentOrder决定显示顺序——这正是「内容可自由组合、可拖拽排序」的实现基础。3.3 表格视图Table View属性即列在表格视图中每一列对应一个卡片属性你可以直接在单元格内编辑属性值也可以将鼠标悬停在某行的标题上点击open打开该行的卡片编辑器点击列头可按该列排序或通过列头菜单插入新属性列Insert left / Insert right、隐藏、复制、删除列。表格视图的列头菜单排序、插入列、隐藏、复制、删除4. 模板卡片模板与看板模板模板是 Focalboard 提升重复性工作流效率的关键机制卡片模板和看板模板都原生支持。4.1 卡片模板每个看板都可以维护一组卡片模板点击New按钮旁的下拉箭头选择 New template新建模板此时会打开卡片编辑器顶部会出现一条提示横幅表明当前正在编辑的是一个模板而非普通卡片之后你便可以基于这个新模板快速创建新卡片预设好属性值、内容与结构。此外你也可以把任意现有卡片转换成模板打开该卡片的编辑器点击右上角的选项菜单...选择New template from card从卡片新建模板。从源码看卡片模板与普通卡片的唯一区别是 webapp/src/blocks/card.ts 中CardFields.isTemplate字段为true模板本质上仍然是一个完整的卡片块。4.2 看板模板看板模板的创建方式与之类似在 Add board菜单中可以选择已有的看板模板来新建看板若想把现有看板变成模板将鼠标悬停在侧边栏中的看板标题上点击选项菜单...选择New template from board从看板新建模板。侧边栏看板标题旁的选项菜单Delete board / Duplicate board / New template from board从 webapp/src/blocks/board.ts 中的Board类型可以看到看板同样带有isTemplate与templateVersion模板版本号字段模板与普通看板共用同一数据模型。5. 分享看板生成公开链接Focalboard 支持把看板发布到 Web以只读链接的形式分享给任何人。官方指南给出的步骤为将鼠标悬停在看板菜单的右侧区域点击选项菜单...选择Share board分享看板看板右上角菜单中的 Share board 选项打开标有Publish to web and share this board with anyone发布到 Web与任何人分享此看板的开关复制给出的链接形如.../shared?idboard-id的公开只读地址将该链接分享给其他人任何持有该链接的人都能查看这个看板若想使此前分享出去的所有链接失效点击Regenerate Token重新生成令牌此时会弹出确认框This will invalidate previously shared links. Continue?这将使之前分享的链接失效是否继续点击OK后令牌即被重新生成旧链接全部失效。Share board 菜单公开开关、只读链接与 Regenerate token在仓库中分享功能对应「共享令牌token」机制前端侧分享相关的数据模型位于 webapp/src/blocks/sharing.ts服务端处理分享链接的接口实现位于 server/api/sharing.go其中令牌token是控制链接有效性的核心凭证——重新生成令牌即替换该凭证从而让旧链接无法再访问看板。6. 归档Archive备份与迁移你可以从**设置菜单Settings**导出全部看板的归档文件。Settings 菜单Import archive 与 Export archive 入口归档的典型用途包括快速备份快照定期导出作为看板数据的离线快照跨安装迁移例如把数据从个人桌面版Personal Desktop迁移到服务器安装Server install实例。使用时有两点需要注意归档文件目前不包含图片和文件附件例如卡片中插入的图片迁移后如需保留附件需要单独处理导入归档会覆盖与归档条目同名的既有项变更但不会影响归档之外的额外条目例如看板中新建、但不在归档里的其他看板和卡片。从源码看归档功能实现在 webapp/src/archiver.tsexportFullArchive(teamID)导出整个团队全部看板的归档exportBoardArchive(board)导出单个看板的归档导出文件按archive-YYYY-M-D.boardarchive命名扩展名为.boardarchiveimportFullArchive()通过文件选择器读取.boardarchive文件并导入mutator.importFullArchive(file)服务端的导入导出逻辑对应 server/api/archive.goArchiver.isValidBlockwebapp/src/archiver.ts则用于校验归档中每个块必须包含合法的id与boardId。7. 小结回顾整条上手路径Focalboard 的核心设计可以概括为三点块Block即一切看板、视图、卡片、评论、内容块都是同构的 Block这让数据模型统一、易于扩展也让「同一数据、多视图呈现」成为可能模板驱动复用卡片模板isTemplate与看板模板isTemplatetemplateVersion共用普通数据模型创建、转换成本极低协作与迁移开箱即用所有修改即时保存并对全体成员可见配合公开只读分享链接与.boardarchive归档格式可轻松完成协作者共享与跨实例迁移注意归档暂不含附件。如果你想继续深入可以接着阅读仓库中的 README.md、开发者指南或直接查看本文引用的前端数据模型webapp/src/blocks/与服务端归档实现server/api/archive.go进一步理解 Focalboard 的块结构与工作流。【免费下载链接】focalboardFocalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.项目地址: https://gitcode.com/GitHub_Trending/fo/focalboard创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考