Office-stamper

https://office-stamper.verron.pro
Admin
Office-stamper is a Java template engine that allows for dynamic creation of DOCX documents at...
Tokens:778,490
Snippets:5,889
Trust Score:5
Update:1 day ago
Show doc for...
Tokens:
Raw
### Build from source with Maven

Source: https://office-stamper.verron.pro/cli/getting-started.html

Clones the office-stamper repository and runs mvn install to build and install the project locally.

```bash
git clone https://github.com/verronpro/office-stamper.git
cd office-stamper
mvn install
```

--------------------------------

### var configuration = raw();

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.preset/OfficeStamperConfigurations.java.html

Initializes a configuration from raw().

```java
        var configuration = raw();
```

--------------------------------

### Conditional for expression at start of run

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Starts the conditional block for when the expression is at the start of the run.

```java
            } else if (expressionAtStartOfRun) {
```

--------------------------------

### Create a standard configuration with a custom resolver

Source: https://office-stamper.verron.pro/cli/

Shows how to create a configuration using the standard() preset and add a custom resolver. The standard preset is recommended and adds common comment processors (repeat, displayIf, replaceWith) and date/time formatting.

```java
var configuration = OfficeStamperConfigurations.standard()
    .addResolver(new MyCustomResolver());
```

--------------------------------

### findComment: get parts

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Gets the parts of the document.

```java
        var parts = document.getParts();
```

--------------------------------

### Create a stamper with standard configuration

Source: https://office-stamper.verron.pro/engine/presets.html

Shows how to create a configuration using OfficeStamperConfigurations.standard() and then create a stamper with OfficeStampers.docxStamper(configuration).

```javascript
// Create a configuration with standard settings
var configuration = OfficeStamperConfigurations.standard();

// Create a stamper with the custom configuration
var stamper = OfficeStampers.docxStamper(configuration);
```

--------------------------------

### findComment: get comments

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Gets the Comments object from the CommentsPart.

```java
        var comments = getComments(wordComments);
```

--------------------------------

### Customize or disable preprocessors in configuration

Source: https://office-stamper.verron.pro/engine/how-does-it-works.html

Shows how to start from raw or standard configuration and add or remove preprocessors. The raw configuration gives full control, while the standard config lists preprocessors that can be tweaked.

```java
// Start from the raw configuration and add only what you need
var cfg = OfficeStamperConfigurations.raw();
cfg.addPreprocessor(Preprocessors.preparePlaceholders("${}", "placeholder"));

// Or tweak the standard config by adding/removing preprocessors
var std = OfficeStamperConfigurations.standard();
// ...std.getPreprocessors() lists them; you can start from raw if you need full control.
```

--------------------------------

### findComment: get comments part

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Gets the CommentsPart from the parts.

```java
        var wordComments = (CommentsPart) parts.get(name);
```

--------------------------------

### Replace content between start and end elements

Source: https://office-stamper.verron.pro/engine/jacoco/pro.verron.officestamper.core/StandardParagraph.java.html

Replaces the content between two specified elements in the paragraph. Throws OfficeStamperException if the start or end element is not found, or if the start is after the end.

```java
@Override
public void replace(Object start, Object end, Insert insert) {
    var content = contents.getContent();
    var fromIndex = content.indexOf(start);
    var toIndex = content.indexOf(end);
    if (fromIndex < 0) {
        var msg = "The start element (%s) is not in the paragraph (%s)";
        throw new OfficeStamperException(msg.formatted(start, this));
    }
    if (toIndex < 0) {
        var msg = "The end element (%s) is not in the paragraph (%s)";
        throw new OfficeStamperException(msg.formatted(end, this));
    }
    if (fromIndex > toIndex) {
        var msg = "The start element (%s) is after the end element (%s)";
        throw new OfficeStamperException(msg.formatted(end, this));
    }
    var expression = extractExpression(start, end);
    WmlUtils.replaceExpressionWithRun(() -> p.subList(fromIndex, toIndex),
            expression,
            insert.elements(),
            insert::setRPr
    );
}
```

--------------------------------

### raw method configuration setup

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.preset/OfficeStamperConfigurations.java.html

Creates a basic OfficeStamperConfiguration with default factory and exception resolver, and sets SpEL security mode based on system property 'officestamper.spel.mode'. Mutations: negated conditional on spelPermissive, with outcomes NO_COVERAGE, KILLED, and RUN_ERROR.

