github.com/unidoc/unidoc@v2.2.0+incompatible/doc.go (about)

     1  /*
     2   * This file is subject to the terms and conditions defined in
     3   * file 'LICENSE.md', which is part of this source code package.
     4   */
     5  
     6  // UniDoc is a comprehensive PDF library for Go (golang). The library has advanced capabilities for generating,
     7  // processing and modifying PDFs. UniDoc is written and supported by the owners of the
     8  // FoxyUtils.com website, where the library is used to power many of the PDF services offered.
     9  //
    10  // Getting More Information
    11  //
    12  // Check out the Getting Started and Example sections, which showcase how to install UniDoc and provide numerous
    13  // examples of using UniDoc to generate, process or modify PDF files.
    14  // https://unidoc.io/examples/getting_started/
    15  //
    16  // The godoc for unidoc provides a detailed breakdown of the API and documentation for packages, types and methods.
    17  // https://godoc.org/github.com/unidoc/unidoc
    18  //
    19  // Overview of Major Packages
    20  //
    21  // The API is composed of a few major packages:
    22  //
    23  //   - common: Provides common shared types such as Logger and utilities to check
    24  //     license validity.
    25  //
    26  //   - pdf/core: The core package defines the primitive PDF object types and handles
    27  //     the file reading I/O and parsing the primitive objects.
    28  //
    29  //   - pdf/model: The model package builds on the core package, to represent the PDF as
    30  //     a structured model of the PDF primitive types. It has a reader and a writer to
    31  //     read and process a PDF file based on the structured model. This serves as a basis
    32  //     to perform a number of numerous tasks and can be used to work with a PDF in a
    33  //     medium to high level interface, although it does require an understanding of the
    34  //     PDF format and structure.
    35  //
    36  //   - pdf/creator: The PDF creator makes it easy to create new PDFs or modify existing
    37  //     PDFs. It can also enable loading a template PDF, adding text/images and
    38  //     generating an output PDF. It can be used to add text, images, and generate text
    39  //     and graphical reports. It is designed with simplicity in mind, with the goal of
    40  //     making it easy to create reports without needing any knowledge about the PDF
    41  //     format or specifications.
    42  //
    43  //   - pdf/extractor: Package extractor is used for quickly extracting PDF content
    44  //     through a simple interface. Currently offers functionality for extracting textual
    45  //     content.
    46  package unidoc