Handbuch zu Community-Komponenten community-components-guide

Das Komponentenleitfaden der Community ist ein interaktives Entwicklungstool für die Social Component Framework (SCF). Es bietet eine Liste der verfügbaren Adobe Experience Manager (AEM) Communities-Komponenten oder der komplexeren Funktionen, die aus mehreren Komponenten erstellt wurden.

Neben grundlegenden Informationen für jede Komponente ermöglicht das Handbuch Experimente mit der Funktionsweise der SCF-Komponenten/-Funktionen und deren Konfiguration oder Anpassung.

Informationen zu Entwicklungsgrundlagen für die einzelnen Komponenten finden Sie unter Funktionen und Komponentengrundlagen.

Erste Schritte getting-started

Das Handbuch ist für die Verwendung in Entwicklungs-Installationen von Autoreninstanzen (localhost:4502) und Veröffentlichungsinstanzen (localhost:4503) vorgesehen.

Auf die Website "Community-Komponenten"können Sie unter

Die Interaktionen mit den Communities-Komponenten variieren je nach:

  • Der Server (Autor oder Veröffentlichung).
  • Ob der Site-Besucher angemeldet ist oder nicht.
  • Bei Anmeldung werden die dem Mitglied zugewiesenen Berechtigungen zugewiesen.
  • Ob der Standard-SRP JSRP, wird verwendet.

Fügen Sie beim Autor Folgendes ein, um den Bearbeitungsmodus zu aktivieren: editor.html oder cf# als erstes Pfadsegment nach dem Servernamen:

NOTE
Beim Autor im Bearbeitungsmodus sind die Links auf einer Seite nicht aktiv.
Um zu einer Komponentenseite zu navigieren, wählen Sie zunächst den Vorschaumodus aus, um die Links zu aktivieren.
Kehren Sie bei angezeigter Komponentenseite im Browser zum Bearbeitungsmodus zurück, um das Bearbeitungsdialogfeld der Komponente zu öffnen.
Allgemeine Informationen zum Authoring finden Sie unter Kurzanleitung zum Erstellen von Seiten.
Wenn Sie nicht mit AEM vertraut sind, lesen Sie die Dokumentation unter grundlegende Handhabung.

Startseite home-page

Das Handbuch enthält eine Liste von SCF-Komponenten, die links auf der Seite für die Vorschau und das Prototyping verfügbar sind.

Komponentenleitfaden, wie in einer Autoreninstanz im Bearbeitungsmodus angezeigt:

community-component1

Komponentenseiten component-pages

Wählen Sie eine Komponente aus der Liste links auf der Seite aus.

community-component-pages

Der Hauptteil des Handbuchs wird angezeigt:

  1. Titel: Der Name der ausgewählten Komponente

  2. Client-seitige Bibliotheken: Eine Liste der erforderlichen Kategorien

  3. Einschließlich: Wenn die Komponente dynamisch eingeschlossen sein kann, kann der Status im Bearbeitungsmodus des Autors umgeschaltet werden:

    • Wenn der Text hinzugefügt wird, lautet der angezeigte Text: "Diese Komponente wird über ihren par -Knoten einbezogen."
    • Wenn enthalten, lautet der angezeigte Text: "Diese Komponente wird dynamisch einbezogen."
    • Wenn nicht enthalten, wird kein Text angezeigt
  4. Beispielkomponente oder -funktion: eine aktive Instanz der Komponente oder Funktion. Wenn eine Komponente geändert werden soll, kann sie durch Änderungen an den Vorlagen, CSS und Daten im Registerkartenabschnitt geändert werden.

NOTE
Nachdem Sie eine Auswahl auf der linken Seite getroffen haben, wird die Komponente unten angezeigt, anstatt neben der Liste der Komponenten, wenn das Browser-Fenster zu eng ist.

Autoreninteraktionen author-interactions

Wenn Sie das Handbuch in einer Autoreninstanz verwenden, ist es möglich, die Konfiguration einer Komponente zu erleben, indem Sie das zugehörige Dialogfeld öffnen. Informationen für Entwickler finden Sie im Abschnitt Komponenten- und Funktionsgrundlagen -Abschnitt der Dokumentation, während die Dialogfeldeinstellungen unter Communities-Komponenten -Abschnitt für Autoren.

Im Komponentenleitfaden für die Community-Komponenten werden einige Einstellungen für den Komponenten-Dialog mit dem Einschließlich Status ein-/ausschalten. Um zwischen der Verwendung der vorhandenen Ressource oder einer dynamisch eingeschlossenen Ressource umzuschalten, wählen Sie im Bearbeitungsmodus sowohl die Komponente als auch den einschließbaren Text aus und doppelklicken Sie, um das Bearbeitungsdialogfeld zu öffnen:

community-component3

Unter dem Vorlagen tab:

community-component4

  • Untergeordnete Komponente mit sling:include einschließen

    Wenn diese Option deaktiviert ist, verwendet das Komponentenleitfaden die vorhandene Ressource im Repository (einen jcr-Knoten, der einem par -Knoten untergeordnet ist).

    • Der angezeigte Text lautet: "Diese Komponente wird über ihren par -Knoten einbezogen."

    Wenn diese Option aktiviert ist, verwendet das Komponentenleitfaden Sling, um eine Komponente des resourceType des untergeordneten Knotens (nicht vorhandene Ressource) dynamisch einzuschließen.

    • Der angezeigte Text lautet: "Diese Komponente wird dynamisch einbezogen."

    Die Option Standard ist deaktiviert.