```java
    /// Creates a [OfficeStamperConfiguration] instance without any configuration or resolvers, processors,
    /// preprocessors or postprocessors applied.
    ///
    /// @return a basic [OfficeStamperConfiguration] instance with no extra configurations
    public static OfficeStamperConfiguration raw() {
        var defaultFactory = EvaluationContextFactories.defaultFactory();
        var defaultExceptionResolver = ExceptionResolvers.throwing();
        var configuration = new DocxStamperConfiguration(defaultFactory, defaultExceptionResolver);
        // Honor system property: officestamper.spel.mode = restricted|permissive (default: restricted)
        var spelModeProp = System.getProperty("officestamper.spel.mode");
        var spelPermissive = spelModeProp != null && spelModeProp.equalsIgnoreCase("permissive");
        configuration.setSpelSecurityMode(spelPermissive ? SecurityMode.PERMISSIVE : SecurityMode.RESTRICTED);
        if (spelPermissive) {
            configuration.setEvaluationContextFactory(EvaluationContextFactories.noopFactory());
        }
    }
```

--------------------------------

### Minimal end-to-end stamping example

Source: https://office-stamper.verron.pro/engine/how-does-it-works.html

Shows configuration with a comment processor and resolver, then stamping a template with a model to an output stream.

```java
var cfg = standard()
    .addCommentProcessor(HideIfProcessor.class, HideIfProcessor::new)
    .addResolver(new MoneyResolver());

new DocxStamper(cfg).stamp(templateInputStream, model, outputStream);
```

```text
${hideParagraphIf(order.total == 0)}
${order.total}
```

--------------------------------

### removeExpression: comment and loop start

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Lines 373-374: comment and start of for loop in removeExpression.

```java
        // remove all runs between first and last
        for (StandardRun run : affectedRuns) {
```

--------------------------------

### Example template with placeholders

Source: https://office-stamper.verron.pro/engine/getting-started.html

A plain .docx template using expressions like ${customer.name} for dynamic content.

```text
Dear ${customer.name},

Thank you for your order #${order.id} placed on ${order.date}.

Your order details:
${order.description}

Total amount: $${order.amount}

Sincerely,
${company.name}
```

--------------------------------

### Check if expression at start of run

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Checks whether the expression starts at the beginning of the run.

```java
            boolean expressionAtStartOfRun = startIndex == firstRun.startIndex();
```

--------------------------------

### Get underlying run object

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Gets the underlying run object from the first affected run.

```java
        var firstR = firstRun.run();
```

--------------------------------

### OfficeStamperConfigurations.standard()

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/class-use/OfficeStamperConfiguration.html

Creates a standard OfficeStamperConfiguration instance with predefined settings.

```APIDOC
## OfficeStamperConfigurations.standard()

### Description
Creates a standard OfficeStamperConfiguration instance with predefined settings.

### Method
static OfficeStamperConfiguration standard()

### Returns
OfficeStamperConfiguration - a standard configuration instance
```

--------------------------------

### Preview.java - picocli subcommand to generate preview image from AsciiDoc

Source: https://office-stamper.verron.pro/cli/jacoco/pro.verron.officestamper/Preview.java.html

This is the complete source code for the Preview class. It defines a picocli command with options for input (-i/--input), output (-o/--output), theme (--theme), DPI (--dpi), and format (--format). The run() method reads the input file, converts it to an AsciiDoc model, injects the theme attribute, and then writes the output as SVG or PNG. The format is auto-detected from the output file extension if not specified. Throws RuntimeException on IOException.

