Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mögliche Werte für die Ausgabeparameter show und hide #54

Closed
xwolfde opened this issue Jul 10, 2024 · 5 comments
Closed

Mögliche Werte für die Ausgabeparameter show und hide #54

xwolfde opened this issue Jul 10, 2024 · 5 comments
Assignees
Labels
Basisfunktion Umzusetzende Grundfunktionalität Design Issues zum Thema Gestaltung Umsetzungshinweis Hinweise zur Umsetzung (Programmierung oder Design)

Comments

@xwolfde
Copy link
Member

xwolfde commented Jul 10, 2024

Mit den Parametern show und hide in Shortcodes (bzw. mit den Multiselekt-Auswahllisten für die Wert in Blöcken) soll die Ausgabe individualisiert werden.

Als Werte nehmen beiden Parameter folgende Bezeichner an:

  • Alle Feldnamen aus der API, die angezeigt werden
    und
  • "mehrlink" (eigentlich unpassender Wertname aufgrund der Abwärtscompatibiltät, ggf. zusätzlicher Parameterwert "button" einführen und "mehrlink" als Alias darauf setzen) :
    - Ab Version 1 nur funktionabel, wenn auch der Parameter "url" eingegeben mit einer gültigen Zieladresse wurde . Dann wird ein Button erzeugt, der zu der URL verlinkt.
    - A V2 mit Custom Post Types: Der Button wird zu. der CPT Seite verlinkt, wenn keine url="" angegeben ist. Wenn eine url="" angegeben ist, wird diese aber immer bevorzugt gegenüber dem CPT Ziel.
    - Optionaler Zusatzparameter: Ein Parameter button-title="" wird optional nutzbar sein, um den Text des Buttons zu ändern. Ansonsten wird dessen Text aus der Setting genommen: Plugin-Settings V1 #37
  • "bild": Nur ab V2 mit Custom Post Types: Anzeige des Post Type Artikelbilds als Personenbild
  • displayname: Generierter Name vgl Generierung Displayname und akademische Titel #41
  • akademtitel: Generierter akademischer Titel, vgl Generierung Displayname und akademische Titel #41
  • content: Nur ab V2 mit Custom Post Types: Content-Bereich in der jeweiligen Sprache der Website , vgl Deklaration der Sprache des Inhalts des Kontakts #18
  • teasertext: Nur ab V2 mit Custom Post Types: Kurztext-Bereich in der jeweiligen Sprache der Website , vgl Custom-field teasertext  #16
  • adresse: Dieser Parameter besteht aus der Vereinigung der Adressdaten einer Person, die aus der API kommen und aus Daten wie Ort, Strasse, PLZ etc. bestehen
@xwolfde xwolfde added Basisfunktion Umzusetzende Grundfunktionalität Design Issues zum Thema Gestaltung Umsetzungshinweis Hinweise zur Umsetzung (Programmierung oder Design) labels Jul 10, 2024
@xwolfde xwolfde added this to the V1.0 - Grundfunktionalitäten milestone Jul 10, 2024
@MManthey
Copy link

@xwolfde In #32 heißt es:

Die jeweils ausgegebenen Daten sollen via Parameter angebbar (show="") oder versteckbar (hide="") sein. Per Default sollen folgende Daten gezeigt werden: Akadem. Titel, Vorname, Nachname, Akad. Suffix. ...

In diesem Ticket werden aber nur:

als Optionen für show/hide genannt, welche der beiden Varianten ist gewünscht oder tatsächlich beide?

@xwolfde
Copy link
Member Author

xwolfde commented Sep 24, 2024

Der erste Punkt in der Liste sagt aber:
"Alle Feldnamen aus der API, die angezeigt werden"
Und aus der API bekommt man durchaus Nachnamen, Vornamen, etc. auch als einzelne Felder. Und diese will man ggf. show/hide'n können.
displayname ist nur ein shortcut für eine aus Akamd-Titel+Vornamen+Nachnamen+Nachtitel zusammengestellten Output.
Natürlich würde aber ein show"displayname" hide="akademtitel" keinen Sinn machen, da displayname ja bereits ein fester erstellter Wert ist. (In diesem muss der hide/show Parameter dann nicht nochmal nachträglich reinschauen, wie sich displayname zusammensetzte und das nochmal ändern.)
hide="akademtitel" macht nur Sinn, wenn man vorher bei show z.B. "name, vorname" angeben würde und hide zusätzlich auch den displayname hiden würde.

