Soạn thảo văn bản

0. Demo

Demo bên dưới là minh họa cho những khả năng soạn thảo của BookStack. Người dùng có thể tham khảo cùng với tài liệu này.

https://bookstack.truesight.asia/books/bookstack/page/demo

1. Typography

1.1. Headers

Header được sử dụng để ~~styling~~định dạng cho đề mục, đồng thời cấu trúc nên điều hướng mục khi đọc. Để chỉnh sửa loại Headers, bấm vào menu Formats.

BookStack hỗ trợ 4 loại Header từ Large đến Tiny, tương đương 4 mức từ 1 đến 4 hoặc <h1> đến <h4>.

Phím tắt

Ctrl + 1: Large Header
Ctrl + 2: Medium Header
Ctrl + 3: Small Header
Ctrl + 4: Tiny Header

1.2. Paragraph

Đối với nội dung văn bản, BookStack sử dụng định dạng Paragraph. Ngoài ra BookStack hỗ trợ các định dạng đánh dấu khác.

Blockquote: trích dẫn

Callouts: chú thích, vv...

1.3. Styling

BookStack hỗ trợ những kiểu styling sau:

Bold: chữ đậm

Italic: chữ in nghiêng

Underline: chữ gạch chân

Text color: màu chữ

Background color: màu nền của chữ

Strikethrough: gạch ngang chữ

Super/sub-script: chỉ số trên/dưới

Inline code: code, sử dụng font monospace.

Clear formatting: bỏ styling

Copy dữ liệu từ Google Docs hoặc Google Sheet

Trực tiếp copy từ google docs hoặc google sheet sang Bookstack có thể gây lỗi về mặt format chữ và lưu trữ ảnh. Cách an toàn nhất là Download các tài liệu dưới dạng docx hoặc XLSX. Sau đó mở bằng Microsoft Office và copy các phần tương ứng lên bookstack => đảm bảo cấu trúc format và toàn bộ nội dung nằm trên bookstack.

Với các hình ảnh copy từ các trang web hoặc từ google docs thì bookstack sẽ chỉ lưu link gốc của ảnh đó => việc hiển thị có thể bị mất nếu nguồn dữ liệu của ảnh đã bị xoá. Tốt nhất là lưu file về máy rồi up lại lên bookstack để ảnh được lưu trong server của bookstack. Các ảnh dạng cắt màn hình, sau khi paste vào vào editor sẽ được lưu lên bookstack server

Sử dụng các diagram

Có 2 loại diagram chính được sử dụng trong bookstack là diagram.net (draw.io) và mermaidjs. Trong đó

Diagram.net dùng để vẽ các loại biểu đồ bằng cách kéo thả 1 diagram vào. và có thể trực tiếp chỉnh sửa diagram này. Bookstack sẽ lưu file diagram này trên server và hỗ trợ chỉnh sửa khi cần
MermaidJS hỗ trợ tạo các diagram dạng UML để viết các loại tài liệu thiết kế và tài liệu tích hợp. Việc vẽ biểu đồ của mermaid bằng cách sử dụng các đoạn script và gen ra biểu đồ tương ứng.

Template

Bookstack hỗ trợ tạo template. Với các loại tài như biên bản họp, tài liệu nghiệp vụ, danh sách công việc, checklist,... Cần tạo ra template để tái sử dụng cho các lần sau, hạn chế sai sót trong quá trình tạo tài liệu