Handbuch der Community-Komponenten

Das Handbuch zu Community-Komponenten ist ein interaktives Entwicklungstool für das Social Component Framework (SCF). Es bietet eine Liste der verfügbaren 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 Komponenten-Grundlagen.

Erste Schritte

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

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

• https://<server>:<port>/content/community-components/en.html

Die Interaktionen mit den Communities-Komponenten variieren je nach:

• Der Server (Autor oder Veröffentlichung)
• Ob der Site-Besucher angemeldet ist oder nicht
• Wenn angemeldet, die dem Mitglied zugewiesenen Berechtigungen
• Gibt an, ob das Standard-SRP JSRP verwendet wird

Um beim Autor in den Bearbeitungsmodus zu wechseln, fügen Sie entweder editor.html oder cf# als erstes Pfadsegment nach dem Servernamen ein:

• Standard-Benutzeroberfläche:

  https://<server>:<port>/editor.html/content/community-components/en.html

• Klassische Benutzeroberfläche:

  https://<server>:<port>/cf#/content/community-components/en.html

Startseite

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:

Komponentenseiten

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

Der Hauptteil des Handbuchs wird angezeigt:

1. Titel: Der Name der ausgewählten Komponente

2. Client-seitige Bibliotheken: Liste einer oder mehrerer erforderlicher Kategorien

3. Inclusible: Wenn die Komponente dynamisch eingeschlossen werden kann, kann der Status im Bearbeitungsmodus des Autors umgeschaltet werden:

   • Wenn hinzugefügt, wird folgender Text angezeigt: "Diese Komponente wird über ihren par -Knoten einbezogen."
   • Wenn enthalten, lautet der angezeigte Text: "Diese Komponente wird dynamisch einbezogen."
   • Wenn nicht eingeschlossen, 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, die im Tab-Abschnitt bereitgestellt werden, geändert werden.

Autoreninteraktionen

Wenn Sie das Handbuch in einer Autoreninstanz verwenden, ist es möglich, die Konfiguration einer Komponente durch Öffnen des Dialogfelds zu erleben. Informationen für Entwickler finden Sie im Abschnitt Komponenten- und Funktionsgrundlagen der Dokumentation, während die Dialogeinstellungen für Autoren im Abschnitt Communities-Komponenten beschrieben werden.

Im Komponentenleitfaden für die Community-Komponenten werden einige Einstellungen des Komponentendialogfelds mit dem Umschalter-Status Inclusible überlagert. 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:

Auf der Registerkarte Vorlagen :

• 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).

  • angezeigter Text: "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.

  • angezeigter Text: "Diese Komponente wird dynamisch einbezogen."

  Diese Option ist standardmäßig deaktiviert.

Veröffentlichungsinteraktionen

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.

Client-seitige Bibliotheken

Die für jede Komponente aufgelisteten Client-seitigen Bibliotheken (clientlibs) sind die required, die referenziert werden sollen, 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

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

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

Anpassung

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

Um schnell mit Anpassungen zu experimentieren, muss die scg:showIdeEigenschaft 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 den Knoten jcr:content der Komponente aus.

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

3. Eigenschaft hinzufügen

   • Name scg:showIde
   • Typ String
   • Wert true

4. Wählen Sie 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 3 Registerkarten für Vorlagen, CSS und Daten gibt.

Registerkarte "Vorlagen"

Wählen Sie den Tab Vorlagen aus, um die mit der Komponente verknüpften 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

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"

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.