Skip to content

User Guide for Generating User‐Defined Templates in DataPLAN Tool

Jump to bottom
Xiao-Ran Zhou edited this page Jan 7, 2025 · 6 revisions

Introduction

This guide explains how to create user-defined templates in the DataPLAN tool, focusing on using the User-defined template editor. It provides steps for editing templates directly within the tool and saving the final version.

1. Setting Up a User-Defined Template

  1. Navigate to the Templates tab in the DataPLAN tool.
  2. Select User-defined template from the navigation bar.
  3. Click the dotted box to start editing your template (see example interface below).

image

  1. Use the buttons for pre-defined templates (e.g., H2020 DMP, Horizon Europe DMP) if you want to reuse content.
  2. After editing, click the Finished Editing button to save and use the template.

2. Placeholders in DataPLAN Templates

General Placeholder Reference Table

Placeholder Description Example Value
$_PROJECTNAME Name of the project "My Research Project"
$_STUDYOBJECT Main subject or focus of the study "Climate Impact on Crops"
$_PROJECTAIM Objective or aim of the project "Analyzing soil moisture dynamics"
$_DMPVERSION Version number of the Data Management Plan "1.0"
$_USERNAME Name of the user creating the template "John Doe"
$_EMAIL Contact email address "johndoe@example.com"
$_FUNDINGPROGRAMME Funding program or action number "Horizon 2020"
$_CREATIONDATE Date the template was created "2024-01-06"
$_MODIFICATIONDATE Date the template was last modified "2024-01-06"
$_UPDATEMONTH Month in which updates will occur "June"
$_PREVIOUSPROJECTS Reference to previous related projects "Soil Quality Analysis 2023"
$_DATAUTILITY Explanation of data utility for stakeholders "Useful for policymakers"
$_RAWDATA Size or type of raw data "500 GB"
$_DERIVEDDATA Size or type of derived data "100 GB"

Conditional Placeholder Reference Table

Placeholder Conditional Behavior
#if$_EU ... #endif$_EU Shows the content between #if$_EU and #endif$_EU if the checkbox is selected.
#if!$_ACRONYM ... #endif!$_ACRONYM Displays the content between #if!$_ACRONYM and #endif!$_ACRONYM if the checkbox is NOT selected.
#if$_UPDATE ... #endif!$_UPDATE Displays content between #if$_UPDATE and #endif$_UPDATE if the checkbox is selected.
#if$_PROTECT ... #endif!$_PROTECT Shows content related to data protection between #if$_PROTECT and #endif$_PROTECT.
#if$_DATAPLANT ... #endif!$_DATAPLANT Displays references to DataPLANT standards if the checkbox is selected.

Mechanism of Placeholders

  1. Simple Placeholder ($_PLACEHOLDER): Replaced directly by user input provided in the tool.
    • Example: $_PROJECTNAME → "My Research Project"
  2. Conditional Placeholder (#if$_PLACEHOLDER and #if!$_PLACEHOLDER):
    • #if$_PLACEHOLDER abc #endif$_PLACEHOLDER: Includes abc only if the corresponding checkbox is selected.
    • #if!$_PLACEHOLDER abc #endif!$_PLACEHOLDER: Hides abc if the checkbox is selected.

3. Exporting and Importing User-Defined Templates

Exporting Templates

Exporting a user-defined template follows the same steps as exporting a normal template:

  1. Go to the Export menu in the navigation bar.
  2. Select the desired export format (e.g., JSON).
  3. Save the file to your local storage.

Importing Templates

  1. Go to the Import menu in the navigation bar.
  2. Select the template file you want to import.
  3. If the imported template includes a templatetext, the system will compare it with the current cache.
  4. Choose All cache overwrite to import and overwrite the existing cache.
  5. The imported template will then be available in the User-defined template section for further editing.

4. Conclusion

This guide provides a quick approach to customizing user-defined templates in the DataPLAN tool. Use the interface to modify and save your template without editing JSON files. Always test your template before finalizing to ensure proper rendering of dynamic content.

Clone this wiki locally