Skip to content

Repository files navigation

DSW Document Template Tool

Shared tooling for transforming, validating, translating, packaging, and preview-rendering DSW document templates.

The current production use case is the Traditional Chinese translation workflow for the Science Europe DMP Template. This repository is infrastructure focused: it provides parser logic, CI helpers, compatibility checks, demo fixtures, and release automation for clean upstream scaffolds.

Current Repository Model

The maintained workflow uses two repositories:

Repository Role
ThreeMonth03/dsw-document-template-tool Tooling, clean scaffold releases, render regression, docs, and helper scripts.
depositar/science-europe-template-zh_Hant Public translated-template repository: operations config, sync/v* branches, and translated release assets.

What This Repository Produces

Output Purpose
Parser, transform, migration, render, and CI helper code Shared infrastructure for document-template translation workflows.
Clean scaffold release assets Versioned upstream-derived workspaces, packages, checksums, and previews published from CI.
Demo project fixtures and matching Knowledge Model bundles Stable inputs for local and CI render previews.
Example workflows and helper scripts Reusable automation templates for the public repository that consumes the clean scaffold assets.

Generated workspaces, generated packages, render outputs, and caches are build artifacts. Keep them out of master unless a file is explicitly a reusable fixture under fixtures/.

First Five Minutes

For a local development sanity check:

make install-dev
make check

For anything beyond that, start from the task map below. The root README is only an entry point; operational detail lives in docs/.

Start Here

If you are new to the project, start with the Documentation Index. For common follow-up tasks:

Task Read
Day-to-day operation Operator Quickstart
Code layout and module ownership Architecture
Parser or translation tree changes Parser and Translation Tree
CI, DSW, render, or release debugging Troubleshooting

Version Support

The tooling supports Science Europe template versions from v1.29.1 upward. The DSW runtime matrix is declared in config/dsw-compat.yml.

On non-PR CI runs, this repository publishes clean scaffold prerelease assets such as clean-scaffold-dsw-science-europe-v1.30.1. These are download buckets for public repository maintenance, not finished translations. Their assets are refreshed by CI. The producing commit is recorded in the release notes and must be used with SHA256SUMS when checking provenance.

License

This repository is distributed under the MIT License.

About

Infrastructure for transforming, validating, packaging, and preview-rendering DSW document templates.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages