Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-27796

Create template plugin API for Lander

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Related to DM-26564, which created an API for creating plugins that parse documents, this ticket will create an API for writing template plugins. This allows organizations to customize the appearance of the landing pages.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -
            • Theme plugin API similar to the Parser plugin API. Themes can inherit from each other. Lander comes with a "base" theme that provides with all base infrastructure such as the PDF viewer javascript, as well as the common HTML. Then additional themes can inherit from that theme and customize HTML with Jinja template block inheritance. Themes have two types of "templates". First, they have "site" directories that template the structure of the static website, similar to cookiecutter. Content in the "site" directory are treated as Jinja templates if they end with a .jinja template. Secondly, themes can include Jinja template fragments in a "templates" directory that are included by Jinja templates. Both the "site" and "templates" directories utilize inheritance from base themes.
            • New command-line interface built around typer
            • Configuration built around pydantic. Users can create YAML-formatted configuration files, and these configurations can be overridden by command-line settings.
            Show
            jsick Jonathan Sick added a comment - Theme plugin API similar to the Parser plugin API. Themes can inherit from each other. Lander comes with a "base" theme that provides with all base infrastructure such as the PDF viewer javascript, as well as the common HTML. Then additional themes can inherit from that theme and customize HTML with Jinja template block inheritance. Themes have two types of "templates". First, they have "site" directories that template the structure of the static website, similar to cookiecutter. Content in the "site" directory are treated as Jinja templates if they end with a .jinja template. Secondly, themes can include Jinja template fragments in a "templates" directory that are included by Jinja templates. Both the "site" and "templates" directories utilize inheritance from base themes. New command-line interface built around typer Configuration built around pydantic. Users can create YAML-formatted configuration files, and these configurations can be overridden by command-line settings.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.