Заголовки разделов номеров, заголовки таблиц и подписи рисунков программно

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

Импортируйте пакет DOM API, чтобы не использовать длинные, полные имена классов.

import mlreportgen.dom.*

Создание и открытие документа. Чтобы создать документ Word, измените тип вывода с pdf кому docx. Чтобы создать HTML-документ, измените pdf кому html или html-file для многофайлового или однофайлового документа соответственно.

d = Document("mydoc","pdf");
open(d);

Добавление оглавления к документу.

append(d,TOC);

Создание потоков нумерации для заголовков глав, заголовков подразделов, заголовков рисунков и названий таблиц. По умолчанию потоки создаются с использованием арабских чисел с начальным значением 0.

chapterStream = createAutoNumberStream(d,"chapter");
sectionStream = createAutoNumberStream(d,"section");
figureStream = createAutoNumberStream(d,"figure");
tableStream = createAutoNumberStream(d,"table");

Определите некоторые стили изображений, таблиц и записей таблиц, которые будут использоваться в последующих разделах.

imageStyle = ...
    { ...
    Height("5in"), ...
    Width("5in") ...
    };

tableStyle = ...
    { ...
    Width("100%"), ...
    Border("solid"), ...
    RowSep("solid"), ...
    ColSep("solid") ...
    };

tableEntriesStyle = ...
    { ...
    HAlign("center"), ...
    VAlign("middle") ...
    };

Следующий код создает первую главу документа. Заголовок главы создается с помощью getChapterTitle функция. Эта функция использует chapter поток нумерации для создания пронумерованного заголовка главы. Глава состоит из двух подразделов, названия которых создаются с помощью getSectionTitle функция. Эта функция использует оба chapter и section потоки нумерации для создания заголовка иерархического пронумерованного раздела. Подразделы состоят из нескольких рисунков с иерархическими нумерованными подписями, которые создаются с помощью getFigureCaption функция. Эта функция использует оба chapter и figure потоки нумерации для создания заголовка иерархического пронумерованного рисунка. getChapterTitle, getSectionTitle, и getFigureCaption функции, используемые для создания этой главы, описаны ниже в этом примере.

% Chapter 1.
chapterTitle = getChapterTitle("Figures with numbered captions");
append(d,chapterTitle);

% Section 1.1.
sectionTitle = getSectionTitle("Figure for Land Ocean");
append(d,sectionTitle);

% Figure 1.1.
image1 =  Image(which("landOcean.jpg"));
image1.Style = imageStyle;
append(d,image1);
append(d,getFigureCaption("Land Ocean"));

% Section 1.2.
sectionTitle = getSectionTitle("Figures for Peppers and Cat's Eye Nebula");
append(d,sectionTitle);

% Figure 1.2.
image2 = Image(which("peppers.png"));
image2.Style = imageStyle;
append(d,image2);
append(d,getFigureCaption("Peppers"));

% Figure 1.3.
image3 = Image(which("ngc6543a.jpg"));
image3.Style = imageStyle;
append(d,image3);
append(d,getFigureCaption("Cat's Eye Nebula or NGC 6543"));

Следующий код создает вторую главу документа. Глава имеет пронумерованный заголовок с двумя иерархическими пронумерованными подразделами. Здесь подразделы состоят из нескольких таблиц с иерархическими нумерованными заголовками, которые создаются с помощью getTableTitle , определенной далее в этом примере. Эта функция использует оба chapter и table потоки нумерации для создания заголовка таблицы с иерархическими номерами.

% Chapter 2.
chapterTitle = getChapterTitle("Tables with numbered titles");
append(d,chapterTitle);

% Section 2.1.
sectionTitle = getSectionTitle("Table for Magic(5)");
append(d,sectionTitle);

% Table 2.1.
append(d,getTableTitle("Magic(5)"));
table1 = Table(magic(5));
table1.Style = tableStyle;
table1.TableEntriesStyle = tableEntriesStyle;
append(d,table1);

% Section 2.2.
sectionTitle = getSectionTitle("Tables for Magic(8) and Magic(10)");
append(d,sectionTitle);

% Table 2.2.
append(d,getTableTitle("Magic(8)"));
table2 = Table(magic(8));
table2.Style = tableStyle;
table2.TableEntriesStyle = tableEntriesStyle;
append(d,table2);

% Table 2.3.
append(d,getTableTitle("Magic(10)"));
table3 = Table(magic(10));
table3.Style = tableStyle;
table3.TableEntriesStyle = tableEntriesStyle;
append(d,table3);

Закройте и просмотрите документ.

close(d);
rptview(d);

