Merge pull request #71 from brown-ccv/documentation-tables

Documentation tables

package.json

@@ -23,6 +23,7 @@
     "@radix-ui/react-form": "^0.0.3",
     "@radix-ui/react-hover-card": "^1.0.7",
     "@radix-ui/react-icons": "^1.3.0",
+    "@radix-ui/react-switch": "^1.1.0",
     "@staticcms/core": "^4.1.2",
     "@staticcms/proxy-server": "^4.0.4",
     "@types/react": "^18.2.64",

public/admin/config.yml

@@ -137,20 +137,41 @@ collections:
     folder: src/content/data
     media_folder: files
     fields:
+      - name: cat
+        label: Category
+        widget: select
+        options: [ 'Study Design', 'Questionnaire', 'Changes to Questionnaire', 'Codebook', 'Appendices' ]
       - name: title
         label: Title
         widget: string
       - name: description
         label: Description
         widget: text
+      - name: version
+        i18n: duplicate
+        label: Field Season
+        condition:
+          field: cat
+          value: 'Questionnaire'
+        required: false
+      - name: codebookType
+        label: Codebook Category
+        condition:
+          field: cat
+          value: 'Codebook'
+        widget: select
+        options: [ 'MMP Core', 'Community Level Supplementary', 'State Level Supplementary', 'National Level Supplementary', 'MSA Level Supplementary' ]
+      - name: archivo
+        i18n: duplicate
+        required: false
+        label: Spanish File
+        widget: file
       - name: file
         i18n: duplicate
-        label: File
+        required: false
+        label: English File
         widget: file
-      - name: cat
-        label: Category
-        widget: select
-        options: [ 'Study Design', 'Questionnaire', 'Changes to Questionnaire', 'Codebook', 'Appendices' ]
+
   - name: news
     label: News
     identifier_field: pubDate

src/components/DocumentationTable.tsx

@@ -0,0 +1,79 @@
+import React from "react"
+import Button from "./Button.tsx"
+
+interface DocumentationTableProps {
+  allFiles: {
+    data: {
+      title: string
+      cat: string
+      file?: string
+      archivo?: string
+      description?: string
+      version?: string
+      codebookType?: string
+    }
+  }[]
+  version?: boolean
+  showHeader?: boolean
+}
+
+const DocumentationTable: React.FC<DocumentationTableProps> = ({
+  allFiles,
+  version,
+  showHeader,
+}) => {
+  const files = allFiles.map((file) => {
+    return { ...file.data }
+  })
+  return (
+    <div className="w-full overflow-x-scroll no-scrollbar">
+      <table className="table-fixed border-spacing-4 w-full">
+        <thead className={showHeader ? "" : "collapse"}>
+          <tr className="text-xl bg-neutral-100 text-left text-neutral-900">
+            <th className="w-1/4">File</th>
+            <th>Description</th>
+            {version && <th className="w-1/5">Field Season</th>}
+          </tr>
+        </thead>
+
+        <tbody>
+          {files.map(({ title, file, description, version, archivo }, i) => {
+            return (
+              <tr key={i}>
+                <td className="flex justify-between gap-2">
+                  <p className="font-bold">{title}</p>
+                  <div className="flex gap-1">
+                    (
+                    {file && (
+                      <a
+                        className="text-secondary-blue-700 hover:text-secondary-blue-500"
+                        target="_blank"
+                        href={file}
+                      >
+                        en
+                      </a>
+                    )}
+                    {file && archivo && <p>/</p>}
+                    {archivo && (
+                      <a
+                        className="text-secondary-blue-700 hover:text-secondary-blue-500"
+                        target="_blank"
+                        href={archivo}
+                      >
+                        es
+                      </a>
+                    )}
+                    )
+                  </div>
+                </td>
+                <td>{description}</td>
+                {version && <td>{version}</td>}
+              </tr>
+            )
+          })}
+        </tbody>
+      </table>
+    </div>
+  )
+}
+export default DocumentationTable

src/content/config.ts

@@ -20,8 +20,11 @@ const files = defineCollection({
   schema: z.object({
     title: z.string(),
     description: z.string().optional(),
+    version: z.string().optional(),
     cat: z.string(),
-    file: z.string(),
+    codebookType: z.string().optional(),
+    file: z.string().optional(),
+    archivo: z.string().optional(),
   }),
 })
 