```java
package pro.verron.officestamper;

import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
import pro.verron.asciidoc.compiler.AsciiDocCompiler;
import pro.verron.asciidoc.core.AsciiDocModel;

import java.awt.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

import static java.nio.file.Files.writeString;
import static pro.verron.asciidoc.compiler.AsciiDocCompiler.saveSvgAsImage;

/// Subcommand that generates a preview image from an AsciiDoc file.
@Command(
        name = "preview", description = "Generate a preview image from an AsciiDoc" + " file"
)
public class Preview implements Runnable {

    @Option(
            names = {"-i", "--input"}, required = true, description = "Input AsciiDoc file"
    )
    private Path input;

    @Option(
            names = {"-o", "--output"}, defaultValue = "preview.png", description = "Output file (PNG or SVG)"
    )
    private Path output;

    @Option(
            names = "--theme", defaultValue = "word", description = "Theme: word, gdocs, libre"
    )
    private String theme;

    @Option(
            names = "--dpi", defaultValue = "96", description = "DPI for PNG output"
    )
    private int dpi;

    @Option(
            names = "--format", description = "Output format: png, svg (auto-detected if omitted)"
    )
    private String format;

    /// Default constructor.
    public Preview() {
    }

    @Override
    public void run() {
        try {
            String asciidoc = Files.readString(input);
            var model = AsciiDocCompiler.toModel(asciidoc);

            // Inject theme attribute into model
            var attributes = new java.util.HashMap<>(model.getAttributes());
            attributes.put("theme", theme);
            model = AsciiDocModel.of(attributes, model.getBlocks());

            String formatToUse;
            if (format != null) formatToUse = format;
            else formatToUse = output.endsWith(".svg") ? "svg" : "png";

            var svg = AsciiDocCompiler.toSvg(model);

            switch (formatToUse) {
                case "svg" -> writeString(output, svg);
                case "png" -> saveSvgAsImage(svg, output, dpi, Color.WHITE);
                default -> throw new IllegalArgumentException("Unsupported format: " + formatToUse);
            }

        } catch (IOException e) {
            throw new RuntimeException("Failed to generate preview", e);
        }
    }
}
```

--------------------------------

### RepeatProcessor.java: get or create PPr

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.preset.processors.repeat/RepeatProcessor.java.html

Line 136 of RepeatProcessor.java. Gets the existing PPr or creates a new one if absent.

```java
        PPr nextPPr = ofNullable(paragraph.getPPr()).orElseGet(WmlFactory::newPPr);

```

--------------------------------

### PlaceholderHooker.java - scan method: Javadoc

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.api/PlaceholderHooker.java.html

Javadoc comment for the scan method, which scans a placeholder starting at `start`, balancing nested braces.

```java
    /// Scans a placeholder starting at `start`, balancing nested braces.
```

--------------------------------

### raw() method: Creates a basic OfficeStamperConfiguration with security modes

Source: https://office-stamper.verron.pro/engine/jacoco/pro.verron.officestamper.preset/OfficeStamperConfigurations.java.html

This method returns a basic OfficeStamperConfiguration with no extra configurations. It sets SpEL and SVG security modes based on system properties `officestamper.spel.mode` and `officestamper.svg.mode`, defaulting to restricted. If SpEL mode is permissive, it uses a noop evaluation context factory.

```java
public static OfficeStamperConfiguration raw() {
    var defaultFactory = EvaluationContextFactories.defaultFactory();
    var defaultExceptionResolver = ExceptionResolvers.throwing();
    var configuration = new DocxStamperConfiguration(defaultFactory, defaultExceptionResolver);
    // Honor system property: officestamper.spel.mode = restricted|permissive (default: restricted)
    var spelModeProp = System.getProperty("officestamper.spel.mode");
    var spelPermissive = spelModeProp != null && spelModeProp.equalsIgnoreCase("permissive");
    configuration.setSpelSecurityMode(spelPermissive ? SecurityMode.PERMISSIVE : SecurityMode.RESTRICTED);
    if (spelPermissive) {
        configuration.setEvaluationContextFactory(EvaluationContextFactories.noopFactory());
    }
    // Honor system property: officestamper.svg.mode = restricted|permissive (default: restricted)
    var svgModeProp = System.getProperty("officestamper.svg.mode");
    configuration.setSvgSecurityMode(svgModeProp != null && svgModeProp.equalsIgnoreCase("permissive")
            ? SecurityMode.PERMISSIVE
            : SecurityMode.RESTRICTED);
    return configuration;
}
```

--------------------------------

### Main.java - Office Stamper CLI entry point

Source: https://office-stamper.verron.pro/cli/jacoco/pro.verron.officestamper/Main.java.html

Defines the main command class for the Office Stamper CLI using picocli. It sets the command name to 'officestamper', enables standard help options, and declares subcommands: Stamp, Preview, ReportView, and Diagnostic. The main method creates a CommandLine instance and executes the CLI, exiting with the resulting exit code.

```java
package pro.verron.officestamper;


import picocli.CommandLine;
import picocli.CommandLine.Command;

/// Main class for the CLI.
@Command(
        name = "officestamper",
        mixinStandardHelpOptions = true,
        description = "Office Stamper CLI tool",
        subcommands = {Stamp.class, Preview.class, ReportView.class, Diagnostic.class}
)
public class Main {
    void main(String[] args) {
        var main = new Main();
        var cli = new CommandLine(main);
        int exitCode = cli.execute(args);
        System.exit(exitCode);
    }
}
```

--------------------------------

