69 lines
4.3 KiB
Markdown
69 lines
4.3 KiB
Markdown
# BMA-EHR Manual
|
|
|
|
คู่มือระบบ BMA-EHR ใช้ Markdown ในการเขียน และได้ผลลัพธ์ออกมาเป็น html, docx ได้
|
|
|
|
## การจัดการ
|
|
|
|
ในการเพิ่ม ลบ แก้ไข คู่มือ จะทำผ่านไฟล์ .md ภายใน [public/documents](public/documents)
|
|
โดยวิธีการเขียนจะอ้างอิงตามวิธีการเขียน Markdown เป็นหลัก
|
|
|
|
เมื่อต้องการ Preview สามารถใช้ Editor อย่าง VSCode หรือ โปรแกรมใดๆก็ตาม ที่สามารถอ่านและแสดงผล Markdown ให้ออกมา
|
|
ในรูปแบบที่คนทั่วไปสามารถเห็นได้อย่างเช่น Obsidian ที่สามารถเขียน Note เป็น Markdown และแสดงออกมาเหมือนหน้าเว็บ
|
|
หรือ GitHub MD File ที่สามารถ Preview ผลลัพธ์ ออกมาทางหน้าเว็บได้
|
|
|
|
การ Preview มีปัญหาเรื่อง การแสดงรูปภาพ เนื่องจากเมื่อนำไปadminใช้ในการ แสดงผลบนหน้าเว็บ จะต้องมีการระบุตำแหน่งของ รูปภาพให้เป็น absolute path
|
|
ไม่สามารถใช้ relative path ได้ทำให้ เมื่อต้องการจัด หรือโยกย้ายตำแหน่งของ ไฟล์ md สามารถทำได้ง่าย และไม่รวมอยู่ในตำแหน่งเดียวกันได้
|
|
|
|
หากมีการเพิ่ม หรือลบไฟล์ .md ให้ทำการแก้ไข [public/toc.json](public/toc.json) เพื่อให้ไฟล์นั้นสามารถถูกเรียกใช้ได้
|
|
โดยมีโครงสร้างข้อมูลตามตัวอย่างด้านล่าง
|
|
|
|
```json
|
|
[
|
|
{
|
|
"icon": "mdi-file-outline",
|
|
"activeIcon": "mdi-file",
|
|
"label": "คู่มือการใช้งาน (ผู้ดูแลระบบ)",
|
|
"children": [
|
|
{
|
|
"label": "การใช้งานผู้ดูแลระบบ",
|
|
"path": "/manual/chapter-1-superadmin-maintenance"
|
|
},
|
|
{
|
|
"label": "การใช้งานผู้ดูแลระบบระดับสูง",
|
|
"path": "/manual/chapter-2-superadmin-maintenance"
|
|
},
|
|
{
|
|
"label": "คู่มือการตรวจสอบและแก้ไข",
|
|
"path": "/manual/chapter-3-superadmin-debug"
|
|
},
|
|
{
|
|
"label": "คู่มือการจัดการระบบ",
|
|
"path": "/manual/chapter-4-superadmin-build-and-deploy"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
โดยที่ Icon ที่ใช้จะเป็น ของ mdi เท่านั้น สามารถค้นหาได้จาก [mdi-icons](https://pictogrammers.com/library/mdi/)
|
|
|
|
## การสร้างไฟล์ docx และ pdf
|
|
|
|
ในการสร้างไฟล์ docx จากไฟล์ md สามารถทำได้โดยการใช้ pandoc ภายใน [public](public/) ตามตัวอย่างคือ
|
|
|
|
```bash
|
|
pandoc \
|
|
--reference-doc ./documents/ref.docx \
|
|
--data-dir ./images \
|
|
-o ./documents/chapter-1-admin-login.docx \
|
|
./documents/chapter-1-admin-login.md
|
|
```
|
|
|
|
หรือใช้ [script](gen.sh) ในการ generate docx
|
|
|
|
ในส่วนของ PDF เนื่องจากการแปลงจาก md เป็น pdf ตรงๆ ให้ผลลัพธ์ที่ไม่เป็นไปตามที่ต้องการ จึงใช้วิธีเปิด ไฟล์ docx และแปลงเป็น pdf
|
|
|
|
## การใส่ link video youtube
|
|
|
|
สามารถใส่ลงในตัวไฟล์ md ได้ตามตัวอย่าง
|
|
@[youtube](https://www.youtube.com/)
|