Thành viên:Plantaest/Zinnia/Tài liệu

Trang này là tài liệu hướng dẫn dành cho người sử dụng và nhà phát triển.

Người sử dụng

Start Screen

Sau khi cài đặt Zinnia ở trang global.js của bạn tại Meta, người dùng cần truy cập trang Special:BlankPage/Zinnia ở bất kỳ wiki nào để bắt đầu sử dụng Zinnia, thường sẽ là wiki nhà của bạn.

Khi truy cập lần đầu, Zinnia sẽ hiển thị Start Screen như sau:

Bạn nhấn nút Start [Bắt đầu] để tạo cấu hình và khởi động phiên làm việc.

Ngoài ra, còn có 3 nút ở góc phải trên cùng, để truy cập trang chủ, trang thảo luận, và trang ủng hộ của dự án.

Main Screen

Giao diện chính khi sử dụng của Zinnia được gọi là Main Screen, với 2 cột chính, cột trái gọi là Feed Panel, và cột phải gọi là Tab Panel.

Tab Panel chứa nhiều loại tab, ví dụ như Welcome Tab, Diff Tab, và Read Tab.

Welcome Tab

Welcome Tab là tab xuất hiện khi bắt đầu sử dụng. Tab này chỉ mang tính giới thiệu dự án.

Diff Tab và Main Diff Tab

Khi bạn nhấn vào một thay đổi ở Feed Panel, thì ứng dụng sẽ mở một Diff Tab; nhưng đúng hơn, nó là Main Diff Tab, vì tab loại này sẽ liên kết với Feed Panel. Cứ mỗi khi bạn chọn một thay đổi khác trên Feed Panel, thì Main Diff Tab sẽ điều chỉnh theo yêu cầu chọn của bạn.

Để mở một Diff Tab thật sự từ Feed Panel, bạn cần nhấn chuột vào thay đổi khi đang giữ phím Ctrl (Windows/Linux) hoặc Command (MacOS). Lúc này, một Diff Tab được tạo ra, và không dính líu gì đến Feed Panel như Main Diff Tab.

Read Tab và Main Read Tab

Khi bạn nhấn vào một thay đổi tạo trang mới, thì ứng dụng sẽ mở một Main Read Tab, hiển thị nội dung của trang đó với phiên bản mới nhất, tức là không phụ thuộc vào phiên bản của thay đổi. Main Read Tab có tính chất tương tự Main Diff Tab về mặt liên kết với Feed Panel.

Để mở một Read Tab thật sự, bạn cũng cần nhấn chuột vào thay đổi tạo trang mới khi đang giữ phím Ctrl (Windows/Linux) hoặc Command (MacOS).

Feed Panel

Feed Panel gồm có 2 phần chính:

Feed Control Panel: Một hộp nằm ở đầu Feed Panel, chứa một số thành phần sau:
- Trạng thái kết nối mạng
- Nút Reload [Tải lại]
- Nút Focus [Tập trung]
Danh sách những thay đổi (Changes)
- Mỗi thay đổi là một hộp, thường gồm các thông tin:
  - Thứ tự
  - Thời gian
    - Mặc định có màu xanh dương; còn nếu có màu đỏ thì cho biết thay đổi chưa được tuần tra, có màu xanh lá là thay đổi đã được tuần tra/tự đánh dấu tuần tra.
  - Sửa đổi nhỏ (biểu tượng chiếc lá)
  - Wiki ID
  - Tiêu đề
  - Số byte chênh lệch
  - Tên người dùng hoặc IP
  - Điểm số ORES của mô hình damaging hoặc reverted (nếu có)
- Những thay đổi được nhóm theo giờ và theo ngày.

Tab Panel

Tab Panel gồm có 3 phần chính:

Tab Header Panel: Phần đầu của Tab Panel, chứa danh sách tab, và một số nút chức năng liên quan đến tab (chưa triển khai).
Tab Main Panel: Phần nội dung chính của Tab Panel, chứa nội dung tab, tùy theo loại tab mà nội dung tab sẽ khác nhau.
Tab Footer Panel: Phần cuối của Tab Panel, chứa một số nút quan trọng như:
- Đầu:
  - Nút Filters [Bộ lọc]: Mở ra Filter Panel, giúp thêm, sửa, xóa, chọn các bộ lọc của không gian làm việc hiện tại.
  - Nút Workspaces [Không gian làm việc]: Mở ra Workspace Panel, giúp thêm, sửa, xóa, chọn các không gian làm việc.
- Giữa:
  - Nút Tools (chưa triển khai)
  - Nút Asterisk (chưa triển khai)
- Cuối:
  - Nút Bookmarks (chưa triển khai)
  - Nút Settings [Thiết đặt]: Mở ra Setting Panel, giúp cấu hình một số thứ của ứng dụng.
- Các nút khác nếu có thì là của những công cụ (tool), xuất hiện tùy thuộc loại tab đang mở.

Workspace Panel

Mỗi người dùng chỉ được có tối đa 5 không gian làm việc.

Mỗi không gian làm việc chỉ được có tối đa 5 bộ lọc.

Mỗi bộ lọc chỉ được có tối đa 5 wiki.

Setting Panel

Setting Panel dùng để cấu hình ứng dụng.

Những cấu hình cơ bản bao gồm:

Theme (Chủ đề)
Language (Ngôn ngữ)
Locale (Vùng)
Right-to-left (Phải-sang-trái)

Nhà phát triển

Mã nguồn của dự án Zinnia được lưu trữ trên GitHub: https://github.com/plantaest/zinnia.

Các hoạt động xử lý issue, tạo pull request, thông báo release được diễn ra trên repository zinnia nói trên.

Nếu các bạn có tài khoản GitHub thì có thể cho một sao cho repository trên để bày tỏ sự ủng hộ đối với dự án nguồn mở này.