### replace(Object start, Object end, Insert insert)

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/Paragraph.html

Replaces a section of elements within the document, defined by the start and end objects, with the elements provided by the given insert.

```APIDOC
## replace(Object start, Object end, Insert insert)

### Description
Replaces a section of elements within the document, defined by the start and end objects, with the elements provided by the given insert.

### Method
replace

### Parameters
- **start** (Object) - Required - The starting object marking the beginning of the section to replace.
- **end** (Object) - Required - The ending object marking the end of the section to replace.
- **insert** (Insert) - Required - The insert containing the elements that will replace the specified section.

### Returns
void
```

--------------------------------

### create: method documentation and signature

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Documentation and signature of the create method.

```java
    /// Creates a new run with the specified text and the specified run style.
```

```java
    ///
```

```java
    /// @param text the initial text of the [R].
```

```java
    /// @param rPr  the [RPr] to apply to the run
```

```java
    /// @return the newly created [R].
```

```java
    public static R create(String text, RPr rPr) {
```

```java
        R newStartRun = newRun(text);
```

--------------------------------

### localize() method

Source: https://office-stamper.verron.pro/utils/jacoco/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Converts a global index to a local index within the context of this run. Returns 0 if the global index is before the run's start, length() if after the end, otherwise the offset from the start.

```java
private int localize(int globalIndex) {
    if (globalIndex < startIndex) return 0;
    else if (globalIndex > endIndex()) return length();
    else return globalIndex - startIndex;
}
```

--------------------------------

### Main()

Source: https://office-stamper.verron.pro/cli/apidocs/index-all.html

Constructor for the Main class, which serves as the entry point for the Office Stamper CLI.

```APIDOC
## Main()

### Description
Constructor for the Main class, which serves as the entry point for the Office Stamper CLI.

### Method
Constructor

### Class
pro.verron.officestamper.Main

### Usage
Instantiate the Main class to start the CLI application.
```

--------------------------------

### StandardRun.right() method

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Extracts a substring of the run's text starting from the localized index of the specified global start index to the end of the text. Mutation testing shows a mutation replacing the return value with an empty string, marked as NO_COVERAGE.

```java
        public String right(int globalStartIndex) {
            return getText().substring(localize(globalStartIndex));
        }
```

--------------------------------

### show()

Source: https://office-stamper.verron.pro/engine/testapidocs/pro.verron.officestamper.test/pro/verron/officestamper/test/utils/MapContextFactory.html

Creates a show context.

```APIDOC
## show()

### Description
Creates a show context.

### Method
show

### Signature
`public Object show()`

### Returns
- `Object` - The created show context.

```

--------------------------------

### getSpelSecurityMode()

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/OfficeStamperConfiguration.html

Gets the current SpEL security mode.

```APIDOC
## getSpelSecurityMode()

### Description
Gets the current SpEL security mode.

### Method
GET

### Endpoint
OfficeStamperConfiguration.getSpelSecurityMode()

### Parameters
None

### Response
#### Success Response
- **Return Type**: SecurityMode

#### Response Example
```java
SecurityMode mode = config.getSpelSecurityMode();
```
```

--------------------------------

### OfficeStamperConfigurations.java - full() method

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.preset/OfficeStamperConfigurations.java.html

Creates a full OfficeStamperConfiguration by starting with the standard configuration and adding preprocessors to remove language proof markings, remove language information, and merge similar text runs. The method is documented to include postprocessors for removing orphaned footnotes and endnotes, though the code for those is not shown.

```java
/// Creates a full [OfficeStamperConfiguration] with standard configurations, supplemented with additional pre- and
/// post-processors for enhanced document handling.
///
/// This configuration includes preprocessors to:
/// - Remove language proof markings.
/// - Remove language information.
/// - Merge similar text runs.
///
/// It also includes postprocessors to:
/// - Remove orphaned footnotes.
/// - Remove orphaned endnotes.
///
/// @return a fully configured [OfficeStamperConfiguration] instance with the additional processors applied.
public static OfficeStamperConfiguration full() {
    var configuration = standard();

    configuration.addPreprocessor(Preprocessors.removeLanguageProof());
    configuration.addPreprocessor(Preprocessors.removeLanguageInfo());
    configuration.addPreprocessor(Preprocessors.mergeSimilarRuns());
}
```

--------------------------------

### ReplaceWithProcessor.java - Full class implementation

Source: https://office-stamper.verron.pro/engine/jacoco/pro.verron.officestamper.preset.processors.replacewith/ReplaceWithProcessor.java.html

