Генерация отчётов по продвижению сайта в формате HTML

Программа TopSite может генерировать отчёты по продвижению сайтов для групп запросов, по которым производилась проверка позиций. Для этого нужно выбрать группу запросов и нажать на кнопку «Сгенерировать отчёт». Пример отчёта можно посмотреть здесь. Диалоговое окно настроек отчёта имеет следующий вид:

Диалоговое окно генерации HTML-отчёта

После нажатия кнопки «Сохранить», программа создаёт HTML-файл на основе шаблона, указанного в верхнем поле диалогового окна. По-умолчанию, шаблон хранится в папке программы и состоит из файла report.html и папки report.files со всем её содержимым. Этот шаблон поставляется вместе с программой и имеет очень простой вид. Вы можете создать свой собственный шаблон на основе этого шаблона, добавив в него свои логотипы, тексты и изменив оформление. Далее будет рассказано, как это сделать.

Создание своего шаблона

Для начала скажем, что шаблон, находящийся в папке программы (чаще всего это c:\ProgramFiles (x86)\TopSite\), редактировать нельзя из-за того, что при установке новой версии программы он будет перезаписан. Поэтому нам нужно скопировать шаблон и его папку со всем содержимым, к примеру, на Рабочий стол. Дальше, если необходимо, шаблон можно переименовать для удобства. При переименовании файла шаблона, его расширение должно остаться «.html». Папку тоже нужно переименовать. Имя папки должно быть таким же, как новое имя файла (без расширения), а расширение у папки всегда должно быть «.files».

Пример копирования с переименованием:

 БылоСтало
Файлc:\ProgramFiles (x86)\TopSite\report.htmlc:\Users\user\Desktop\Мой шаблон.html
Папкаc:\ProgramFiles (x86)\TopSite\report.filesc:\Users\user\Desktop\Мой шаблон.files

Содержимое папки переименовывать не нужно. При создании отчёта оно копируется целиком в неизменном виде. В папку можно добавлять свои файлы: изображения, файлы CSS, скрипты и т.д. При создании отчёта программа также добавляет в эту папку (отчёта) файлы созданных изображений (графики).

Копия шаблона создана. Теперь её можно изменять. Не забудьте в окне генерации отчёта поменять путь к шаблону (вверху окна).

Алгоритм генерации отчёта на основе шаблонных файлов

Всё достаточно просто. Берутся шаблонные файлы и на их основе делаются файл и папка уже готового отчёта. Сначала будет скопировано всё содержимое шаблонной папки во вновь созданную папку нового отчёта. Её имя точно так же зависит от заданного вами в диалоговом окне (в самом низу окна) имени отчёта. Папка создастся автоматически. Затем в эту же новую папку будут добавлены сгенерированные программой изображения. Затем будет записан файл отчёта, сгенерированный на основе шаблона. Не запутайтесь в словах «шаблон» и «отчёт» :-)

Редактирование HTML-файла шаблона

Итак, ещё раз. Программа берёт шаблонную папку и копирует её со всем содержимым. Затем открывает шаблонный файл и на его основе создаёт уже готовый файл отчёта в формате HTML.

С папкой всё просто: в ней хранятся необходимые файлы: логотипы, изображения и файл css. Для того, чтобы вставить свой логотип, достаточно будет изменить его в шаблонной папке. Если нужно поменять цвета, это можно сделать, изменив файл style.css. Естественно, вы должны понимать, о чём речь: иметь навыки работы с HTML, CSS и немного аккуратности.

Файл шаблона устроен немного сложнее. Это обычный HTML-файл, но имеющий специальные маркеры, которые понимает программа. При создании отчёта, маркеры помогают программе понять, в каких местах нужно вставлять данные и какие. К примеру:

Маркеры в файле шаблона

Зто блок позиций. Он начинается с <!-- %positions_block_begin% --> и заканчивается на строке <!-- %positions_block_end% -->. Если блок позиций будет отключен в диалоговом окне генерации отчёта, то программа вырежет этот блок полностью и в отчёте его не будет. Если же блок включен, то будут вырезаны только маркеры, а переменные внутри блока будут заменены на нужные значения. Все маркеры таких блоков имеют конструкции _block_begin и _block_end, по которым их можно отличать.

Другой тип блока - это подблок с конструкциями вида _repeat_begin и _repeat_end. Эти подблоки служат для многократного вывода данных. Содержимое этого подблока будет повторено несколько раз. Ровно столько раз, сколько будет выводимых данных. Это может быть строка таблицы, график или что-то ещё.

Маркеры, начинающиеся с if_yandex, if_google и if_mail предназначены для вырезания того, что находится внутри помеченного блока в случае отсутствия данных по соответствующим поисковикам. Содержимое будет вырезано вместе с самими маркерами от начала и до конца. Если данные для вывода имеются, программа вырежет только сами маркеры.

Переменные — это конструкции вида %переменная%, которые не помещены в HTML-тег комментария. Во время генерации отчёта переменные будут заменены на конкретные данные. В каждом блоке свои переменные. Формат подставляемых значений изменить нельзя. Переменные можно убирать, вставлять несколько раз в разных местах, блоки можно менять местами и т.д. На работоспособности это не скажется. Все текстовые операции при генерации отчёта программа делает методом поиска и замены.

Переменная %path_to_files% заменяется на путь к папке .files, в которую сохраняются файлы отчёта. Например, чтобы вставить изображение, нужно прописать путь в формате <img src="%path_to_files%/image.png" alt="">, а само изображение записать в папку шаблона.

Таким образом, вы можете изменить формат шаблона и уже на его основе создавать отчёты нужного вам вида.

Статья отредактирована: 29 мая 2017 г.
Поделиться с друзьями
Статья опубликована
20 окт. 2016 г.
Предыдущая статья
Следующая статья