Tài liệu của Obsidian tuân theo các hướng dẫn kiểu dáng được liệt kê trên trang này. Các hướng dẫn này dựa trên các phương pháp tốt nhất trong ngành, đặc biệt là [Hướng dẫn kiểu tài liệu phát triển của Google](https://developers.google.com/style) và [Hướng dẫn kiểu của Microsoft](https://learn.microsoft.com/en-us/style-guide/). Đối với các trường hợp không được đề cập bên dưới, hãy tham khảo các hướng dẫn bên ngoài đó như tài liệu tham khảo phụ. > [!tip]- Đóng góp > Phần lớn tài liệu đã tồn tại trước khi hướng dẫn kiểu dáng này ra đời. > > Nếu bạn phát hiện bất kỳ vi phạm nào đối với hướng dẫn kiểu dáng này, vui lòng [tạo một issue](https://github.com/obsidianmd/obsidian-docs/issues/new) và gửi pull request tới [obsidianmd/obsidian-docs](https://github.com/obsidianmd/obsidian-docs). ## Thuật ngữ và ngữ pháp ### Phong cách ngôn ngữ Đối với tài liệu tiếng Anh của chúng tôi, khuyến nghị sử dụng [Tiếng Anh toàn cầu](https://docs.openedx.org/en/latest/documentors/references/doc_english_writing.html) để phục vụ tốt hơn cho độc giả trên toàn thế giới và hỗ trợ cho việc [[#Bản dịch]]. Điều này có nghĩa là: - Tránh thành ngữ và các biểu đạt mang tính văn hóa cụ thể - Sử dụng thể chủ động và cấu trúc câu trực tiếp - Ưu tiên các từ đơn giản, phổ biến hơn thuật ngữ phức tạp - Diễn đạt rõ ràng thay vì ngụ ý - Đối với quy ước chính tả, sử dụng tiếng Anh Mỹ (ví dụ: 'organize' thay vì 'organise'). ### Thuật ngữ - Ưu tiên "keyboard shortcut" hơn "hotkey". Sử dụng Hotkey khi đề cập đến tính năng cụ thể. - Ưu tiên "ứng dụng Obsidian" trên di động, và "ứng dụng Obsidian" trên máy tính. - Ưu tiên "sync" hoặc "syncing" hơn "synchronise" hoặc "synchronising". - Ưu tiên "search term" hơn "search query". - Ưu tiên "heading" hơn "header" khi đề cập đến văn bản giới thiệu một phần. - Ưu tiên "maximum" hơn "max" và "minimum" hơn "min". ### Tên sản phẩm Tên sản phẩm của Obsidian bắt đầu bằng "Obsidian", ví dụ "Obsidian Publish" và "Obsidian Sync". Nếu một đoạn văn trở nên quá lặp lại, bạn có thể sử dụng dạng ngắn trong các lần đề cập tiếp theo. Ví dụ: _Để cho phép cấu hình theo thiết bị, Obsidian Sync không đồng bộ hóa cài đặt của chính nó. Bạn cần cấu hình Sync cho mỗi thiết bị của mình._ ### Giao diện người dùng và tương tác - Sử dụng **in đậm** để chỉ văn bản trên nút - Ưu tiên "chọn" hơn "nhấn" hoặc "bấm". - Đối với hướng dẫn dành riêng cho di động, "nhấn" có thể chấp nhận được khi mô tả tương tác chạm vì "bấm" không khả dụng. - Ưu tiên "thanh bên" hơn "thanh bên". - Ưu tiên "thực hiện" hơn "gọi" và "chạy" khi đề cập đến lệnh hoặc hành động. Khi đề cập đến nhiều tương tác giao diện liên tiếp, sử dụng ký hiệu → (U+2192). Ví dụ, "**[[Cài đặt]] → Phần mở rộng từ cộng đồng**". ### Ghi chú, tệp và thư mục - Sử dụng "ghi chú" khi đề cập đến tệp Markdown trong kho. - Sử dụng "tệp" khi đề cập đến các phần mở rộng tệp khác ngoài Markdown. - Ưu tiên "tên ghi chú" hơn "tiêu đề ghi chú". - Ưu tiên "ghi chú đang hoạt động" hơn "ghi chú hiện tại". - Ưu tiên "thư mục" hơn "thư mục". - Ưu tiên "loại tệp" hơn "định dạng tệp", trừ khi đang đề cập cụ thể đến định dạng dữ liệu của nội dung tệp. Khi di chuyển giữa các ghi chú, sử dụng "mở" nếu đích đến bị ẩn, và "chuyển đổi" nếu cả ghi chú nguồn và đích đều đang mở trong các phần tách riêng. ### Tài liệu tham khảo cho cài đặt Khi có thể, bất kỳ cài đặt nào cũng nên được ghi chú trong Obsidian bằng văn bản mô tả. Tránh ghi chú một cài đặt cụ thể trong Trợ giúp Obsidian trừ khi: - Nó đòi hỏi kiến thức chuyên sâu hơn về cách và thời điểm sử dụng. - Nó thường bị sử dụng sai hoặc được hỏi thường xuyên. - Nó _thay đổi đáng kể_ trải nghiệm người dùng. Hãy cân nhắc sử dụng khung ghi chú mẹo nếu bạn muốn thu hút sự chú ý đến một cài đặt cụ thể. ### Thuật ngữ chỉ hướng Nối gạch ngang các thuật ngữ chỉ hướng khi sử dụng chúng như tính từ. Tránh nối gạch ngang khi hướng được sử dụng như danh từ. **Khuyến nghị:** - Chọn **[[Cài đặt]]** ở góc dưới-trái. - Chọn **[[Cài đặt]]** ở phía dưới trái. **Không khuyến nghị:** - Chọn **[[Cài đặt]]** ở góc dưới trái. - Chọn **[[Cài đặt]]** ở phía dưới-trái. Ưu tiên "phía trên-trái" và "phía trên-phải" hơn "trên-trái" và "trên-phải". Không chỉ hướng khi đề cập đến cài đặt. Vị trí của điều khiển cài đặt phụ thuộc vào thiết bị. **Khuyến nghị:** - Bên cạnh **Pick remote vault**, chọn **Chọn**. **Không khuyến nghị:** - Ở bên phải của **Pick remote vault**, chọn **Chọn**. Khi mô tả hướng dọc trong các phần tử giao diện, sử dụng "ở trên" và "ở dưới" cho các mối quan hệ không gian. Tránh "lên" và "xuống" vì chúng có thể gây nhầm lẫn trong các ngữ cảnh khác nhau. **Khuyến nghị:** - Hộp tìm kiếm xuất hiện ở trên danh sách tệp. - Các tùy chọn bổ sung có sẵn ở bên dưới. **Không khuyến nghị:** - Hộp tìm kiếm ở phía trên danh sách tệp. - Thêm tùy chọn ở phía dưới. ### Hướng dẫn Sử dụng thể mệnh lệnh cho tên các hướng dẫn, tiêu đề phần và hướng dẫn từng bước. Thể mệnh lệnh ngắn gọn và hướng tới hành động, giúp người dùng dễ dàng hơn khi theo dõi hướng dẫn. - Ưu tiên "Thiết lập" hơn "Đang thiết lập" - Ưu tiên "Di chuyển tệp" hơn "Đang di chuyển tệp" - Ưu tiên "Nhập ghi chú của bạn" hơn "Đang nhập ghi chú của bạn" ### Viết hoa kiểu câu Ưu tiên *viết hoa kiểu câu* hơn *viết hoa kiểu tiêu đề* cho các tiêu đề, nút và tên. Khi tham chiếu đến các phần tử giao diện, luôn khớp với kiểu viết hoa của văn bản trong giao diện. **Khuyến nghị:** - Cách Obsidian lưu trữ dữ liệu **Không khuyến nghị:** - Cách Obsidian Lưu Trữ Dữ Liệu ### Ví dụ Ưu tiên các ví dụ thực tế hơn các thuật ngữ vô nghĩa. **Khuyến nghị:** - `task:(call OR schedule)` **Không khuyến nghị:** - `task:(foo OR bar)` ### Tên phím và phím tắt Khi đề cập đến các phím trên bàn phím và phím tắt, sử dụng ký hiệu nhất quán. **Tên phím riêng lẻ:** Khi đề cập đến một ký tự trên bàn phím theo tên, thêm ký tự đó trong dấu ngoặc đơn ngay sau tên. **Khuyến nghị:** - Nhấn phím gạch ngang (-) để thêm dấu gạch ngang. - Sử dụng dấu chấm hỏi (?) để tìm kiếm. **Không khuyến nghị:** - Nhấn phím gạch ngang để thêm dấu gạch ngang. - Sử dụng ? để tìm kiếm. - Thêm `-` phía trước từ. **Phím tắt:** Định dạng phím tắt không có khoảng trắng xung quanh dấu cộng. Khi một phím tắt khác nhau giữa các hệ điều hành, hãy chỉ định cả hai. **Khuyến nghị:** - Nhấn `Ctrl+Z` (Windows) hoặc `Command+Z` (macOS) để hoàn tác. - Nhấn `Escape` để đóng cửa sổ này. - Sử dụng `Tab` để di chuyển giữa các trường. **Không khuyến nghị:** - Nhấn `Cmd+Z` để hoàn tác. - Nhấn `Ctrl + Z` (có khoảng trắng) để hoàn tác. - Nhấn `Ctrl/Cmd+Z` để hoàn tác. Đối với các phím tắt giống nhau trên tất cả các nền tảng, bạn không cần chỉ định hệ điều hành. Nếu bạn không chắc liệu một phím tắt có khác nhau theo nền tảng hay không, hãy chỉ định hệ điều hành để an toàn. Windows và Linux thường sử dụng cùng phím tắt. ### Markdown Sử dụng dòng trống giữa các khối Markdown: **Khuyến nghị:** ```md # Tiêu đề 1 Đây là một phần. 1. Mục đầu tiên 2. Mục thứ hai 3. Mục thứ ba ``` **Không khuyến nghị:** ```md # Tiêu đề 1 Đây là một phần. 1. Mục đầu tiên 2. Mục thứ hai 3. Mục thứ ba ``` **Gạch ngang dài trong danh sách:** Sử dụng gạch ngang dài (—) để phân tách các thuật ngữ in đậm khỏi mô tả của chúng trong danh sách dấu đầu dòng. Không sử dụng gạch ngang dài trong danh sách lồng nhau đơn giản có liên kết. **Khuyến nghị:** - **Menu xem** — tạo, chỉnh sửa và chuyển đổi các chế độ xem. - **Tính toán giá trị** — thêm giá, tính tổng hoặc thực hiện các phép tính toán học. **Không khuyến nghị:** - [[Tạo một cơ sở]] — Tìm hiểu cách tạo và nhúng một cơ sở. ### Hình ảnh Sử dụng "**chiều rộng** x **chiều cao** pixel" để mô tả kích thước hình ảnh hoặc màn hình. **Ví dụ:** Kích thước hình ảnh khuyến nghị: 1920 x 1080 pixel. ## Cấu trúc thông tin ### Các loại khung ghi chú Sử dụng khung ghi chú một cách chiến lược để nổi bật các loại thông tin cụ thể: **Mẹo** (`[!tip]-`) - Lời khuyên thực tế hoặc phương pháp tốt nhất giúp cải thiện quy trình làm việc của người dùng. Sử dụng cho phím tắt, cách giải quyết, hoặc thông tin không thiết yếu nhưng hữu ích. Các khung ghi chú này bắt đầu ở trạng thái thu gọn. **Thông tin** (`[!info]+`) - Ngữ cảnh bổ sung, thông tin nền hoặc làm rõ. Sử dụng khi thông tin bổ sung hiểu biết nhưng không bắt buộc để hoàn thành một nhiệm vụ. Các khung ghi chú này bắt đầu ở trạng thái mở rộng. **Cảnh báo** (`[!warning]+`) - Lưu ý quan trọng ngăn ngừa mất dữ liệu, lỗi hoặc hậu quả không mong muốn. Sử dụng hạn chế cho các tình huống thực sự nguy hiểm. Các khung ghi chú này không bao giờ được thu gọn. **Ví dụ** (`[!example]-`) - Các nội dung phụ hoặc chi tiết bổ sung chung. Sử dụng cho thông tin liên quan gián tiếp mà một số người dùng có thể thấy hữu ích. Các khung ghi chú này bắt đầu ở trạng thái thu gọn. **Ví dụ:** ```md > [!tip]- Sử dụng phím tắt > Bạn có thể tăng tốc quy trình làm việc bằng cách ghi nhớ các phím tắt được sử dụng nhiều nhất. > [!info]+ Đây là tiện ích bổ sung trả phí > Tính năng này yêu cầu đăng ký trả phí để sử dụng. > [!warning]+ Hành động này không thể hoàn tác > Xóa kho là vĩnh viễn. Hãy cân nhắc xuất ghi chú của bạn trước. > [!example]- Cách sử dụng nâng cao > Bạn cũng có thể cấu hình cài đặt này thông qua menu Đồ thị. ``` ### Danh sách so với văn xuôi Sử dụng danh sách khi trình bày các mục riêng biệt không có mối quan hệ tuần tự hoặc nhân quả mạnh. Sử dụng văn xuôi và đoạn văn khi các mục xây dựng lẫn nhau, cần giải thích hoặc hưởng lợi từ dòng chảy tường thuật. **Sử dụng danh sách cho:** - Một tập hợp các tính năng không liên quan - Yêu cầu cài đặt - Tùy chọn cấu hình - Các bước khắc phục sự cố **Sử dụng văn xuôi cho:** - Giải thích cách một thứ hoạt động - Quy trình làm việc có phụ thuộc - Tổng quan khái niệm - Hướng dẫn cần ngữ cảnh ### Bảng Sử dụng bảng để so sánh các tính năng, phiên bản hoặc các điểm dữ liệu liên quan khi việc căn chỉnh giúp dễ hiểu hơn. Tránh sử dụng bảng cho danh sách đơn giản hoặc dữ liệu một cột. **Trường hợp sử dụng tốt:** | Tính năng | Di động | Máy tính | |---------|--------|---------| | Sync | Có | Có | | Plugin | Không | Có | | Chủ đề | Hạn chế | Đầy đủ | ### Tham chiếu chéo Sử dụng liên kết wiki nội bộ (`[[Tên ghi chú]]`) một cách tự do để giúp người dùng điều hướng đến các chủ đề liên quan. Tuy nhiên, tránh liên kết quá nhiều: - Không liên kết cùng một thuật ngữ nhiều lần trong cùng một trang - Chỉ liên kết khi trang được tham chiếu cung cấp ngữ cảnh bổ sung đáng kể - Sử dụng văn bản liên kết mô tả khi hữu ích: `[[Tên ghi chú#Phần|văn bản mô tả]]` **Ví dụ:** Lần đề cập đầu tiên: "Tìm hiểu về [[Giới thiệu về Obsidian Sync|Obsidian Sync]] để giữ kho của bạn được cập nhật trên các thiết bị." Lần đề cập sau: "Bạn có thể cấu hình Sync cho từng thiết bị riêng biệt." ### Nội dung dành riêng cho nền tảng Khi ghi chú các tính năng khác nhau giữa các nền tảng, sử dụng tiêu đề phần để tổ chức nội dung. Sử dụng `Máy tính` và `Di động` làm tiêu đề phụ để phân tách hướng dẫn hoặc tính năng dành riêng cho nền tảng. **Khuyến nghị:** ```md ## Tùy chỉnh thanh công cụ ### Máy tính Trên phiên bản máy tính, bạn có thể tùy chỉnh thanh công cụ như sau: - Sắp xếp lại thứ tự các hành động trên thanh công cụ bằng cách kéo và thả các biểu tượng. - Để ẩn các hành động cụ thể, nhấp chuột phải vào khoảng trống và bỏ chọn các hành động bạn muốn ẩn. ### Di động Trên phiên bản di động, bạn có thể tùy chỉnh thanh công cụ thông qua cài đặt: 1. Mở **[[Cài đặt]]**. 2. Điều hướng đến **Giao diện**. 3. Nhấp **Quản lý** dưới **Cấu hình Ribbon**. ``` > [!info]+ Khi nào nên tạo các phần riêng? > Chỉ tạo các phần riêng nếu nội dung khác biệt đáng kể. Nếu hướng dẫn phần lớn giống nhau với các biến thể nhỏ, hãy sử dụng ghi chú nội dòng thay thế. ## Biểu tượng và hình ảnh Bao gồm biểu tượng và hình ảnh khi chúng giúp giải thích những điều khó mô tả bằng lời dễ dàng hơn, hoặc khi bạn cần hiển thị các phần quan trọng của ứng dụng Obsidian. Bạn có thể lưu hình ảnh trong thư mục `Attachments`. - Hình ảnh nên giúp văn bản đi kèm dễ hiểu hơn. **Ví dụ**: Sau khi bật, plugin [[Số từ]] sẽ tạo một mục mới trên thanh trạng thái phía dưới của bạn. ![[Style-guide-zoomed-example.png#interface|300]] - Hình ảnh nên ở định dạng `.png` hoặc `.svg`. - Nếu một hình ảnh trông quá lớn trong ghi chú, hãy làm nhỏ nó bên ngoài Obsidian, hoặc điều chỉnh kích thước của nó như được giải thích trong [[Nhúng tệp#Nhúng hình ảnh vào ghi chú|nhúng hình ảnh vào ghi chú]]. - Trong các trường hợp hiếm, bạn có thể muốn đặt các hình ảnh đặc biệt lớn hoặc phức tạp trong một [[Khung ghi chú#Khung ghi chú có thể thu gọn|khung ghi chú có thể thu gọn]]. - Đối với cửa sổ bật lên hoặc modal, hình ảnh nên hiển thị toàn bộ cửa sổ ứng dụng Obsidian. ![[Style-guide-modal-example.png#interface]] ### Biểu tượng Biểu tượng [Lucide](https://lucide.dev/icons/) và biểu tượng tùy chỉnh của Obsidian có thể được sử dụng cùng với các phần tử chi tiết để cung cấp biểu diễn trực quan của một tính năng. **Ví dụ:** Trong thanh công cụ bên trái, chọn **Tạo bảng mới** ![[lucide-layout-dashboard.svg#icon]] để tạo một canvas trong cùng thư mục với tệp đang hoạt động. **Hướng dẫn cho biểu tượng** - Lưu biểu tượng trong thư mục `Attachments/icons`. - Thêm tiền tố `lucide-` trước tên biểu tượng Lucide. - Thêm tiền tố `obsidian-icon-` trước tên biểu tượng Obsidian. **Ví dụ:** Biểu tượng để tạo canvas mới nên được đặt tên là `lucide-layout-dashboard`. - Sử dụng phiên bản SVG của các biểu tượng có sẵn. - Biểu tượng nên có chiều rộng `18` pixel, chiều cao `18` pixel và độ rộng nét `1.5`. Bạn có thể điều chỉnh các cài đặt này trong dữ liệu SVG. > [!info]- Điều chỉnh kích thước và nét trong SVG > ```html > <svg xmlns="http://www.w3.org/2000/svg" width="WIDTH" height="HEIGHT" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="STROKE-WIDTH" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-layout-dashboard"><rect width="7" height="9" x="3" y="3" rx="1"/><rect width="7" height="5" x="14" y="3" rx="1"/><rect width="7" height="9" x="14" y="12" rx="1"/><rect width="7" height="5" x="3" y="16" rx="1"/></svg> >``` - Sử dụng anchor `icon` trong hình ảnh nhúng để điều chỉnh khoảng cách xung quanh biểu tượng sao cho nó căn chỉnh gọn gàng với văn bản xung quanh. - Biểu tượng nên được bao quanh bởi dấu ngoặc đơn. ![[lucide-cog.svg#icon]] **Ví dụ**: `![[lucide-cog.svg#icon]]` ### Thẻ anchor cho hình ảnh Các thẻ anchor cho hình ảnh có sẵn để thêm các thay đổi trang trí cho hình ảnh nhúng. > [!warning] Cảnh báo xem trước trực tiếp > Các thẻ anchor biểu tượng sẽ không hiển thị đúng trong **Xem trước trực tiếp.** Sử dụng **Chế độ đọc** để xác nhận thẻ anchor đã được áp dụng. **Icon** `![[lucide-menu.svg#icon]]` Thẻ anchor icon đảm bảo căn chỉnh dọc chính xác cho các biểu tượng được sử dụng để chỉ các phần tử giao diện. Biểu tượng menu đầu tiên sử dụng thẻ anchor ![[lucide-menu.svg#icon]], trong khi biểu tượng menu thứ hai ( ![[lucide-menu.svg]] ) không sử dụng. **Interface** `![[Vault picker.png#interface]]` Thẻ anchor interface thêm bóng hộp trang trí xung quanh hình ảnh. Trong hình ảnh đầu tiên, thẻ anchor interface được áp dụng. ![[Vault picker.png#interface]] Ngược lại, hình ảnh thứ hai không có thẻ anchor interface được áp dụng. ![[Vault picker.png]] **Outline** `![[Backlinks.png#outline]]` Thẻ anchor outline thêm một đường viền tinh tế xung quanh hình ảnh. Trong hình ảnh đầu tiên, thẻ anchor outline được áp dụng. > [!tip] Quan sát góc dưới bên trái của hình ảnh để thấy sự khác biệt. ![[Backlinks.png#outline]] Hình ảnh thứ hai thiếu thẻ anchor outline. ![[Backlinks.png]] ### Tối ưu hóa Hình ảnh làm chậm thời gian tải trang và chiếm không gian lưu trữ [[Giới thiệu về Obsidian Publish|Publish]] quý giá. Tối ưu hóa hình ảnh cho phép giảm kích thước tệp nhưng vẫn duy trì tính toàn vẹn trực quan của hình ảnh. Cả hình ảnh và biểu tượng đều nên được tối ưu hóa. > [!info] Công cụ tối ưu hóa hình ảnh > Dưới đây là một số chương trình được khuyến nghị để giảm kích thước hình ảnh của bạn. > - **Windows:** [FileOptimizer](https://sourceforge.net/projects/nikkhokkho/) > - **macOS:** [ImageOptim](https://imageoptim.com/) > - **Linux/Unix** [Trimage](https://trimage.org) > > Chúng tôi khuyến nghị tỷ lệ tối ưu hóa 65-75%. ## Bố cục ### Liên kết bị hỏng Trước khi gửi Pull Request của bạn, vui lòng kiểm tra mọi liên kết bị hỏng trong tài liệu của bản dịch bạn đang thực hiện và sửa chúng. Liên kết bị hỏng có thể xảy ra tự nhiên theo thời gian, vì vậy việc xác minh độ chính xác giúp duy trì chất lượng tài liệu. Bạn có thể kiểm tra liên kết bị hỏng bằng [[Phần mở rộng từ cộng đồng]] hoặc các công cụ có sẵn trong IDE của bạn. ### Mô tả Tài liệu này được chỉnh sửa trên GitHub và được lưu trữ trực tuyến thông qua [[Giới thiệu về Obsidian Publish|Obsidian Publish]], bao gồm [[Xem trước liên kết mạng xã hội#Mô tả|mô tả]] cho thẻ mạng xã hội và các phần tử [[SEO]] khác. Nếu trang bạn đang làm việc không có [[Thuộc tính|thuộc tính]] `description`, vui lòng thêm một mô tả. Mô tả nên có 150 ký tự hoặc ít hơn và cung cấp tóm tắt khách quan về nội dung của trang. **Tốt**: Tìm hiểu cách tạo mẫu để thu thập và sắp xếp siêu dữ liệu trang web tự động với Web Clipper. **Có thể cải thiện**: Tìm hiểu cách tạo các mẫu tự động thu thập và sắp xếp siêu dữ liệu từ các trang web với Web Clipper. ### Hướng dẫn Khi viết hoặc viết lại [[#Hướng dẫn]] về cách thực hiện một hành động trong ứng dụng, hãy đảm bảo bao gồm các bước cho cả phiên bản di động và máy tính. Nếu bạn không có quyền truy cập vào thiết bị di động hoặc máy tính, vui lòng đề cập điều này khi gửi Pull Request của bạn. ## Bản dịch Dịch toàn bộ nội dung khi hoàn thành một bản dịch. Điều này bao gồm nhưng không giới hạn ở: - Tên ghi chú - Tên thư mục - Bí danh - Tên tệp đính kèm - Văn bản liên kết thay thế