Trình soạn thảo tài liệu

---

Giới thiệu

---

Trình soạn thảo tài liệu cho phép người viết tập trung vào nội dung, không cần quan tâm đến định dạng. Định dạng sẽ được quản lý tổng quát bằng tệp CSS trên server host nội dung tài liệu.

Trình soạn thảo tài liệu sử dụng MARK DOWN để tạo nội dung HTML.

Các nút lệnh:

1. Save and Upload : Publish tài liệu online.

2. Add Image : Dán hình trong clipboard vào tài liệu. Hình sẽ thể hiện là đường link.

3. Add Table : Tạo bảng trống.

4. Insert Link : Thêm link tới tính năng của Phoebus.

5. Render Html : Xem trước nội dung tài liệu.

6. Quick Learning : Học nhanh cú pháp MARK DOWN.

7. MD Help : Toàn bộ các cú pháp MARK DOWN được hỗ trợ và có thể sử dụng trong trình soạn thảo này.

Cách viết tài liệu Phoebus bằng Markdown

---

Để viết tài liệu cho 1 tính năng trên phoebus, ta có thể mở giao diện Write help bằng 2 cách:

• Sử dụng nút Write help sẵn có trên tính năng. (Chuyển đổi giao diện Write help là Markdown hay Snap cũ tại pbs.BO.PS.SystemSettings)
• Hoặc gọi trực tiếp lệnh sau:

pbs.BO.TechDoc.Commands.WriteHelpMD?SecurityId=funtions/subform
pbs.BO.TechDoc.Commands.WriteHelpMD?Topic=funtions/subform

Với: funtions là tính năng (pbs.bo.hr.emp, pbs.bo.la.na...) và thường được viết chữ thường

.

Hoặc viết tài liệu cho dashboard hoặc tài liệu khác:

pbs.BO.TechDoc.Commands.WriteHelpMD?SecurityId=documentid

Với: documentid là mã tài liệu do người viết đặt.

Kết quả tài liệu sau khi viết sẽ được lưu trên kho tài liệu trên mây của SPC.

https://phoebusfiles.blob.core.windows.net/help/funtions/subform.html
Hay

https://phoebusfiles.blob.core.windows.net/help/documentid.html

Quy định về trình bày tài liệu Phoebus

---

Để tài liệu Phoebus được hệ thống hóa, đơn giản, đọc nhanh, hiểu sâu, khi trình bày tài liệu ta có các quy định sau:

• Tiêu đề bài viết: #tiêu đề
• Tiêu đề hạng mục lớn nhất: ###tiêu đề
  Các hạng mục lớn bắt buộc thường có bao gồm: Introduction, Usage, Module, Data structure, User table Report Tags. (tham khảo tài liệu đã viết)
• Nút lệnh: <kbd>nút lệnh</kbd>
• HyberLink: **[FuntionName](funtion.html)** (sử dụng nút lệnh Insert Link)
• Cụm từ nhấn mạnh: **nội dung**
• Syntax Phoebus: ```C# câu lệnh```

---

_{Updated on : 2020-07-06 10:16:44}. _{by : . at 118.69.187.103}.

_{Topic : Markdown Help Writer. pbs.BO.TechDoc.Commands.WriteHelpMD}