ssb-pubmd 0.1.6__tar.gz → 0.1.8__tar.gz

{ssb_pubmd-0.1.6 → ssb_pubmd-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.1.6
+Version: 0.1.8
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk

{ssb_pubmd-0.1.6 → ssb_pubmd-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-pubmd"
-version = "0.1.6"
+version = "0.1.8"
 description = "SSB Pubmd"
 authors = ["Olav Landsverk <stud-oll@ssb.no>"]
 license = "MIT"

{ssb_pubmd-0.1.6 → ssb_pubmd-0.1.8}/ssb_pubmd/adapters/content_parser.py

@@ -92,6 +92,7 @@ class Highchart(MimirContent):
                 "tbprocessor": {"urlOrId": self.tbml},
             }
 
+        s["data"]["graphType"] = self.graph_type
         s["data"]["xAxisTitle"] = self.xlabel
         s["data"]["yAxisTitle"] = self.ylabel
 

{ssb_pubmd-0.1.6 → ssb_pubmd-0.1.8}/ssb_pubmd/templates/template.qmd

@@ -15,22 +15,21 @@ Dette er en SSB-artikkel skrevet med Quarto Markdown.
 
 Neste steg:
 
-1. Sjekk at du er logget inn i CMS-et: {{ cms_admin_url }}/tool/com.enonic.app.contentstudio/main.
+1. Logg deg inn i CMS'et: {{ cms_admin_url }}/tool/com.enonic.app.contentstudio/main.
 
-2. Det er gitt et eksempel på CMS-mappe i feltet `path` ovenfor. Endre denne til CMS-mappen du ønsker å opprette artikkelen i. Dette må være en mappe du har skrivetilgang til.
+2. Endre feltet `path` ovenfor til ønsket CMS-mappe, og sjekk at du har skrivetilgang i mappen.
 
 3. Kjør kommandoen `poetry run ssb-pubmd preview {{ filepath }}`. 
    
-   * Dette vil opprette en draft-artikkel og printe URL'en til en forhåndsvisning av artikkelen. 
-   * Kommandoen fungerer tilsvarende som `quarto preview`, det vil si at forhåndsvisningen holdes oppdatert etter hvert som du endrer og lagrer denne filen.****
-   * Du må oppdatere nettleservinduet for å se endringene.
+   * Dette vil opprette en draft-artikkel og printe en forhåndsvisningslink.
+   * Kommandoen fungerer tilsvarende som `quarto preview`, det vil si at forhåndsvisningen oppdateres når du endrer og lagrer denne filen (du må oppdatere nettleservinduet).****
   
-4. Les seksjonene nedenfor for en kort introduksjon til skriving av SSB-artikler i Quarto Markdown.
+4. Under følger en kort introduksjon til skriving av SSB-artikler med Quarto Markdown.
 
 ## Artikkelmetadata
 
-Metadata-blokken øverst viser all metadata som kan settes for en artikkel.
-Dette er noe begrenset i testversjonen, men vil senere være komplett.
+Metadatablokken øverst viser all metadata som kan settes for en artikkel.
+Dette er noe begrenset i testversjonen, men vil senere være mer komplett.
 Merk at `path` og `title` er obligatoriske felt.
 
 
@@ -50,20 +49,23 @@ Se [Quarto-referansen](https://quarto.org/docs/computations/python.html). Merk a
 
 ## SSB-komponenter
 
-I testversjonen tilbys et begrenset utvalg SSB-komponenter.
+I testversjonen tilbys to SSB-komponenter; highchart og faktaboks.
+Dette vil senere utvides.
 Komponentene opprettes med Python og settes inn med Markdown.
 
 ### Opprette komponenter
 
-Importér Python-pakken:
+Vi importerer først `ssb_pubmd` sammen med andre nødvendige pakker:
 
 ```{python}
 import ssb_pubmd as ssb
+import pandas as pd
 ```
 
-Kodeblokkene nedenfor viser opprettelse av to komponenter; et highchart og en faktaboks:
+(I dette eksempelet brukes `pandas`; sørg for at det er installert med `poetry add pandas`, eller `poetry add "pandas<3"` for eldre Python-versjoner.)
+
+Kodeblokkene nedenfor viser opprettelse av to komponenter:
 ```{python}
-import pandas as pd
 data = {
     "År": [
         2000, 2001, 2002, 2003, 2004,
@@ -97,13 +99,19 @@ ssb.Factbox(
     display_type = "default")
 ```
 
-Dokumentasjon: (link kommer).
-  * For å se alle funksjonene som tilbys, skriv `ssb.` på en kodelinje og tast `Ctrl + Space` (VSCode) eller `Tab` (Jupyterlab).
-  * VSCode: Dokumentasjonen til funksjonen vises automatisk i en popup-boks når man hovrer over funksjonen.
+Dokumentasjon for opprettelse av komponenter:
+
+```{python}
+ssb.Factbox?
+```
 
+```{python}
+ssb.Highchart?
+```
 ### Sette inn komponenter
 
-Når du kjører en av kodeblokkene ovenfor, vil det printes en Markdown-snippet som kan kopieres og limes inn på en ny linje:
+Når du kjører en kodecelle som oppretter en komponent, vil den printe en Markdown-snippet.
+Denne kan kopieres og limes inn i artikkelen:
 
 ::: { #my-highchart .ssb }
 :::
@@ -123,12 +131,12 @@ Ny paragraf.
 
 ## Synkronisering
 
-Etter å ha synkronisert denne filen til CMS'et, vil du se en ekstra fil i Dapla-tjenesten:
+Etter synkronisering har vi følgende mappestruktur: 
 
 ```
 {{ project_folder }}/
-├── {{ filename }}
-├── .ssbno.json
+├── {{ filename }} (denne filen)
+├── .ssbno.json (metadatafil)
 ```
 
 Metadatafilen `.ssbno.json` er automatisk generert og inneholder metadata for den tilhørende CMS-artikkelen. Merk at: