Mô đun:Cite/config

Tài liệu mô đun[xem] [sửa] [lịch sử] [làm mới]

Tổng quan

Mô đun này chứa bảng dữ liệu cấu hình (configuration data) được sử dụng bởi Mô đun:Cite. Nó không chứa logic xử lý chương trình mà chỉ lưu trữ các danh sách và thiết lập.

Mục đích chính của mô đun này tại Wikipedia tiếng Việt là xác định những từ khóa (tên bản mẫu tiếng Anh) nào được phép sử dụng qua lệnh #invoke:cite. Điều này giúp các bài viết được dịch hoặc sao chép từ Wikipedia tiếng Anh giữ nguyên được mã nguồn chú thích mà không gây lỗi.

Cấu trúc dữ liệu

Mô đun trả về một bảng (table) chứa 3 thành phần chính:

1. settings_t (Cài đặt chung)

Chứa các thông báo lỗi và liên kết trợ giúp.

• err_category: Tên thể loại theo dõi khi có lỗi xảy ra (Ví dụ: Lỗi CS1: module cite).
• unknown_name: Thông báo hiển thị khi người dùng gọi một loại chú thích không có trong danh sách hỗ trợ.

2. known_templates_t (Danh sách bản mẫu hợp lệ)

Đây là "Danh sách trắng" (Whitelist). Chỉ những tên nằm trong danh sách này mới được Mô đun:Cite chấp nhận xử lý.

• Khóa (Key): Tên bản mẫu gốc tiếng Anh (viết thường). Ví dụ: 'web', 'news', 'book'.
• Giá trị (Value): Luôn là true.

Nếu bạn muốn hỗ trợ thêm một loại chú thích mới (ví dụ cite map), bạn cần thêm dòng ['map'] = true, vào bảng này.

3. citation_classes_t (Ánh xạ lớp chú thích)

Bảng này dùng để "phiên dịch" tên gọi thông thường sang tên lớp (Class) mà Mô đun:Citation/CS1 của Wikipedia tiếng Việt có thể hiểu được.

• Cơ chế: Nếu tên bản mẫu (ví dụ: audio-visual) khác với tên gọi tắt (ví dụ: av media), bảng này sẽ thực hiện việc chuyển đổi.
• Ví dụ:
  • Người dùng nhập: {{Chú thích video}}: Chú thích trống (trợ giúp)
  • Mô đun tìm trong bảng này: ['av media'] = 'audio-visual'
  • Mô đun gọi CS1 với tham số: CitationClass = 'audio-visual'

Lưu ý cho Bảo quản viên/Người sửa đổi

1. Đồng bộ hóa: Các từ khóa trong bảng known_templates_t nên được giữ nguyên tiếng Anh (ví dụ: web, news) thay vì Việt hóa, vì mục tiêu của Mô đun này là hỗ trợ mã nguồn nhập khẩu từ tiếng Anh.
2. Thêm mới: Khi thêm một loại chú thích mới, hãy đảm bảo rằng Mô đun:Citation/CS1 thực tế đã hỗ trợ loại chú thích đó.
3. Lỗi thường gặp: Nếu bạn thấy lỗi "Tên bản mẫu không được hỗ trợ", hãy kiểm tra xem tên đó (ví dụ: tweet) đã được khai báo trong known_templates_t hay chưa.

Tài liệu bên trên được truyền tải từ Mô đun:Cite/config/tài liệu. (sửa | lịch sử)
Biên tập viên sửa đổi có thể thử nghiệm trong các trang chỗ thử (tạo | sao) và trường hợp kiểm thử (tạo) của mô đun này.
Các trang con của mô đun này.

local settings_t = {
	err_category = 'Lỗi CS1: module cite',
	help = 'trợ giúp',
	help_text_link = 'Trợ giúp:Lỗi CS1#module_cite',
	unknown_name = 'tên bản mẫu không rõ: $1',
}

-- Danh sách các tên bản mẫu (viết thường) mà module này hỗ trợ
local known_templates_t = {
	['arxiv'] = true,
	['av media'] = true,
	['av media notes'] = true,
	['biorxiv'] = true,
	['book'] = true,
	['citation'] = true,
	['citeseerx'] = true,
	['conference'] = true,
	['document'] = true,
	['encyclopedia'] = true,
	['episode'] = true,
	['interview'] = true,
	['journal'] = true,
	['magazine'] = true,
	['mailing list'] = true,
	['map'] = true,
	['medrxiv'] = true,
	['news'] = true,
	['newsgroup'] = true,
	['podcast'] = true,
	['press release'] = true,
	['report'] = true,
	['serial'] = true,
	['sign'] = true,
	['speech'] = true,
	['ssrn'] = true,
	['tech report'] = true,
	['thesis'] = true,
	['web'] = true,
}

-- Ánh xạ tên bản mẫu sang tên class của CS1
local citation_classes_t = {
	['av media'] = 'audio-visual',
	['av media notes'] = 'AV-media-notes',
	['encyclopedia'] = 'encyclopaedia',
	['mailing list'] = 'mailinglist',
	['press release'] = 'pressrelease',
	['tech report'] = 'techreport',
}

return {
	citation_classes_t = citation_classes_t,
	known_templates_t = known_templates_t,
	settings_t = settings_t,
}