Хочете використовувати шаблони Word або OpenDocument замість XML-шаблонів?
Початок роботи
Всі матеріали публікуються на сайті developerWorks в форматі HTML, проте спочатку створюються у вигляді документів XML (Extensible Markup Language). Перед публікацією XML-вміст кожного матеріалу перевіряється на відповідність правилам розмітки, що визначаються схемою developerWorks, а потім перетворюється в HTML за допомогою сторінок XSLT (Extensible Stylesheet Language for Transformations). Подібне відділення вмісту статей від особливостей їх оформлення допомагає нам автоматизувати управління великим сайтом developerWorks.
Ніякі з пропонованих нами процедур підготовки матеріалів не вимагають спеціальних навичок. Якщо вам раніше доводилося стикатися з XML або HTML, то у вас не повинно виникнути труднощів з використанням шаблонів. В іншому випадку ви можете ознайомитися з XML, прочитавши поради з підготовки матеріалів нижче, а також звернутися до сторінці для початківців працювати з XML на сайті developerWorks.
Основні кроки
Для створення власного матеріалу виконайте такі дії:
Завантажте файл author-package zip збережіть його в каталозі на ваш розсуд (наприклад, в C: \ в Windows або в домашній директорії в Linux) і розпакуйте.
При роботі з Linux вам також необхідно завантажити пакет Java-розробника від IBM (IBM Developer Kit for Java, див. Розділ Ресурси). Його бажано встановити в каталозі / opt / ibm, хоча, якщо у вас немає адміністративних привілеїв, також можна завантажити tar-архів і встановити його в домашній директорії. Засоби перевірки XML працюють тільки на платформах Java, що включають Xalan (Xalan 2.7 входить в Java 5.0). За додатковою інформацією зверніться до статті Використання інструментів перевірки XML від developerWorks. .
Розпакувавши архів, ви повинні побачити каталог developerworks, що містить наступні дочірні директорії:
Інформація про версію
Перед тим як переходити до наступного кроку, обговоримо, що змінилося в останніх версіях.
Крок 2. Створення нового шаблону
При роботі з Microsoft Windows
Для створення статті перейдіть в директорію developerworks і виконайте скрипт new-article.vbs. Ви можете задати будь-яке припустиме ім'я каталогу на ваш розсуд. За замовчуванням використовується каталог my-article.
Малюнок 1. Створення та присвоєння імені нової статті в Windows
Натиснувши OK. ви повинні побачити нову директорію всередині каталогу developerworks (для цього вам може знадобитися оновити список директорій, вибравши пункт меню (View> Refresh). Вона містить шаблон вашої статті (файл index.xml), а також скрипт перевірки і перетворення в HTML (файл dw -transform.vbs).
При роботі з Linux
Виконайте скрипт new-article.sh в директорії developerworks. (Якщо у вас встановлена оболонка KDE або GNOME, то скрипти можна викликати через графічний менеджер, наприклад Nautilus або Konqueror. В іншому випадку виконайте їх через командний інтерпретатор.) При цьому ви побачите діалогове вікно, в якому буде запропоновано ввести ім'я проекту. Ви можете вибрати його на ваш розсуд. За замовчуванням використовується ім'я my-article.
Вибравши OK (або натиснувши Enter), ви повинні побачити нову директорію всередині developerworks. Вона містить шаблон вашої статті (файл index.xml), а також скрипт перевірки і перетворення в HTML (файл dw-transform.sh).
Зауваження. При використанні графічної оболонки (GNOME або KDE) вам будуть потрібні пакети zenity, gdialog або kdialog. В інших випадках достатньо буде пакету dialog.
Крок 3. Редагування та перевірка XML
Є два основних способи редагування і перевірки вашого матеріалу в форматі XML.
Поради щодо редагування шаблонів
Для початківців працювати з XML
- Редагування в форматах Microsoft Word або OpenDocument?
Замість XML ви можете використовувати шаблони документів Word і OpenDocument. Докладні інструкції наведено в статті Підготовка документів з використанням шаблонів Word і OpenDocument від developerWorks.
Крім того, ви можете копіювати в шаблон XML текст з файлів іншого формату.
- У шаблоні статті є два різних елемента для роботи з програмним кодом:
і . використовуйте елементдля відділення свого прикладу коду від навколишнього тексту. Якщо ви хочете помістити команду всередину тексту параграфа (вбудований код), скористайтеся елементом . - Довжина одного рядка лістингу не повинна перевищувати 105 символів. з урахуванням пробілів. Шаблон містить зразок з лінійкою, яка допоможе вам витримати цю вимогу.
- Максимальний розмір лістингу становить 100 рядків. з урахуванням порожніх рядків.