feat: added displayData.json file for localization

README.md

@@ -41,6 +41,16 @@ To make the process of customizing from the template as smooth as possible, we r
   - Replace the description with your own description
   - Update ownership information and other relevant fields as desired
 
+- In `contributions/displayData.json`:
+
+  - If your extension has an icon, update the `icon` value to point towards the icon file (for example: `./assets/icon.svg`)
+  - Update the `en` entry so that:
+
+    - `displayName` contains a human-readable name for your extension (i.e. `Your Extension Name`).
+    - `shortSummary` contains a short, few sentence summary of what your extension does.
+    - `description` points to a Markdown (`.md`) file containing the full description of your extension (similar to what you would put in a `README`).
+  - If your extension supports multiple languages, copy and paste the `en` entry, changing `en` to the [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the language you want to support, and translate the `displayName`, `shortSummary`, and `description` fields appropriately. We recommend naming your description files `description-<language tag>.md`.
+
 - In `LICENSE`:
 
   - Adjust as desired (feel free to choose a different license)
@@ -72,7 +82,9 @@ The general file structure is as follows:
   - `*.web-view.tsx` files will be treated as React WebViews
   - `*.web-view.html` files are a conventional way to provide HTML WebViews (no special functionality)
 - `assets/` contains asset files the extension and its WebViews can retrieve using the `papi-extension:` protocol. It is copied into the build folder
-- `contributions/` contains JSON files the platform uses to extend data structures for things like menus and settings. The JSON files are referenced from the manifest
+- `contributions/` contains JSON files the platform uses to extend data structures for things like menus, settings, and descriptions. The JSON files are referenced from the manifest
+  - `contributions/displayData.json` contains (optionally) a path to the extension's icon file as well as text for the extension's display name, short summary, and path to the full description file
+  - `contributions/description-<locale>.md` contains a brief description of the extension in the language specified by `<locale>`
 - `public/` contains other static files that are copied into the build folder
 - `dist/` is a generated folder containing the built extension files
 - `release/` is a generated folder containing a zip of the built extension files

contributions/description-en.md

@@ -0,0 +1,3 @@
+Extension template for Paranext. Powered by webpack.
+
+This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs.

contributions/displayData.json

@@ -0,0 +1,8 @@
+{
+  "icon": "",
+  "en": {
+    "displayName": "Paranext Extension Template",
+    "shortSummary": "Base template for a Paranext Extension",
+    "description": "./description-en.md"
+  }
+}

manifest.json

@@ -1,7 +1,7 @@
 {
   "name": "paranext-extension-template",
   "version": "0.0.1",
-  "description": "Extension template for Paranext. Powered by webpack",
+  "displayData": "contributions/displayData.json",
   "author": "Paranext",
   "license": "MIT",
   "main": "src/main.ts",