Советы по созданию документов для GetPublished

By: Vladimir Panarin

Abstract: Прочтите эту статью, чтобы получить советы по созданию хорошо отформатированных документов для нашей системы управления содержимым сайта - GetPublished

Мы создали GetPublished для быстрого создания легких для представления, хорошо отформатированных технических документов с минимальными затратами. Одной из базовых технологий, которую мы создали специально для этого, являются наши Адаптеры Документов (Document Adapters), преобразующие различные форматы документов в HTML.

В этой статье приведено несколько простых советов по форматированию документов, используя которые Вы сможете с минимальными усилиями получить на выходе документы, которые будут прекрасно отображаться GetPublished.

    Советы для Microsoft Word

Большинство своих статей я пишу в Microsoft Word. В этой части статьи содержаться советы по форматированию текста в Word.

    Начните с нашего шаблона

У нас есть шаблон для документа Word, содержащий специальные стили, которые воспринимаются нашими Адаптерами Документов. Вы можете скачать его, перейдя по ссылке http://gp.codegear.com/files/CodeGear.dot. (Эта ссылка расположена слева внизу на странице GetPublished) Скачав файл, убедитесь, что файл имеет расширение .dot.

    Создайте свой документ

У меня на рабочем столе есть ярлык для нашего шаблона, поэтому, когда я хочу создать новый документ, я просто дважды щелкаю по этому ярлыку и начинаю писать.

    Форматирование исходного кода

Наши Адаптеры Документов поддерживают автоматическую подсветку синтаксиса. Вставьте свой исходный код в Ваш документ, выберите Формат|Стили и форматирование и щелкните по подходящему стилю. Весь выбранный текст окажется подсвечен и написан моноширинным шрифтом. Если Вы вставляете код, написанный на не поддерживающемся языке, используйте стиль "SourceCode".

Чтобы показать, насколько это легко, я вставил несколько примеров исходного кода и выбрал для них соответствующие стили.

Вот программа "Hello World!" на Delphi:

program HelloWorld;
{$APPTYPE CONSOLE}
uses
  SysUtils;
begin
  WriteLn('Hello World!');
 end.

На C#:

using System;
namespace HelloWorld
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");
        }
    }
}

На Java:

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

На PHP:

<?php
echo( "Hello World!\r\n" );
?>

На C++:

#include <iostream>
 
int main()
{
    cout << "Hello World!\r\n";
}

На JavaScript:

alert("Hello World!");

На Ruby:

    # The Greeter class
    class Greeter
      def initialize(name)
        @name = name.capitalize
      end

      def salute
        puts "Hello #{@name}!"
      end
    end

    # Create a new object
    g = Greeter.new("world")

    # Output "Hello World!"
    g.salute

И на SQL:

select 'hello world' from rdb$database

Я даже могу вставить такой пример на Visual Basic от Bruce McGee, но из-за того, что у нас нет автоматической подсветки синтаксиса для этого языка, я выбрал для него стиль, как для "обычного" кода:

Module HelloWorld
    Sub Main()
        Console.WriteLine("Hello World")
    End Sub
End Module

Я хотел бы поблагодарить Jonathan Benedicto, David Clegg и Wayne Niddery за такие простые примеры "Hello world!", которые избавили меня от необходимости придумывать их самому.

    Вставка изображений

Так же просто Вы можете вставлять картинки в свои статьи, не используя OLE. Мы автоматически конвертируем слишком большие изображения в миниатюры со ссылкой на картинки оригинального размера.

Моя любимая программа для снятия скриншотов – SnagIt, чтобы сделать снимок экрана я использую клавишу PrintScreen. Я вывожу на экран то, что я хочу снять, нажимаю PrintScreen и SnagIT показывает мне то, что я снял. Я нажимаю кнопку "Copy All", переключаюсь обратно в Word и вставляю картинку из буфера в свой документ.

Вот скриншот документа, который я пишу, сделанный описанным выше способом (изображена английская версия документа):

Hide image
Click to see full-sized image

Часть 1 Вставка изображений

Имейте ввиду, что это миниатюра со ссылкой на оригинальной изображение, потому что этот скриншот больше заданных у нас высоты или ширины изображения для данного типа документов, поэтому он автоматически преобразуется в миниатюру со ссылкой.

У нас также поддерживаются названия для картинок. Вы можете щелкнуть правой кнопкой по вставленной картинке, выбрать в меню пункт "Название" и ввести название для картинки.

Hide image

Часть 2 Ввод названия для изображения

Если изображение достаточно маленькое, оно не конвертируется в миниатюру.

    Автоматическое содержание документа

Если Вы будете выбирать соответствующие стили заголовков в своем документе, наша система автоматически создаст в нем содержание и скрываемые секции (collapsible sections). Поэтому, создавая документ, не забывайте выбирать для различных его частей соответствующие стили или задайте их после того, как документ будет готов.

В итоге Вы получите прекрасное содержание документа наподобие того, что есть на этой странице. Оно состоит из ссылок и позволяет перемещаться к различным частям документа. Также автоматическое конвертирование документов в HTML создает в нужных частях документа скрываемые секции.

    Вставка гиперссылок

По умолчанию Word автоматически создает гиперссылки. Если Вы отключили эту опцию, Вы можете создать гиперссылку, выделив нужный текст и нажав Ctrl+K или щелкнув правой кнопкой мыши по выделенному тексту и выбрав "Гиперссылка…".

    Узнайте больше о GetPublished

У нас есть Адаптеры Документов и для других форматов, таких, как HTML и Wiki. Чтобы узнать больше о том, что Вы можете сделать в GetPublished, смотрите раздел Online Help.

Server Response from: ETNASC04