Veröffentlichungsinteraktionen publish-interactions

Bei Verwendung des Handbuchs in einer Veröffentlichungsinstanz ist es möglich, die Komponenten und Funktionen als Site-Besucher (nicht angemeldet) und als Mitglieder mit verschiedenen Berechtigungen beim Anmelden zu erleben.

NOTE
Beachten Sie, wenn das SRP standardmäßig auf JSRPfestgelegt ist, dann ist der in die Veröffentlichungsinstanz eingegebene benutzergenerierte Inhalt nur in der Veröffentlichungsinstanz sichtbar und not aus dem Moderation auf der Autoreninstanz.

Client-seitige Bibliotheken client-side-libraries

Die clientseitigen Bibliotheken (clientlibs), die für jede Komponente aufgelistet sind, sind erforderlich , auf die verwiesen wird, wenn die Komponente auf einer Seite platziert wird. Die clientlibs bieten eine Möglichkeit, den Download von JavaScript und CSS zu verwalten und zu optimieren, die zum Rendern der Komponente im Browser verwendet werden.

Weitere Informationen finden Sie unter Clientlibs für Communities-Komponenten.

Personifikation impersonation

Verwenden Sie in der Autoreninstanz, in der häufig ein Benutzer als Administrator oder Entwickler angemeldet ist, das Textfeld links neben der Identität annehmen -Schaltfläche, um entweder den Benutzernamen einzugeben oder aus der Pulldown-Liste auszuwählen, und klicken Sie dann auf die Schaltfläche. Klicken Sie auf Wiederherstellen , um sich abzumelden und die Identität zu beenden.

Die Veröffentlichungsinstanz muss nicht stellvertretend agieren. Verwenden Sie einfach den Link Anmelden/Abmelden , um verschiedene Benutzer zu stellvertreten, z. B. die Demobenutzer.

Anpassung customization

Wenn diese Option aktiviert ist, steht jede SCF-Komponente für die Prototypisierung möglicher Anpassungen zur Verfügung, indem die Vorlage, CSS und Daten der Komponente vorübergehend geändert werden.

Aktivieren der Anpassung enabling-customization

NOTE
Dieses Tool ist schreibgeschützt. An Vorlagen, CSS oder Daten vorgenommene Änderungen werden nicht im Repository gespeichert.

Um schnell mit Anpassungen zu experimentieren, muss die scg:showIde-Eigenschaft muss zum JCR-Knoten der Inhaltsseite der Komponente hinzugefügt und auf "true"gesetzt werden.

Verwenden der Kommentarkomponente als Beispiel für die Autoren- oder Veröffentlichungsinstanz, die mit Administratorrechten angemeldet ist:

  1. Navigieren Sie zu CRXDE Lite

    Beispiel: http://localhost:4503/crx/de

  2. Wählen Sie die jcr:content Knoten

    Beispiel: /content/community-components/en/comments/jcr:content

  3. Hinzufügen einer Eigenschaft

    • Name scg:showIde
    • Typ String
    • Wert true
  4. Auswählen Alle speichern

  5. Laden Sie die Seite "Kommentare"im Handbuch erneut.

    http://localhost:4503/content/community-components/en/comments.html

  6. Beachten Sie, dass es jetzt drei Registerkarten für Vorlagen, CSS und Daten gibt.

community-component5

community-component6

Registerkarte "Vorlagen" templates-tab

Wählen Sie den Tab Vorlagen aus, um die der Komponente zugeordneten Vorlagen anzuzeigen.

Mit dem Vorlagen-Editor können lokale Bearbeitungen kompiliert und auf die Beispielkomponenteninstanz oben auf der Seite angewendet werden, ohne dass sich dies auf die Komponente im Repository auswirkt.

Wenn Sie die Kompilierung auf lokalen Bearbeitungen ausführen, werden alle Fehler hervorgehoben, indem Sie einen Punkt in der Rinne platzieren und den Text rot markieren.

CSS-Registerkarte css-tab

Wählen Sie die Registerkarte CSS aus, um die mit der Komponente verknüpfte CSS anzuzeigen.

Wenn eine Komponente aus mehreren Komponenten zusammengesetzt ist, können einige CSS unter einer der anderen Komponenten aufgeführt sein.

Mit dem CSS-Editor kann das CSS geändert und auf die Beispielkomponenteninstanz oben auf der Seite angewendet werden.

Es kann eine Regel ausgewählt werden, um die Teile des DOM mithilfe dieser Regel hervorzuheben, indem Sie neben der Regel in der Rinne auf klicken.

Registerkarte "Daten" data-tab

Wählen Sie die Registerkarte Daten aus, um die Endpunktdaten .social.json anzuzeigen. Diese Daten können bearbeitet werden und werden auf die Beispielkomponenteninstanz angewendet.

Syntaxfehler können im Rinnstein markiert und im Editor hervorgehoben werden.

recommendation-more-help
81e2cd9d-0789-409d-b87c-2a8ce4f28791