Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Hướng dẫn từng bước cho các tác giả tạo ra các bài viết và tài liệu
hướng dẫn để xuất bản trên developerWorks
Editorial staff
Biên tập viên
IBM
25 04 2011
(Xuất bản lần đầu tiên vào ngày 06 11
2009)
Chào mừng, các tác giả! Bài viết này chỉ cho bạn cách chuẩn bị các bài viết và tài liệu hướng
dẫn kỹ thuật bằng tiếng Anh để xuất bản trên trang web developerWorks trên toàn thế giới. Các
bước này thật đơn giản. Bạn tải về khuôn mẫu theo XML của chúng tôi dùng cho các bài báo
hoặc cho các hướng dẫn, điền vào khuôn mẫu bằng cách sử dụng bất kỳ bộ biên tập XML xác
thực nào hoặc trình soạn thảo văn bản Microsoft® Windows® hoặc Linux® ưa thích nào của
bạn, kiểm tra nó để đảm bảo nó làm theo cấu trúc gắn thẻ như được định nghĩa trong lược đồ
developerWorks, và xem trước bài viết hoặc hướng dẫn của bạn. Các mách nước về biên soạn
nội dung của bạn và gửi đến nhân viên developerWorks cũng có ở đây.
Bạn đang tìm kiếm các khuôn mẫu Word hoặc Writer chứ
không phải các khuôn mẫu XML?
Nếu bạn muốn biên soạn nội dung của bạn ở Microsoft Word hoặc OpenOffice.org Writer,
chúng tôi cũng cung cấp các khuôn mẫu Word và Writer để sử dụng. Xem bài viết kèm theo,
"Soạn thảo bằng các khuôn mẫu Word và Writer của developerWorks."
Bắt đầu
Các biên tập viên tại developerWorks rất mong được làm việc với bạn để xuất bản các bài
viết của bạn. Xin hãy chắc chắn rằng bạn đã trình bày ý tưởng của bạn với một biên tập viên
developerWorks và đã được người đó chấp thuận để tiếp tục bài viết của bạn trước khi áp dụng quy
trình hướng dẫn này. Nếu chưa, bạn có thể sử dụng mẫu đệ trình nội dung của chúng tôi để gửi ý
tưởng của bạn.
Các bài viết và hướng dẫn được xuất bản trên developerWorks ở dạng HTML, nhưng được viết bằng
cách sử dụng định dạng XML (Ngôn ngữ Đánh dấu Mở rộng). Trước khi xuất bản, nguồn XML của
© Copyright IBM Corporation 2009, 2011
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Nhẫn hiệu đăng ký
Trang 1 của 13
developerWorks®
ibm.com/developerWorks/vn/
mỗi bài báo và hướng dẫn được xác thực để đánh dấu chấp nhận được như được định nghĩa trong
lược đồ developerWorks và sau đó chuyển sang HTML để xuất bản bằng cách sử dụng một tờ định
kiểu XSLT (Extensible Stylesheet Language for Transformations - Ngôn ngữ định kiểu mở rộng
dùng để chuyển đổi). Phần tách riêng nội dung bài viết khỏi chi tiết trình bày giúp chúng ta sử dụng
các quy trình tự động hoá để quản trị trang web lớn của mình.
Các tiếp cận được phép mà chúng tôi đưa ra không đòi hỏi kỹ năng chuyên môn. Nếu bạn đã quen
với XML hoặc HTML từ trước, bạn sẽ thấy bài viết của chúng tôi và các khuôn mẫu hướng dẫn là dễ
sử dụng. Nếu chưa, bạn có thể làm quen với XML bằng cách đọc các mách nước về bố cục sau đây
trong hướng dẫn này, và bằng cách duyệt trang New to XML trên developerWorks XML zone.
Khuôn mẫu bài viết (article) hay khuôn mẫu hướng dẫn (tutorial)?
Nếu bạn đã xem qua các trang web developerWorks, bạn biết rằng các tác giả đã đóng góp cả bài
viết và hướng dẫn cho developerWorks. Định dạng và mục đích của chúng khác nhau. Biên tập
viên developerWorks của bạn có thể giúp bạn quyết định được định dạng nào là phù hợp hơn với
nội dung ý tưởng của bạn.
Tài liệu hướng dẫn
• Tài liệu hướng dẫn có các mục tiêu giáo dục; chúng giảng dạy. Không phải chỉ đơn giản là liệt
kê các bước, hướng dẫn giải thích tại sao bước đó được thực hiện và nó liên quan đến mục
tiêu tổng thể như thế nào. Hướng dẫn giải thích kỹ lưỡng các mục tiêu giáo dục của chúng và
thời gian để hoàn thành (thường là khoảng hai giờ). Sau khi hoàn tất một hướng dẫn, người
đọc sẽ có thể thực hiện lại nhiệm vụ đã học một cách độc lập.
• Hướng dẫn có thể dạy các khái niệm hoặc cách hoàn thành các nhiệm vụ. Nhiều hướng dẫn
dạy cả khái niệm lẫn nhiệm vụ, và khuyến khích người đọc cố gắng hoàn thành các nhiệm vụ
trong khi đọc. Để việc học theo được dễ dàng, hướng dẫn thường gồm có các đoạn mã lệnh
làm mẫu và lời khuyên để thiết lập môi trường của người đọc. Hướng dẫn cũng thường khoanh
nội dung thành các nhiệm vụ rời nhau, dễ quản lý để làm nên một tổng thể.
• Hướng dẫn đòi hỏi phải có đăng ký.
• Các hướng dẫn dài trung bình từ 20 đến 30 trang khi in ra. Và vì có thể mất vài giờ để hoàn
thành công việc, nhiều người đọc in ra tệp hướng dẫn dạng PDF để tham khảo trong khi hoặc
sau khi đã thực hiện công việc.
• Hướng dẫn có thể đứng độc lập hoặc là một phần của loạt bài nhiều phần.
Bài viết
• Giống như các hướng dẫn, bài viết cũng thường dùng để giảng dạy, nhưng không công khai
như hướng dẫn. Các bài viết không nêu rõ các mục tiêu giáo dục hoặc thời gian hoàn thành
chúng.
• Ngoài việc giới thiệu với người đọc về một công việc cụ thể, bài viết cũng có thể đưa ra các
khái niệm, kiến trúc, hoặc các đặc tính sản phẩm mới. Các loại bài viết này nhằm mục đích
nâng cao nhận thức của người đọc và làm tăng sự khát khao tìm hiểu nhiều hơn nữa của họ
(có thể bằng cách học một bài hướng dẫn của developerWorks!). Có các loại bài viết khác có
giọng điệu thuyết phục hơn, ở đó tác giả chia sẻ cách tiếp cận, cách nhìn hoặc kinh nghiệm độc
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 2 của 13
ibm.com/developerWorks/vn/
developerWorks®
đáo của mình. Và có loại bài viết đào sâu vào một sản phẩm hay công nghệ mới bằng cách
phỏng vấn một chuyên gia hoặc điểm lại các tài liệu hiện có về chủ đề đó.
• Bài viết không yêu cầu phải đăng ký.
• Bài viết dài trung bình 10 trang hoặc ít hơn khi in ra. Người đọc thường đọc nội dung bài viết
trực tuyến.
• Giống như hướng dẫn, bài viết có thể đứng độc lập hoặc là một phần của loạt bài nhiều phần.
Các bước cơ bản
Tạo một bài viết hay hướng dẫn bằng cách làm theo các bước sau:
1. Tải về gói phần mềm tác giả và giải nén tệp.
2. Tạo một thư mục và khuôn mẫu XML cho bài viết hoặc hướng dẫn của bạn bằng cách sử dụng
một kịch bản lệnh từ gói phần mềm.
3. Biên tập khuôn mẫu XML để thêm vào nội dung của bạn, sau đó xác thực XML đó đối với lược
đồ và sửa lại các lỗi.
4. Xem trước bài viết hoặc hướng dẫn của bạn trong một trình duyệt để có một ý tưởng về cách
nó sẽ xuất hiện trên developerWorks.
Bước 1. Tải về gói phần mềm tác giả
Tải về tệp nén author-package và đặt nó vào một nơi thích hợp (ví dụ, C:\ trên Windows hoặc thư
mục chủ của bạn trên Linux). Giải nén tệp.
Thư mục developerworks không cần được đặt trong thư mục gốc hoặc ổ C:\ của Windows. Tuy
nhiên, các công cụ giả định địa chỉ của các tệp là nằm trong thư mục developerworks và các thư
mục con của nó, vì vậy xin giữ nguyên cấu trúc thư mục developerworks và tên các tệp.
Nếu bạn đang sử dụng Linux, bạn cũng nên tải một bộ cài đặt IBM Developer dùng cho Java (xem
Tài nguyên để có liên kết), và cài đặt nó trong /opt/ibm (nếu bạn sử dụng tarball). Các công cụ xác
thực (mô tả trong "Sử dụng các công cụ xác thực developerWorks XML" chỉ làm việc với các phiên
bản Java bao gồm Xalan (phiên bản Java 5.0 gồm cả Xalan 2.7).
Sau khi bạn giải nén tệp, bạn sẽ thấy một thư mục developerworks (hoặc folder) chứa các thư mục
con sau:
• readme -- chứa một tệp readme.html. Tệp readme này liên kết đến bài viết mà bạn bây giờ
đang đọc.
• schema -- chứa các tệp lược đồ. Tệp lược đồ chính có tên là dw-document-5.12.xsd. (5.12 là
mức độ của lược đồ developerWorks vào lúc đọc bài này.)
• tools -- chứa hai khuôn mẫu (template-dw-article-5.12.xml và template-dwtutorial-5.12.xml) cũng như một số công cụ đơn giản để giúp bạn thiết lập và xác thực một
bài viết mới. Các thư mục con java chứa mã nguồn của các chương trình Java™ chúng được
sử dụng bằng việc xác thực Linux và công cụ chuyển đổi, trong trường hợp bạn muốn sửa đổi
hoặc xây dựng lại chúng.
• web -- chứa các hình ảnh và JavaScript cần thiết để xem trước bài viết hoặc hướng dẫn của
bạn.
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 3 của 13
developerWorks®
ibm.com/developerWorks/vn/
• xsl -- chứa tệp kiểu dạng sơ cấp dw-document-html-5.12.xsl và một vài tờ kiểu dạng thứ cấp.
Các tệp và công cụ có trong gói phần mềm tác giả này được thiết kế để sử dụng trên Linux hoặc
Windows. Nếu bạn cần trợ giúp biên tập các khuôn mẫu này bằng cách sử dụng một hệ điều hành
khác Windows hoặc Linux, xin vui lòng liên hệ với biên tập viên developerWorks của bạn.
Thông tin về phiên bản
Trước khi chuyển sang bước 2, chúng ta hãy xem trước những thay đổi trong phiên bản này.
Vào ngày March 23, 2009, lược đồ phiên bản 5.12 và các tờ kiểu dạng đã được phát hành cho các
tác giả. Lược đồ 5.12 và các tờ kiểu dạng gồm các thay đổi bên trong để hỗ trợ cho việc tạo PDF và
các trang siêu nhỏ của developerWorks. Các thay đổi bên ngoài về sự quan tâm đến các tác giả là
tối thiểu, và được phản ánh trong các bản cập nhật cho các bài báo và hướng dẫn:
• Trong phần các sản phẩm và các công nghệ Get của Tài nguyên, bullet thử nghiệm sản phẩm
IBM bao gồm mã và văn bản cập nhật. Nếu bạn sử dụng bullet thử nghiệm sản phẩm, xin vui
lòng chắc chắn rằng bạn sử dụng phiên bản XML mới của bullet đó:
<resource resource-category="Get products and technologies">Download
<a href="http://www.ibm.com/developerworks/downloads/"
onmouseover="linkQueryAppend(this)">IBM product evaluation versions</a>
or <a href="http://www.ibm.com/developerworks/downloads/soasandbox/"
onmouseover="linkQueryAppend(this)">explore the online trials in
the IBM SOA Sandbox</a> and get your hands on application development tools
and middleware products from DB2<reg/>, Lotus<reg/>,
Rational<reg/>, Tivoli<reg/>, and WebSphere<reg/>.</resource>
Tệp nén author-package và bài viết này phù hợp với bản 5.12. Bạn nên chuẩn bị bài viết hoặc
hướng dẫn của bạn bằng cách sử dụng lược đồ và tờ kiểu dạng 5.12. Nếu bạn đã sử dụng một
phiên bản trước đó của lược đồ và tờ kiểu dạng developerWorks, bạn sẽ phải tải về tệp 5.12 authorpackage.zip từ phần Tải về dưới đây.
Các bài viết và hướng dẫn sử dụng cùng một lược đồ sơ cấp (tệp xsd) và tờ kiểu dạng sơ cấp (tệp
xsl):
• Lược đồ sơ cấp: dw-document-5.12.xsd
• Tờ kiểu dạng sơ cấp: dw-document-html-5.12.xsl
Bước 2. Tạo một khuôn mẫu mới
Ở bước này bạn sẽ thiết lập bản sao riêng của bài viết hoặc khuôn mẫu hướng dẫn bằng cách sử
dụng một công cụ trong gói tác giả. Việc này sẽ tạo một tệp mới, có tên là index.xml, trong một thư
mục riêng biệt. Nó sẽ thiết lập đúng các đường dẫn và cũng điều chỉnh khuôn mẫu nên nó làm việc
chính xác trong các môi trường hệ điều hành khác nhau.
Sử dụng Microsoft Windows
Trong thư mục developerworks, nhấn đúp vào new-article.vbs để tạo một bài viết hoặc newtutorial.vbs để tạo một hướng dẫn. Bạn có thể chọn bất cứ một tên hợp lệ nào như tên thư mục
của bạn. Các mặc định là my-article và my-tutorial.
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 4 của 13
ibm.com/developerWorks/vn/
developerWorks®
Hình 1. Tạo và đặt tên một bài viết mới trên Windows
Sau khi bạn nhấn OK, bạn sẽ thấy một thư mục mới trong thư mục developerworks. Bạn có thể cần
phải làm mới lại của bạn khung nhìn (View > Refresh) để xem nó. Thư mục mới này chứa khuôn
mẫu bài viết hoặc hướng dẫn của bạn (index.xml) và một kịch bản lệnh xác thực và chuyển đổi (dwtransform.vbs).
Sử dụng Linux
Sử dụng kịch bản lệnh shell new-article.sh hoặc new-tutorial.sh trong thư mục developerworks.
(Nếu bạn đang chạy màn hình nền KDE hoặc GNOME, bạn có thể chạy nó từ bộ quản lý đồ họa, thí
dụ như Nautilus hoặc Konqueror; nếu không thì chạy kịch bản lệnh trong cửa sổ thiết bị đầu cuối.)
Bạn sẽ thấy một hộp thoại mà có thể nhập vào tên dự án mới của bạn. Bạn có thể chọn bất cứ tên
hợp lệ nào. Các mặc định là my-article và my-tutorial.
Hình 2. Tạo và đặt tên một hướng dẫn mới trên Linux
Sau khi bạn chọn OK (hoặc nhấn Enter), bạn sẽ thấy một thư mục mới trong thư mục
developerworks. Thư mục mới này chứa khuôn mẫu bài viết hoặc hướng dẫn của bạn (index.xml) và
một kịch bản lệnh xác thực và chuyển đổi (dw-transform.sh).
Nếu bạn đang sử dụng một môi trường đồ họa, bạn sẽ cần gói zenity, gdialog hoặc kdialog thích hợp
cho màn hình nền GNOME hoặc KDE của bạn. Nếu bạn đang sử dụng một môi trường phi đồ hoạ,
bạn sẽ cần gói hội thoại.
Bước 3. Biên tập và xác thực XML của bạn
Bạn có thể chọn một trong hai phương thức cơ bản để biên tập và xác thực nguồn XML của bạn.
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 5 của 13
developerWorks®
ibm.com/developerWorks/vn/
Sử dụng một trình soạn thảo xác thực XML
Sử dụng một trình soạn thảo xác thực XML để biên tập và xác thực XML của bạn, giúp bạn xác định
bất kỳ sai sót nào khi bạn làm việc. Nhiều trình soạn thảo XML thương mại đang có trên thị trường
hiện nay dùng cho cả Windows và Linux. Ba ví dụ là Rational® Web Developer for WebSphere®
Software, <oXygen/>, và Altova XMLSpy (xem Tài nguyên để nhận liên kết tải và tài liệu). Cả ba
trình này đều cung cấp các phiên bản dùng thử miễn phí có thể tải về, và chúng tôi đề nghị bạn đọc
các hướng dẫn đi kèm với các sản phẩm này để tìm hiểu cách sử dụng chúng. Tất cả các tệp cần
thiết và hỗ trợ mà bạn cần cho các sản phẩm này, hoặc các trình soạn thảo XML thương mại khác,
để phát triển bài viết hoặc hướng dẫn, đều có trong tệp developerWorks author-package.zip.
Cũng sẵn có một số trình soạn thảo XML miễn phí. Ngoài bản thương mại của XMLSpy đề cập trên
đây, Altova đã giới thiệu một bản miễn phí dùng cho gia đình (Home Edition) của XMLSpy. Ngoài
ra, các chương trình nhúng (plug-ins) cũng sẵn có để dùng cho nền Eclipse mà bạn có thể sử dụng
để chuẩn bị các tài liệu XML. Xem Tài nguyên để nhận được liên kết.
Khi sử dụng một trình soạn thảo xác thực XML hoặc khung làm việc, hãy nhớ:
• Trong các khuôn mẫu, các tham chiếu đến lược đồ và tệp dạng mẫu có liên quan đến thư
mục hướng dẫn hoặc bài viết của bạn. Bạn có thể cần phải thay đổi các tham chiếu (..\schema
\5.12\dw-document-5.12.xsd và ..\xsl\5.12\dw-document-html-5.12.xsl) đến các tham
chiếu tuyệt đối như C:\developerworks\schema\5.12\dw-document-5.12.xsd. Trong một số
trình soạn thảo, bạn có thể phải quy định địa chỉ của các tệp này qua các phương tiện cấu hình
khác.
• Nếu bạn chuyển đổi hướng dẫn hoặc bài viết của bạn trong một trình soạn thảo XML, và không
hiển thị ảnh nào của bạn, có khả năng là trình soạn thảo đã tạo ra tệp HTML trong một thư
mục dùng để lưu trữ tạm thời. Nếu vậy, bạn sẽ cần phải lưu tệp HTML được tạo ra trong thư
mục chứa bài viết của bạn (my-article, trong ví dụ của chúng tôi), và mở nó hoặc trong giao
diện đồ hoạ người dùng (GUI) của trình soạn thảo XML hoặc bằng một trình duyệt.
Sử dụng một trình soạn thảo văn bản và các công cụ xác thực
Nếu bạn không thể tìm thấy một một trình soạn thảo xác thực XML mà bạn thích, hoặc không muốn
dành thời gian bây giờ để tìm hiểu cách sử dụng nó, bạn có thể sử dụng trình soạn thảo văn bản ưa
thích của bạn để biên tập khuôn mẫu XML và sau đó sử dụng các công cụ cung cấp trong gói tác
giả (dw-transform.vbs cho Windows hoặc dw-transform.sh cho Linux) để xác thực XML của bạn
và chuyển đổi nó sang dạng HTML. Bạn có thể sau đó xem trước HTML của bạn trong một trình
duyệt. Xem bài viết kèm theo "Sử dụng các công cụ xác thực developerWorks XML" để biết thêm
chi tiết về cách sử dụng các công cụ đơn giản này.
Bước 4. Xem trước bài viết hoặc hướng dẫn của bạn
Bạn có thể xem trước bài viết hoặc hướng dẫn của bạn để có một ý tưởng chung về kết quả cuối
cùng sẽ như thế nào. Tuy nhiên, sẽ có một số khác biệt giữa phiên bản xem trước và phiên bản cuối
cùng. Khi xem trước hướng dẫn hoặc bài viết của bạn, tập trung vào nội dung và đừng lo lắng các
vấn đề về trình bày hoặc phong cách. Chúng tôi sẽ sửa đổi cần thiết khi thực hiện chỉnh sửa lần cuối.
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 6 của 13
ibm.com/developerWorks/vn/
developerWorks®
Nếu bạn đang sử dụng một trình soạn thảo xác thực XML, kiểm tra các tài liệu hướng dẫn về cách
chuyển đổi tệp XML thành tệp HTML và sau đó xem tệp đó bằng một trình duyệt. Một số trình soạn
thảo có một tùy chọn xem trước của trình duyệt để đơn giản hóa bước này.
Nếu bạn đang sử dụng một trình soạn thảo văn bản và các kịch bản lệnh developerWorks, kết quả
HTML của bạn sẽ được tạo trong bài viết hoặc thư mục hướng dẫn của bạn. Mở index.html với một
trình duyệt. Các hướng dẫn chi tiết hơn về cách sử dụng các tập lệnh này có trong "Sử dụng các
công cụ xác thực developerWorks XML".
Các mẹo về bố cục
Những điều mới về đánh dấu XML?
Như tất cả các tài liệu XML, khuôn mẫu XML trong gói tác giả tuân theo các quy tắc sau đây:
• Các thẻ XML (các chuỗi giữa < và >) là chữ thường.
• Các thẻ XML thường đi theo cặp: một thẻ bắt đầu và một thẻ kết thúc tương ứng. Ví dụ,
<title> và </title> là các thẻ bắt đầu và kết thúc dùng cho tiêu đề bài viết hoặc hướng
dẫn của bạn.
• Nội dung của bạn nằm giữa các thẻ, như trong <title>Groovy's growth spurt</title>.
• Một ngoại lệ cho các cặp thẻ là một thẻ chẳng hạn như một dấu ngắt dòng (<br />) hoặc
một thẻ ảnh (<img />), nơi một thẻ đơn lẻ dùng cả vào việc bắt đầu và kết thúc; trong
trường hợp này, thẻ kết thúc bằng />.
• Các dòng chú thích được bao quanh bằng <!-- và -->.
Các tệp XML mà bạn tạo ra trong Bước 2 là nguồn tốt nhất của bạn để có các mẹo nhanh để phát
triển bài viết hoặc hướng dẫn của bạn. Các chú thích sâu hơn dẫn bạn đi qua mọi khía cạnh của việc
mã hóa bài viết hoặc hướng dẫn của bạn. Sau đây là một số mách nước khác mà bạn hẳn thấy hữu
ích:
• Biên soạn trong Microsoft Word hoặc OpenOffice Writer?
Bạn có thể sử dụng khuôn mẫu Word hoặc Writer thay vì khuôn mẫu XML; tìm đầy đủ chi tiết
trong "Soạn thảo bằng các khuôn mẫu Word và Writer của developerWorks."
Cách khác, bạn có thể cắt và dán từ các định dạng tệp khác vào khuôn mẫu XML. Nếu bạn
cắt và dán từ một tệp với định dạng nhúng, chẳng hạn như một tệp Word hoặc Writer, sử dụng
các khả năng soạn thảo của bạn để dán (hoặc dán đặc biệt (paste special)) như là văn bản,
hoặc lưu tệp này như một tệp TXT trước khi bạn cắt và dán từ nó. Không cắt và dán trực tiếp
từ một tệp đã định dạng. Ngoài ra, nếu tài liệu Word hoặc Writer của bạn có các ảnh nhúng
vào, đừng lo lắng việc trích xuất chúng ra; chỉ cần chuyển giao tài liệu Word hoặc Writer của
bạn sang biên tập viên developerWorks của bạn, và đội ngũ thiết kế trực quan của chúng tôi
sẽ trích xuất và tinh chỉnh các ảnh đó. Và cuối cùng, nếu tài liệu Word hoặc Writer của bạn có
phần “Theo dõi các thay đổi” được bật lên, hãy tắt nó đi cẩn thận trước khi bạn cắt và dán vào
khuôn mẫu XML; nếu không thì tất cả các tài liệu đã xóa của bạn sẽ xuất hiện trở lại trong các
văn bản của bạn!
• Các thẻ kết thúc. hãy nhớ dùng các thẻ kết thúc. Ví dụ, thẻ đoạn văn (paragraph tag) (<p>)
nào cũng cần một thẻ đóng của nó (closing tag) (</p>). Ngoài ra, các thành phần rỗng như thẻ
ngắt (<br />) và thẻ ảnh (<img />) cũng cần một dấu gạch chéo đóng.
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 7 của 13
developerWorks®
ibm.com/developerWorks/vn/
• Các thẻ cần tránh. Tránh các thẻ quãng cách, thẻ mã phông chữ, thẻ CDATA, và các lớp
phông chữ.
• Các liệt kê mã. Khi gộp vào các liệt kê của dòng mã mẫu trong bài viết hoặc hướng dẫn của
bạn:
• Độ dài dòng tối đa là 90 ký tự, kể cả dòng trống.
• Độ dài liệt kê tối đa là 100 dòng, kể cả dòng trống.
Nếu liệt kê mã của bạn dài hơn 100 dòng, hãy ngắt đoạn nó thành các đoạn liệt kê riêng
lẻ hoặc trích đoạn các dòng quan trọng nhất, và coi việc cung cấp toàn bộ liệt kê mã là
mã mẫu có thể tải về trong phần “Tải về” của bài viết hoặc hướng dẫn của bạn.
• Tránh mã hoá cứng các dấu khoảng trống hoặc các tab tại phần cuối của một dòng mã
mẫu.
• Tránh sử dụng các tab tại phần đầu của một dòng mã mẫu. Nếu bạn phải thụt lề, hãy sử
dụng các dấu khoảng trống.
• Không sử dụng các thẻ CDATA. Nếu bạn cần phải hiển thị các thẻ XML, thí dụ như các
dấu ngoặc góc trong mã mẫu của bạn, sử dụng < và > (xem các ký tự đặc biệt khác trong
Bảng 1).
• Không sử dụng màu sắc. Nếu bạn muốn làm nổi bật một phần của mã mẫu của bạn, sử
dụng kiểu chữ đậm (<b> và </b>) thay vào đó.
• Mã mẫu có thể tải về. Khi cung cấp mã ví dụ mẫu để tải về cho phần “Tải về” của bài viết hoặc
hướng dẫn của bạn, nén mã đó lại và gửi riêng tệp ZIP của bạn cho biên tập viên.
• Ảnh minh hoạ. Tạo tất cả các tệp ảnh minh hoạ, gồm cả hình chụp màn hình, như các tệp JPG
hoặc GIF, và phải đảm bảo chúng không quá 572 điểm ảnh (đối với các bài viết) hoặc 500
điểm ảnh (đối với các hướng dẫn). Gửi các tệp ảnh minh hoạ cho biên tập viên của bạn. Xem
"Minh hoạ bài viết hoặc hướng dẫn của bạn cho developerWorks" để tìm hiểu thêm về cách tạo
và thực hiện đồ họa hiệu quả.
• Các ký tự đặc biệt. Mã hoá các ký tự đặc biệt như sau (không sử dụng các thẻ CDATA):
Bảng 1, Các ký tự đặc biệt
Ký tự
Mã XML
Dấu ampersand (&)
& (Luôn luôn mã hoá các dấu ampersand là & — kể cả
trong các URL.)
Dấu nháy đơn (')
'
Ký hiệu lớn hơn (>)
>
Ký hiệu nhỏ hơn (<)
<
Dấu gạch ngang (—)
<mdash />
Dấu trích dẫn (")
"
Thương hiệu đã đăng ký (®)
<reg/> (Tác giả có thể nhưng không cần chèn các ký hiệu thương
hiệu; các biên tập viên developerWorks sẽ đẻ ý đến các thương
hiệu.)
Nhãn hàng hóa (™)
<trade/> (Tác giả có thể nhưng không cần chèn các ký hiệu thương
hiệu; các biên tập viên developerWorks sẽ để ý đến các nhãn hiệu.)
Ví dụ, để gộp vào các dấu ngoặc nhọn trong một đoạn mã:
<TABLE border="0" width="100%">
Bạn sẽ mã hoá những thứ sau trong khuôn mẫu XML:
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 8 của 13
ibm.com/developerWorks/vn/
developerWorks®
<TABLE border="0" width="100%">
• Các dòng chú thích. Để thấy tốt hơn nội dung riêng của bạn khi phát triển nó, hãy loại bỏ
thoải mái các dòng chú thích từ tệp bài viết khi bạn đã quen với việc gắn thẻ.
Quy ước về cách làm nổi bật
Bạn không dám chắc cái gì cần gắn thẻ <code type="inline"> và cái gì không cần? Bạn có sử dụng
kiểu chữ nghiêng hoặc các trích dẫn cho một tiêu đề sách không? Khi nào bạn phải sử dụng kiểu
chữ đậm -- hay hoàn toàn không cần làm nổi bật chút nào? Bảng 2 cho biết các quy ước về cách
làm nổi bật được khuyến cáo cho các bài viết và hướng dẫn trên developerWorks.
Bảng 2. Cách làm nổi bật khuyên dùng
Yếu tố được làm nổi bật
Cách làm nổi bật khuyên dùng
Thí dụ
"Tiêu đề bài viết"
Các dấu ngặc kép
"Article titles"
Tiêu đề sách
Chữ nghiêng
<i>Book titles</i>
Mã C/C++
Mã trên dòng
<code type="inline">C/C++ code</code>
Lớp
Mã trên dòng
<code type="inline">Classes</code>
Mã ví dớ
Phần mã
<code type="section"> Code samples </code>
Mã trích ngớn (ngớn hớn mớt dòng)
chen giớa văn bớn
Mã trên dòng
<code type="inline">Code snippets (less than
one line) referenced in text</code>
Tên cột hay chuỗi
Chữ nghiêng
<i>Column or series names</i>
Tên lớnh
Mã trên dòng
<code type="inline">Command names</code>
Tên thư mục
Không làm nổi bật
Directory names
Lời văn cần nhấn mạnh
Chữ nghiêng. Ví dụ: "Use that to introduce a
restrictive clause. Do not type over .."
Use <i>that</i> to introduce a restrictive
clause. Do <i>not</i> type over ..
Tên ngoới lớ
Mã trên dòng
<code type="inline">Exception names</code>
Tên tệp
Không làm nổi bật
File names
Gới hàm
Mã trên dòng
<code type="inline">Function calls</code>
Điều khiển GUI
Chữ đậm. Ví dụ : "On the Installation menu,
click Install a new feature > Finish."
On the Installation menu, click <b>Install a new
feature</b> > <b>Finish</b>.
Ví dớ vớ thớ HTML hoớc đoớn HTML
Mã trên dòng
<code type="inline">HTML tags or portions</
code>
Giao diớn
Mã trên dòng
<code type="inline">Interfaces</code>
Tớ khoá (ví dớ nhớ static)
Mã trên dòng
<code type="inline"> Keywords (such as
static)</code>
Tiêu đề tạp chí
Chữ nghiêng. Ví dụ : "See the related article in
LinuxToday ..."."
See the related article in <i>LinuxToday</i> ...
Thông điớp hoớc lới nhớc dành cho
ngớới sớ dớng
Mã trên dòng
<code type="inline">Message text or prompts
addressed to the user</code>
Phớớng thớc
Mã trên dòng
<code type="inline">Methods</code>
Đới tớớng
Mã trên dòng
<code type="inline">Objects</code>
Tên đường dẫn
Không làm nổi bật
Path names
Các thuật ngữ được định nghĩa theo bối cảnh
Chữ nghiêng
<i>Terms defined in context</i>
Văn bớn do ngớới sớ dớng nhớp vào
Mã trên dòng
<code type="inline">Text entered by users</
code>
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 9 của 13
developerWorks®
ibm.com/developerWorks/vn/
"Tiêu đề Hướng dẫn"
Các dấu ngặc kép
"Tutorial titles"
Kiớu dớ liớu (chớng hớn nhớ int
hay long)
Mã trên dòng
<code type="inline">Types (such as int or
long)</code>
URL
Không làm nổi bật
URLs
Biến
Chữ nghiêng. Ví dụ : "... where myname
represents your user ID..."
... where <i>myname</i> represents your user
ID...
Thớ XML hoớc mớt đoớn XML
Mã trên dòng
<code type="inline">XML tags or portions</
code>
Trình bài viết hoặc hướng dẫn của bạn cho developerWorks
Khi hoàn thành tác phẩm của mình, bạn sẵn sàng gửi nó cho biên tập developerWorks của bạn.
Hãy gửi bằng e-mail tệp XML bài viết hoặc hướng dẫn của bạn (cùng với bất cứ đồ họa hoặc mẫu
mã nào có liên quan) đến biên tập viên của bạn. Để có hướng dẫn chi tiết và các mách nước về
việc tạo và trình đồ họa cho bài viết của bạn, xem "Minh hoạ bài viết hoặc hướng dẫn của bạn cho
developerWorks: Cách tạo ra các đồ họa hiệu quả."
Nếu bạn có bất kỳ câu hỏi hay vấn đề gì, xin liên hệ với biên tập viên của bạn để được thêm trợ
giúp.
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 10 của 13
ibm.com/developerWorks/vn/
developerWorks®
Các tải về
Mô tả
Tên
Kích thước
IBM developerWorks author package, V6.0
author-package-V6.0_20110421.zip
848KB
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 11 của 13
developerWorks®
ibm.com/developerWorks/vn/
Tài nguyên
Học tập
• "Sử dụng các công cụ xác thực developerWorks XML" (developerWorks, 12.2008): Nếu bạn
ưa sử dụng một trình soạn thảo để biên tập khuôn mẫu XML, có thể sử dụng các công cụ cung
cấp với gói phần mềm tác giả để xác thực XML của bạn và xem trước nội dung của bạn.
• "Soạn thảo bằng các khuôn mẫu Word và Writer của developerWorks" (developerWorks,
03.2008): Nếu thay vì sử dụng các khuôn mẫu XML, bạn lại ưa biên tập bố cục nội dung của
bạn trong Microsoft Word hoặc OpenOffice.org Writer, chúng tôi cũng cung cấp các khuôn
mẫu Word và Writer để bạn sử dụng.
• "Minh hoạ bài viết hoặc hướng dẫn của bạn cho developerWorks: Cách tạo ra các đồ họa hiệu
quả" (developerWorks, 07.2008): Tìm hiểu các hướng dẫn và mách nước chi tiết về việc tạo ra
và gửi lên nội dung đồ họa cho bài viết của bạn.
• Các chỉ dẫn và chính sách biên tập dành cho tác giả developerWorks: Tìm hiểu thêm về
chính sách biên tập của chúng tôi và xem danh sách các nội dung mong đợi của ban biên tập
developerWorks.
Lấy sản phẩm và công nghệ
• Microsoft's XML Parser (MSXML) Phiên bản 4 hoặc Phiên bản 6: để sử dụng kịch bản lệnh
dw-transform.vbs để chuyển bài viết hoặc hướng dẫn của bạn, bạn cần hoặc phiên bản 4
hoặc phiên bản 6 của bộ phân tích MSXML. Tệp bạn cần là msxml.msi (phiên bản 4) hoặc
msxml6.msi (phiên bản 6).
• IBM Developer Kit dùng cho Java: Để sử dụng kịch bản lệnh dw-transform.sh trên Linux để
chuyển đổi bài viết hoặc hướng dẫn của bạn, bạn cần bộ phát triển IBM Developer Kit cho
Java, phiên bản 5.0 hoặc mới hơn.
• Rational® Web Developer for WebSphere® Software V6.0: Tải về phiên bản dùng thử trên
developerWorks.
• Các sản phẩm dùng thử của IBM để tải về: Lập dự án phát triển của bạn với phần mềm chạy
thử của IBM, có sẵn để tải về trực tiếp từ developerWorks.
• <oXygen/> trình soạn thảo XML & XSLT Debugger (cho nhiều nền tảng) và Altova XMLSpy
(cho Windows): Tìm hiểu về hoặc tải về các bản dùng thử của các trình soạn thảo XML thương
mại này.
• XML Copy Editor là một trình soạn thảo xác thực XML, nhanh, miễn phí mà có thể xác thực
và chuyển đổi các tệp XML của bạn.
• "Phát triển XML với Eclipse" (developerWorks, 04.2003): Tạo ra các tài liệu XML bằng cách
sử dụng nền Eclipse với các chương trình nhúng như XMLBuddy của Bocaloco Software.
Thảo luận
• Mẫu trình nội dung: đệ trình một ý tưởng bài viết hay hướng dẫn cho developerWorks, và bắt
đầu nói chuyện với một biên tập viên developerWorks. Kiểm tra xem nội dung nào được mong
đợi nhất trong danh sách các nội dung mong đợi.
• Thông tin liên hệ với biên tập viên developerWorks: Nếu bạn có thắc mắc gì, hãy liên hệ với
biên tập viên về lĩnh vực công nghệ hay sản phẩm mà bạn quan tâm
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 12 của 13
ibm.com/developerWorks/vn/
developerWorks®
Đôi nét về tác giả
Editorial staff
This article was brought to you by the developerWorks editorial staff.
© Copyright IBM Corporation 2009, 2011
(www.ibm.com/legal/copytrade.shtml)
Nhẫn hiệu đăng ký
(www.ibm.com/developerworks/vn/ibm/trademarks/)
Cho phép dùng khuôn mẫu developerWorks XML của
developerWorks
Trang 13 của 13