Следующая функция возвращает нумерованный заголовок главы. Нумерованный заголовок создается с помощью DOM Heading1 объект, где содержимое заголовка префиксируется строкой Chapter N и период, где N является chapter счетчик потоков. Например, заголовок первой главы содержит префикс «Глава 1». CounterInc формат в Style свойство вызывает chapter счетчик потока, который будет увеличиваться при добавлении к документу заголовка этой главы. CounterReset формат в Style свойство вызывает другие связанные счетчики потоков, такие как, section, figure, и table, сбрасываются до их начальных значений при добавлении к документу заголовка этой главы.

function chapterTitle = getChapterTitle(content)
    import mlreportgen.dom.*
    
    chapterTitle = Heading1();
    append(chapterTitle,Text("Chapter "));
    append(chapterTitle,AutoNumber("chapter"));
    append(chapterTitle,Text(". "));
    append(chapterTitle,Text(content));
    
    chapterTitle.Style = ...
        { ...
        CounterInc("chapter"), ...
        CounterReset("section figure table"), ...
        WhiteSpace("preserve"), ...
        PageBreakBefore(true), ...
        KeepWithNext(true) ...
        };
end

Следующая функция возвращает иерархический нумерованный заголовок для раздела, который находится в главе. Иерархический пронумерованный заголовок создается с помощью DOM. Heading2 объект, где содержимое заголовка префиксируется строкой «N.M.», где N и M - chapter и section счетчики потоков соответственно. Например, заголовок первого раздела во второй главе содержит префикс «2.1». CounterInc формат в Style свойство вызывает section счетчик потока, который будет увеличиваться при добавлении этого заголовка раздела к документу.

function sectionTitle = getSectionTitle(content)
    import mlreportgen.dom.*
    
    sectionTitle = Heading2();
    append(sectionTitle,AutoNumber("chapter"));
    append(sectionTitle,Text("."));
    append(sectionTitle,AutoNumber("section"));
    append(sectionTitle,Text(". "));
    append(sectionTitle,Text(content));
    
    sectionTitle.Style = ...
        { ...
        CounterInc("section"), ...
        WhiteSpace("preserve"), ...
        KeepWithNext(true) ...
        };
end

Следующая функция возвращает иерархическую нумерованную подпись для фигуры, добавленной к главе или подразделу в главе. Иерархический нумерованный заголовок создается с помощью DOM Paragraph объект, где содержимое подписи префиксируется строкой «Рисунок N.F»., где N и F - chapter и figure счетчики потоков соответственно. Например, подпись для третьего рисунка во второй главе содержит префикс «Рисунок 2.3». CounterInc формат в Style свойство вызывает figure счетчик потока, который будет увеличиваться при добавлении этой подписи к документу.

function figureCaption = getFigureCaption(content)
    import mlreportgen.dom.*
    
    figureCaption = Paragraph();
    append(figureCaption,Text("Figure "));
    append(figureCaption,AutoNumber("chapter"));
    append(figureCaption,Text("."));
    append(figureCaption,AutoNumber("figure"));
    append(figureCaption,Text(". "));
    append(figureCaption,Text(content));
    
    keepWithPrevious = FOProperty("keep-with-previous.within-page","always");
    figureCaption.Style = ...
        { ...
        CounterInc("figure"), ...
        WhiteSpace("preserve"), ...
        FOProperties(keepWithPrevious) ...
        };
end

Следующая функция возвращает иерархический нумерованный заголовок для таблицы, добавленной к главе или подразделу в главе. Иерархический пронумерованный заголовок создается с помощью DOM. Paragraph объект, где содержимое заголовка префиксируется строкой «Table N.T»., где N и T являются chapter и table счетчики потоков соответственно. Например, заголовок третьей таблицы во второй главе содержит префикс «Таблица 2.3». CounterInc формат в Style свойство вызывает table счетчик потока, который будет увеличиваться при добавлении этого заголовка таблицы к документу.

function tableTitle = getTableTitle(content)
    import mlreportgen.dom.*
    
    tableTitle = Paragraph();
    append(tableTitle,Text("Table "));
    append(tableTitle,AutoNumber("chapter"));
    append(tableTitle,Text("."));
    append(tableTitle,AutoNumber("table"));
    append(tableTitle,Text(". "));
    append(tableTitle,Text(content));
    
    tableTitle.Style = ...
        { ...
        CounterInc("table"), ...
        WhiteSpace("preserve"), ...
        KeepWithNext(true), ...
        Bold(true), ...
        OuterMargin("0pt", "0pt", "10pt", "5pt") ...
        };
end