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

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

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

import mlreportgen.dom.*

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

d = Document("mydoc","pdf");
открытый (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 нумерация потоков для создания иерархической подписи пронумерованного рисунка. The 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 function, заданная позже в этом примере. Эта функция использует оба 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». The CounterInc формат в Style свойство вызывает chapter потоковый счетчик, который будет увеличен при добавлении этого заголовка главы к документу. The 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». The 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 объект, где содержимое подписи префиксируется строкой «Figure N.F»., где N и F являются chapter и figure счетчики потоков, соответственно. Например, подпись для третьего рисунка во второй главе содержит в качестве префикса « Фигуры. 2.3». The 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 объект, где содержимое заголовка префиксируется строкой «Таблица N.T»., где N и T являются ли chapter и table счетчики потоков, соответственно. Для примера заголовок третьей таблицы во второй главе содержит в качестве префикса «таблицу 2.3». The 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