src/content/data/appendix-a.md

@@ -0,0 +1,6 @@
+---
+title: Appendix A
+description: Community Survey Year Codes
+file: src/content/data/files/appendix-a-sample-information-mmp174-.pdf
+cat: Appendices
+---

src/content/data/appendix-b.md

@@ -0,0 +1,6 @@
+---
+title: Appendix B
+description: Place Codes in Mexico and the United States
+file: src/content/data/files/appendix-b-places-mmp174-.pdf
+cat: Appendices
+---

src/content/data/appendix-c.md

@@ -0,0 +1,6 @@
+---
+title: Appendix C
+description: State Codes in Mexico and the United States
+file: src/content/data/files/appendix-c-states-mmp174-.pdf
+cat: Appendices
+---

src/content/data/appendix-d.md

@@ -0,0 +1,6 @@
+---
+title: Appendix D
+description: Occupation Codes (English)
+file: src/content/data/files/appendix-d-occupations-mmp174-.pdf
+cat: Appendices
+---

src/content/data/appendix-e.md

@@ -0,0 +1,6 @@
+---
+title: Appendix E
+description: Computation of Total U.S. Experience (English)
+file: src/content/data/files/appendix-e-computation-of-us-experience-mmp174-.pdf
+cat: Appendices
+---

src/content/data/appendix-f.md

@@ -0,0 +1,6 @@
+---
+title: Appendix F
+description: Farm Codes in Canada
+file: src/content/data/files/appendix-f-canadian-farms-mmp174-.pdf
+cat: Appendices
+---

src/content/data/appendix-g.md

@@ -0,0 +1,6 @@
+---
+title: Appendix G
+description: Community Data Inventory (English)
+file: src/content/data/files/comquest1999_eng.pdf
+cat: Appendices
+---

src/content/data/appendix-h.md

@@ -0,0 +1,6 @@
+---
+title: Appendix H
+description: MMP Weights
+file: src/content/data/files/mmp-and-lamp-weights-2012.pdf
+cat: Appendices
+---

src/content/data/cnmig.md

@@ -0,0 +1,9 @@
+---
+title: CNMIG
+description: cross-sectional file containing information of the household-head -
+  or another migrant when the household-head was not a migrant - who has
+  migration experience to Canada.
+file: src/content/data/files/cnmig-codebook-mmp174-.pdf
+cat: Codebook
+codebookType: MMP Core
+---

src/content/data/commun-174.md

@@ -0,0 +1,6 @@
+---
+title: Commun 174
+description: DTA file
+file: src/content/data/files/commun174.dta
+cat: Core
+---

src/content/data/commun.md

@@ -4,4 +4,5 @@ description: community-level file that provides information at the time of the
   survey and it is complemented with other information using the Mexican Census
 file: src/content/data/files/codebook_commun.pdf
 cat: Codebook
+codebookType: Community Level Supplementary
 ---

src/content/data/environs.md

@@ -0,0 +1,7 @@
+---
+title: ENVIRONS
+description: Variable list and specifications
+file: src/content/data/files/environs-codebook-mmp134-.pdf
+cat: Codebook
+codebookType: State Level Supplementary
+---

src/content/data/ethnosurvey-i.md

@@ -0,0 +1,7 @@
+---
+title: Ethnosurvey I
+description: Survey applied to communities interviewed from 1987 to 1997, and in 1982
+version: 1987 - 1997
+archivo: src/content/data/files/mmp-etnoencuesta-versión-1-aplicada-de-1987-a-1997.pdf
+cat: Questionnaire
+---

src/content/data/ethnosurvey-ii.md

@@ -0,0 +1,8 @@
+---
+title: Ethnosurvey II
+description: Survey applied to communities interviewed on 1998 and 1999
+version: 1998 - 1999
+file: src/content/data/files/mmp-ethnosurvey-version-ii-applied-in-1998-and-1999.pdf
+archivo: src/content/data/files/mmp-etnoencuesta-versión-2-aplicada-de-1998-a-1999.pdf
+cat: Questionnaire
+---