The complete source code for the ReplaceWithProcessor class. It replaces the content between the comment start tag and comment range end with the provided expression. Throws OfficeStamperException if the expression is null or if the comment range start or end is null.

```java
package pro.verron.officestamper.preset.processors.replacewith;

import org.jspecify.annotations.Nullable;
import pro.verron.officestamper.api.CommentProcessor;
import pro.verron.officestamper.api.Insert;
import pro.verron.officestamper.api.OfficeStamperException;
import pro.verron.officestamper.api.ProcessorContext;
import pro.verron.officestamper.preset.CommentProcessorFactory;

import static pro.verron.officestamper.utils.wml.WmlFactory.newRun;

/// Processor that replaces the current run with the provided expression. This is useful for replacing an expression in
/// a comment with the result of the expression.
///
/// @author Joseph Verron
/// @author Tom Hombergs
/// @since 1.0.7
public class ReplaceWithProcessor
        extends CommentProcessor
        implements CommentProcessorFactory.IReplaceWithProcessor {

    /// Constructs a new [ReplaceWithProcessor] instance.
    ///
    /// @param processorContext the context in which this processor operates, providing access to document
    ///         manipulation and expression evaluation utilities.
    public ReplaceWithProcessor(ProcessorContext processorContext) {
        super(processorContext);
    }

    /// Replaces the content between the start and end of the comment with the given expression.
    ///
    /// @param expression The expression to replace the content with. Must not be null.
    /// @throws OfficeStamperException if the expression is null, or if the comment range start or end is null.
    @Override
    public void replaceWith(@Nullable String expression) {
        if (expression == null) throw new OfficeStamperException("Cannot replace with null expression");
        var from = comment().getStartTagRun();
        var to = comment().getCommentRangeEnd();
        paragraph().replace(from, to, new Insert(newRun(expression)));
    }
}
```

--------------------------------

### Create a configuration from standard preset

Source: https://office-stamper.verron.pro/engine/how-does-it-works.html

Creates a configuration using the standard preset and sets a custom evaluation context factory. Requires static imports for standard() and defaultFactory().

```java
import static pro.verron.officestamper.preset.OfficeStamperConfigurations.standard;
import static pro.verron.officestamper.preset.EvaluationContextFactories.defaultFactory;

var cfg = standard()
    .setEvaluationContextFactory(defaultFactory());
```

--------------------------------

### findComment: Javadoc start

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Javadoc comment for the findComment method.

```java
    /// Finds a comment with the given ID in the specified
```

--------------------------------

### extractCommentElements: Javadoc start

Source: https://office-stamper.verron.pro/utils/pit-reports/pro.verron.officestamper.utils.wml/WmlUtils.java.html

Javadoc comment for the extractCommentElements method.

```java
    /// Extracts a list of comment elements from the specified
```

--------------------------------

### OfficeStamperConfigurations.minimal()

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/class-use/OfficeStamperConfiguration.html

Creates a minimal OfficeStamperConfiguration.

```APIDOC
## OfficeStamperConfigurations.minimal()

### Description
Creates a minimal OfficeStamperConfiguration.

### Method
minimal

### Signature
`static OfficeStamperConfiguration minimal()`

### Returns
- **OfficeStamperConfiguration** - A minimal configuration instance.

```

--------------------------------

### While loop over hooks

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.core/DocxStamper.java.html

Starts a while loop that continues while the iterator has more elements.

```java
while (iterator.hasNext()) {
```

--------------------------------

### OfficeStamperConfigurations.full()

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/class-use/OfficeStamperConfiguration.html

Creates a full OfficeStamperConfiguration with standard configurations, supplemented with additional pre- and post-processors for enhanced document handling.

```APIDOC
## OfficeStamperConfigurations.full()

### Description
Creates a full OfficeStamperConfiguration with standard configurations, supplemented with additional pre- and post-processors for enhanced document handling.

### Method
full

### Signature
`static OfficeStamperConfiguration full()`

### Returns
- **OfficeStamperConfiguration** - A full configuration instance.

```

--------------------------------

### Register preprocessors in OfficeStamperConfigurations.minimal()

Source: https://office-stamper.verron.pro/engine/how-does-it-works.html

Shows how to register the placeholder preprocessors and the comment processor in the minimal configuration. The placeholders use opening delimiters "${" and "#{" with types "placeholder" and "inlineProcessor" respectively.

