search

lelinhtinh / mudim

Automatically exported from code.google.com/p/mudim
https://code.google.com/archive/p/mudim/
0 stars 0 forks source link

[Request] Thêm tài liệu hướng dẫn về API #17

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
1.
Tài liệu này có hướng dẫn sơ qua về cách hiệu chỉnh, nhưng 
còn sơ sài, còn
ở mức giao diện:
http://code.google.com/p/mudim/wiki/HuongDanCaiDat

2.
Nên có tài liệu hướng dẫn sâu hơn về (1) tên các hàm API (2) 
tham số (3)
tác dụng. Ví dụ muốn chuyển kiểu gõ thành VNI thì gọi hàm 
gì, muốn hiện
bảng điều khiển thì gọi hàm gì v.v.

Ví dụ 1:
Trang web http://cntt.tv dùng drop downlist để hiện kiểu gõ chứ 
không dùng
bảng điều khiển => ở onchange event của drop down list, sẽ gọi 
hàm API để
chuyển kiểu gõ.

Ví dụ 2:
Chúng tôi muốn hiện bảng điều khiển để quảng cáo giúp Mudim 
(vì trên bảng
điều khiển có link đến Mudim), muốn thay drop down list đó bằng 
nút cho
phép hiện/ẩn bẳng điều khiển => cần biết hàm API để 
hiện/ẩn bảng điều khiển.

Tất nhiên chúng tôi có thể tự đọc source code để mò ra API 
cần thiết, nhưng
như vậy có thể có sai sót. Có official API do mudzot viết thì Mudim 
trông
"ngon lành" hơn.

Hint:
Có thể dùng http://jsdoctoolkit.org để tự động chuyển comment 
trong source
code thành tài liệu. Dùng xong nếu thấy hay xin mudzot viết bài 
giới thiệu
lên cntt.tv ;)

Original issue reported on code.google.com by ngocdaot...@gmail.com on 15 May 2008 at 6:01

GoogleCodeExporter commented 9 years ago 
Ghi chú thêm về việc dùng phím tắt để hiện/ẩn bảng điều 
khiển:
Một số chương trình hệ thống chặn các phím chức năng (ví 
dụ trên Mac OS X). Ngoài ra,
không phải người dùng bình thường nào cũng nhớ phím tắt => 
trang web luôn cần có nút
để hiện/ẩn bảng điều khiển => cần API.

Original comment by ngocdaot...@gmail.com on 15 May 2008 at 6:07

GoogleCodeExporter commented 9 years ago 
Trong tổng số trên dưới 50 hàm và thuộc tính em nghĩ không cần 
thiết viết API docs
cho những hàm đi sâu vào implementation của engine, chỉ cần các 
hàm tương tác với
engine là đủ. Những hàm này chiếm khoảng 1/3 số đó. Em sẽ 
viết dần lên Wiki, mô tả
ngắn gọn chức năng và tham số.

Original comment by mud...@gmail.com on 15 May 2008 at 7:19

GoogleCodeExporter commented 9 years ago 
API nào quan trọng cho càng nhiều người càng nên mô tả nhiều. 
Ví dụ chỉ dùng cho
mudzot thì chỉ cần ghi chú vài chữ để về sau (ví dụ cách vài 
tháng) lục lại khỏi quên.

Original comment by ngocdaot...@gmail.com on 16 May 2008 at 3:13

GoogleCodeExporter commented 9 years ago

Original comment by mud...@gmail.com on 17 May 2008 at 10:11