Add description key and description processing to sources tab

owid · Oct 12, 2023 · 4d78105 · 4d78105
1 parent e41354f
commit 4d78105
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 0 deletions.
diff --git a/packages/@ourworldindata/core-table/src/CoreColumnDef.ts b/packages/@ourworldindata/core-table/src/CoreColumnDef.ts
@@ -67,6 +67,8 @@ export interface CoreColumnDef extends ColumnColorScale {
     attributionShort?: string // The Metadata V2 title disambiguation fragment for the producer
     description?: string
     descriptionShort?: string
+    descriptionProcessing?: string
+    descriptionKey?: string[]
     descriptionFromProducer?: string
     note?: string // Any internal notes the author wants to record for display in admin interfaces
 

diff --git a/packages/@ourworldindata/grapher/src/core/LegacyToOwidTable.ts b/packages/@ourworldindata/grapher/src/core/LegacyToOwidTable.ts
@@ -555,6 +555,8 @@ const columnDefFromOwidVariable = (
         datasetId,
         datasetName,
         descriptionShort,
+        descriptionProcessing,
+        descriptionKey,
         descriptionFromProducer,
         source,
         origins,
@@ -578,6 +580,8 @@ const columnDefFromOwidVariable = (
         shortUnit,
         description,
         descriptionShort,
+        descriptionProcessing,
+        descriptionKey,
         descriptionFromProducer,
         coverage,
         datasetId,

diff --git a/packages/@ourworldindata/grapher/src/sourcesTab/SourcesTab.tsx b/packages/@ourworldindata/grapher/src/sourcesTab/SourcesTab.tsx
@@ -139,6 +139,49 @@ export class SourcesTab extends React.Component<{
                                 </td>
                             </tr>
                         ) : null}
+                        {column.def.descriptionKey &&
+                        column.def.descriptionKey.length === 1 ? (
+                            <tr>
+                                <td>Key information</td>
+                                <td>
+                                    <MarkdownTextWrap
+                                        text={column.def.descriptionKey[0]}
+                                        fontSize={12}
+                                    />
+                                </td>
+                            </tr>
+                        ) : null}
+                        {column.def.descriptionKey &&
+                        column.def.descriptionKey.length > 1 ? (
+                            <tr>
+                                <td>Key information</td>
+                                <td>
+                                    <ul>
+                                        {column.def.descriptionKey.map(
+                                            (info: string, index: number) => (
+                                                <li key={index}>
+                                                    <MarkdownTextWrap
+                                                        text={info}
+                                                        fontSize={12}
+                                                    />
+                                                </li>
+                                            )
+                                        )}
+                                    </ul>
+                                </td>
+                            </tr>
+                        ) : null}
+                        {column.def.descriptionProcessing ? (
+                            <tr>
+                                <td>Processing notes</td>
+                                <td>
+                                    <MarkdownTextWrap
+                                        text={column.def.descriptionProcessing}
+                                        fontSize={12}
+                                    />
+                                </td>
+                            </tr>
+                        ) : null}
                         {coverage ? (
                             <tr>
                                 <td>Variable geographic coverage</td>