```java
// In OfficeStamperConfigurations.minimal():
configuration.addPreprocessor(Preprocessors.preparePlaceholders("${", "placeholder"));
configuration.addPreprocessor(Preprocessors.preparePlaceholders("#{", "inlineProcessor"));
configuration.addPreprocessor(Preprocessors.prepareCommentProcessor());
```

--------------------------------

### getStartTagRun()

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/Comment.html

Retrieves the CTSmartTagRun object associated with the start of this comment.

```APIDOC
## getStartTagRun()

### Description
Retrieves the CTSmartTagRun object associated with the start of this comment.

### Method
`org.docx4j.wml.CTSmartTagRun getStartTagRun()`

### Returns
- **CTSmartTagRun** - the CTSmartTagRun object representing the start tag run of the comment
```

--------------------------------

### OfficeStamperConfigurations.raw()

Source: https://office-stamper.verron.pro/engine/apidocs/pro.verron.officestamper/pro/verron/officestamper/api/class-use/OfficeStamperConfiguration.html

Creates an OfficeStamperConfiguration instance without any configuration or resolvers, processors, preprocessors or postprocessors applied.

```APIDOC
## OfficeStamperConfigurations.raw()

### Description
Creates an OfficeStamperConfiguration instance without any configuration or resolvers, processors, preprocessors or postprocessors applied.

### Method
static OfficeStamperConfiguration raw()

### Returns
OfficeStamperConfiguration - a minimal configuration instance
```

--------------------------------

### Get workbook part in ExcelContext.java

Source: https://office-stamper.verron.pro/excel-context/jacoco/pro.verron.officestamper.excel/ExcelContext.java.html

Returns the WorkbookPart from the spreadsheet.

```java
    private WorkbookPart workbookPart() {
        return spreadsheet.getWorkbookPart();
    }
```

--------------------------------

### minimal() method: Creates a minimal OfficeStamperConfiguration

Source: https://office-stamper.verron.pro/engine/jacoco/pro.verron.officestamper.preset/OfficeStamperConfigurations.java.html

This method returns a minimally configured OfficeStamperConfiguration instance. It adds a fallback resolver with a newline character, preprocessors for placeholders and comments, and postprocessors to remove tags and comments. Use this when you need a basic setup for placeholder processing.

```java
public static OfficeStamperConfiguration minimal() {
    var configuration = raw();
    configuration.addResolver(Resolvers.fallback("\n"));
    configuration.addPreprocessor(Preprocessors.preparePlaceholders("${", "placeholder"));
    configuration.addPreprocessor(Preprocessors.preparePlaceholders("#{", "inlineProcessor"));
    configuration.addPreprocessor(Preprocessors.prepareCommentProcessor());
    configuration.addPostprocessor(Postprocessors.removeTags("officestamper"));
    configuration.addPostprocessor(Postprocessors.removeComments());
    return configuration;
}
```

--------------------------------

### Get next hook

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.core/DocxStamper.java.html

Retrieves the next hook from the iterator.

```java
var hook = iterator.next();
```

--------------------------------

### Preview()

Source: https://office-stamper.verron.pro/cli/apidocs/pro.verron.officestamper.cli/pro/verron/officestamper/Preview.html

Default constructor for the Preview class.

```APIDOC
## Constructor: Preview()

### Description
Default constructor for the Preview class.

### Signature
`public Preview()`

### Parameters
None

### Returns
A new instance of Preview.
```

--------------------------------

### Get footer part

Source: https://office-stamper.verron.pro/engine/pit-reports/pro.verron.officestamper.core/DocxStamper.java.html

Retrieves the Part object from the relationship.

```java
Part part = relationshipsPart.getPart(relationship);
```

--------------------------------

### Get Traceability Reporter

Source: https://office-stamper.verron.pro/engine/jacoco/pro.verron.officestamper.core/DocxStamperConfiguration.java.html

Returns the traceability reporter instance.

```java
    @Override
    public TraceabilityReporter getTraceabilityReporter() {
        return traceabilityReporter;
    }
```

--------------------------------

### run()

Source: https://office-stamper.verron.pro/cli/apidocs/pro.verron.officestamper.cli/pro/verron/officestamper/ReportView.html

Executes the subcommand to generate an HTML viewer for a traceability report. This method is specified by the Runnable interface.

```APIDOC
## run()

### Description
Executes the subcommand to generate an HTML viewer for a traceability report. This method is specified by the Runnable interface.

### Method
Instance method

### Signature
public void run()

### Specified By
run in interface Runnable

```
Tokens:
Raw