Antwort ist also: Beide. show und hide nehmen jeweils alle Parameter entgegen und ändern ggf. die Defaultausgabe oder ergänzen diese. Wenn dabei von dem User unplausible Kombis eingegeben werden wie
show="displayname" hide="vorname"
dann ist das eine User-Fehlbedienung die nicht gesondert beachtet oder automatisch erkannt und "behoben" werden muss.

debokshi pushed a commit that referenced this issue Sep 25, 2024
@xwolfde xwolfde reopened this Oct 22, 2024
@xwolfde
Copy link
Member Author

xwolfde commented Oct 22, 2024

Funktioniert bereits grundlegend nicht.
#70

@xwolfde xwolfde added the bug Something isn't working label Oct 22, 2024
@MManthey
Copy link

MManthey commented Nov 7, 2024

@xwolfde

"Alle Feldnamen aus der API, die angezeigt werden"

hiernach muesste es ja auch moeglich sein, beispielsweise bei den Kontaktdaten in den workplaces einen bestimmten Arbeitstag anzuzeigen/verstecken. Ich habe mal alle Felder, die durch API zur Anzeige kommen herausgesucht.

Aus Schema-Person:

{
  ...
  "givenName": "Erika",
  "familyName": "Musterfrau",
  ...
  "personalTitle": "Prof. Dr.",
  "personalTitleSuffix": "Ph.D.",
  "titleOfNobility": "van",
  "email": "[email protected]",
  "telephone": "+49 9131 85-12345",
  "contacts": [
    {
      ...
      "organization": {
        ...
        "name": "Testorganisationseinheit"
      },
      ...
      "functionLabel": {
        "de": "Wissenschaftliche Mitarbeiter",
        "en": "Scientific staff"
      }
    }
  ]
}

Aus Schema-Contact:

{
  ...
  "socials": [
    {
      "platform": "github",
      "url": "https://github.com/erikamusterfrau"
    }
  ],
  "workplaces": [
    {
      "room": "01.234",
      "floor": "01",
      "street": "Musterstraße 1",
      "zip": "91058",
      "city": "Erlangen",
      "faumap": "https://karte.fau.de/api/v1/iframe/famos/12345",
      "phones": [
        "+49 9131 85-12345"
      ],
      "fax": "+49 9131 85-1234567",
      "url": "https://www.test.fau.de/person/erika-musterfrau/",
      "mails": [
        "[email protected]"
      ],
      "officeHours": [
        {
          "weekday": 1,
          "from": "07:30",
          "to": "16:00"
        }
      ],
      "consultationHours": [
        {
          "weekday": 2,
          "from": "07:30",
          "to": "16:00",
          "comment": "nur über Zoom",
          "url": "https://fau.zoom-x.de/j/1234567890?pwd=fG5xSxQ2dXNu3EMwAWgzSUpBSEFqUT16"
        }
      ],
      ...
    }
  ]
}

Aus Schema-Organization:

{
  ...
  "address": {
    "phone": "+49 9131 85-12345",
    "mail": "[email protected]",
    "url": "https://www.test.fau.de",
    "street": "Musterstraße 1",
    "zip": "91054",
    "city": "Erlangen",
    "faumap": "https://karte.fau.de/api/v1/iframe/famos/12345"
  },
  ...
}

@xwolfde
Copy link
Member Author

xwolfde commented Nov 8, 2024

Umsetzung passt soweit. Aber wie hier und anderswo aufgeworfen, müssen wir nochmal bei der AUswahl der anzuzeigenden Datensätze nachdenken. Siehe #92

@xwolfde xwolfde closed this as completed Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Basisfunktion Umzusetzende Grundfunktionalität Design Issues zum Thema Gestaltung Umsetzungshinweis Hinweise zur Umsetzung (Programmierung oder Design)
Projects
None yet
Development

No branches or pull requests

3 participants