SEO - Community Wiki - Magnolia

1. Instalacja
2. Konfiguracja
3. działania
4. Audytorzy
5. Definicje a audytorzy walidacyjni
6. Właściwości standardowego audytora
7. HtmlElementAuditor
8. I18NPropertyValidationAuditor
9. Audytor właściwościDefinition
10. PropertyValidationAuditor
11. ValidHtmlAuditor

Moduł SEO zapewnia narzędzia do analizy i weryfikacji zawartości w repozytorium JCR. Moduł SEO jest zazwyczaj używany do analizy stron, ale może być również wykorzystywany do analizy dowolnego typu węzła treści.

Moduł SEO zawiera:

• aplikacja Content Tuner, która umożliwia uruchamianie audytorów i przeglądanie ich wyników
• Audit Manager i kilku predefiniowanych audytorów
• AuditPageAction, która uruchamia aktywnych audytorów
• FlexiAuditPageAction, która uruchamia wybranych audytorów

Po pierwsze, aby wprowadzić trochę terminologii. Audytor jest samodzielnym testem wybranej strony internetowej lub dowolnego innego węzła treści. Moduł SEO zawiera szereg audytorów, których można skonfigurować do testowania różnych aspektów stron i treści.

Audytorzy analizują wybrany węzeł i albo przechodzą, albo nie, węzeł. Niepowodzenia audytu są oceniane na trzech różnych poziomach:

• Błąd - problem musi zostać naprawiony
• Ostrzeżenie - problem powinien zostać naprawiony
• Uwaga - problem nie jest poważny, ale można go naprawić

Audytorzy mogą:

• przetestuj renderowany HTML swojej strony
• przetestuj, czy wymagane właściwości są zdefiniowane dla Twojej strony lub treści
• połącz się z usługą zewnętrzną, aby przeanalizować swoją stronę, na przykład usługę sprawdzania poprawności HTML lub usługę analizy SEO
• być rozszerzone i dostosowane do potrzebnych analiz

Menedżer audytu zapewnia ramy dla wykonywania jednego lub więcej audytorów i zapisywania ich wyników. Możesz dodać nowych audytorów do Audit Managera i zmienić konfigurację zdefiniowanych audytorów.

Instalacja

Możesz zainstalować moduł SEO albo:

• Pobieranie gotowego pliku jar modułu aplikacji SEO i umieszczanie go w katalogu WEB-INF / lib (patrz Instalowanie modułu po więcej informacji)
• Dodawanie zależności Maven

Maven to najprostszy sposób instalacji modułu. Istnieją jednak dwie różne wersje modułu SEO w zależności od używanej wersji Magnolia.

Dodaj następującą zależność do swojego pakiet jeśli używasz

<zależność> <groupId> info.magnolia.seo </groupId> <artifactId> seo </artifactId> <wersja> 1.16.1 </version> </dependency>

Dodaj następującą zależność do swojego pakiet jeśli używasz Magnolia v5.5 lub starszego :

<zależność> <groupId> info.magnolia.seo </groupId> <artifactId> seo </artifactId> <wersja> 1.15 </version> </dependency>

Aplikacja Content Tuner

Możesz uruchomić audyt i wyświetlić wyniki w aplikacji Content Tuner. Możesz także wyeksportować wyniki audytu jako plik Excel lub plik tekstowy.

Aplikacja Content Tuner jest instalowana w grupie Edit w Admin Central:

Aplikacja Content Tuner ma dwa widoki: widok przeglądarki i widok szczegółów kontroli.

Widok przeglądarki pokazuje bieżące drzewo strony z dwiema nowymi kolumnami: status kontroli, wskazujący, czy strona zawiera błędy, ostrzeżenia lub uwagi i kiedy został przeprowadzony ostatni audyt.

Widok szczegółów audytu (dostępny po uruchomieniu audytu na wybranej stronie) zawiera informacje o wynikach audytu.

Widok szczegółów audytu zawiera przegląd szczegółowych informacji o tym, ile błędów, ostrzeżeń i notatek znaleziono podczas ostatniego audytu. Widok szczegółów kontroli ma również sekcję dla każdego udanego lub nieudanego audytu, który został przeprowadzony.

Możesz kliknąć sekcję audytu, aby ją rozwinąć i znaleźć więcej szczegółów na temat znalezionego problemu. W przypadku niektórych audytów możesz również znaleźć przycisk, który połączy Cię z aplikacją, w której możesz rozwiązać problem.

W tym przykładzie przycisk w sekcji „Tytuł” ​​niezdefiniowanej właściwości otworzy aplikację Strony i edytor stron, w których możesz edytować właściwości strony i dodać tytuł.

Konfiguracja

Możesz skonfigurować działania modułu SEO i audytorów SEO za pomocą aplikacji Config. Konfiguracja każdego z nich jest szczegółowo opisana poniżej.

działania

Moduł SEO zawiera dwie niestandardowe akcje, które można skonfigurować w innych aplikacjach. Obie akcje uruchamiają analizę przez Audit Manager przy użyciu skonfigurowanych audytorów:

• AuditPageAction
• FlexiAuditPageAction

AuditPageAction uruchamia analizę z uruchomionymi wszystkimi aktywnymi audytorami (zobacz aktywną właściwość dla konfiguracji audytora poniżej).

FlexiAuditPageAction otwiera okno dialogowe pokazujące wszystkich aktualnie skonfigurowanych audytorów, pozwalając użytkownikowi wybrać i wybrać, którzy audytorzy są uruchamiani.

Obie akcje można konfigurować tak jak wszystkie inne działania. Na przykład:

Ani AuditPageAction, ani FlexiAuditPageAction nie mają żadnych dodatkowych właściwości, oba można skonfigurować jako akcje standardowe. Widzieć Definicja działania aby uzyskać więcej informacji na temat konfigurowania akcji.

Audytorzy

Moduł SEO zawiera kilku audytorów:

• HtmlElementAuditor
• I18. Audytor
• I18NPropertyDefinitionAuditor
• I18NPropertyValidationAuditor
• LinkAuditor
• MetaDescriptionAuditor
• ParagraphLengthAuditor
• Audytor właściwościDefinition
• PropertyValidatorAuditor
• ValidHtmlAuditor

To, co robi każdy z tych audytorów i jak można je skonfigurować, opisano poniżej.

Definicje a audytorzy walidacyjni

Istnieją dwa zestawy audytorów, które wykonują powiązane, ale oddzielne zadania.

W przypadku międzynarodowych właściwości (właściwości z wariantami językowymi) masz I18NPropertyDefinitionAuditor i I18NPropertyValidationAuditor.

W przypadku zwykłych właściwości wanilii (właściwości bez wariantów językowych) masz obiekt PropertyDefinitionAuditor i PropertyValidationAuditor.

Audytorzy definicji - PropertyDefinitionAuditor i I18NPropertyDefinitionAuditor - sprawdzają, czy wartość dla właściwości została zdefiniowana. Nie sprawdzają wartości wartości nieruchomości.

Audytorzy walidacyjni - PropertyValidationAuditor i I18NPropertyValidationAuditor - sprawdzają wartość (wartości) wyznaczonej nieruchomości, jeśli właściwość (lub jej wariant językowy) została zdefiniowana.

Audytorzy walidacji i definicji współpracują ze sobą. Oddzielają pracę polegającą na określeniu, czy dana właściwość jest zdefiniowana, od tego, czy jest ważna, czy treści odpowiedniej treści.

Właściwości standardowego audytora

Istnieje kilka właściwości wspólnych dla wszystkich audytorów:

Wymagana właściwość / Opcjonalne Dozwolone wartości Wymagana nazwa notatki

unikalny ciąg

Nazwa audytora, zwykle nazwa węzła (z konfiguracji JCR lub YAML).

Ważne jest, aby każdy audytor miał unikalną nazwę spośród wszystkich skonfigurowanych audytorów. Audytorzy zachowają niektóre wyniki według nazwy.

opis wymagał ciągu

Krótki opis audytora.

Opis zostanie wyświetlony podczas wybierania audytów.

aktywne wymagane prawda, fałsz

Określa, czy audytor jest aktywny.

AuditPageAction wykonuje tylko aktywnych audytorów, nieaktywni audytorzy są pomijani.

FlexiAuditPageAction pozwala użytkownikom wybrać, którzy audytorzy są uruchamiani, i można wybrać zarówno aktywnych, jak i nieaktywnych audytorów.

HtmlElementAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.HtmlElementAuditor

HtmlElementAuditor sprawdza obecność określonego elementu HTML. Jeśli znaleziony element HTML zostanie znaleziony przynajmniej raz, audyt przechodzi pomyślnie, w przeciwnym razie audyt się nie powiedzie. HtmlElementAuditor można zastosować do dowolnego węzła, który może być renderowany przez Magnolia RenderingEngine.

HtmlElementAuditor używa zapytań jsoup do analizowania i znajdowania elementów HTML, patrz https://jsoup.org więcej o jsoup. kwerendy jsoup mają składnię jQuery lub CSS.

Oto kilka przykładów:

a [href]

Znajdź wszystkie elementy zakotwiczenia z atrybutem href.

meta [name = "słowa kluczowe"]

Znajdź elementy meta słów kluczowych w HTML.

Widzieć https://jsoup.org/cookbook/extracting-data/selector-syntax więcej o zapytaniach jsoup.

Oto przykład skonfigurowanego HtmlElementAuditor:

Oprócz standardowych właściwości audytora omówionych powyżej, HtmlElementAuditor można skonfigurować z następującymi właściwościami:

Wymagana właściwość / Opcjonalne Dozwolone wartości Poziom notatek wymagany auditErrors, auditWarnings, auditNotes Określa sposób zliczenia nieudanego audytu: jako błąd ( auditErrors ), jako ostrzeżenie ( auditWarnings ) lub jako notatka ( auditNotes ) auditProperty wymagany unikalny ciąg Definiuje nazwa właściwości do przechowywania nieudanych wyników kontroli. Nazwa właściwości powinna być unikalna wśród audytorów lub audytorów może nadpisać audit auditWartość wymagała ciągu

Definiuje komunikat lub wyjaśnienie nieudanego audytu. Wiadomość może zawierać symbole zastępcze, które są zastępowane informacjami o węźle i audytorze:

0 - ścieżka węzła

1 - skonfigurowana właściwość zapytania

Przykład: Ups! Nie można znaleźć {1} na stronie {0}! zapytanie wymagane łańcuch Prawidłowe zapytanie jsoup. Widzieć https://jsoup.org/cookbook/extracting-data/selector-syntax więcej o zapytaniach jsoup. invalidValue wymagane, jeśli wartość valuePattern jest zdefiniowana, opcjonalnie w przeciwnym razie łańcuch

Definiuje komunikat lub wyjaśnienie, jeśli wynik zapytania nie pasuje do valuePattern . Wiadomość może zawierać symbole zastępcze zastąpione przez:

0 - wynik zapytania

1 - valuePattern

valuePattern opcjonalne poprawne wyrażenie Java Jeśli zdefiniowane, valuePattern zostanie zastosowane do zwróconych wyników zapytania jsoup. Jeśli wartość valuePattern nie pasuje do wyniku, wynik kontroli poziomu zostanie oznaczony

I18. Audytor

Nazwa klasy: info.magnolia.services.seo.audit.impl.I18NAuditor

I18Auditor znajdzie wszystkie umiędzynarodowione pola na stronie i określi, czy pole ma wartości dla wszystkich obsługiwanych języków. Obsługiwane języki i domyślny język pochodzą z przypisanych miejsc zdefiniowanych w Menedżerze serwisu.

Każde pole z wartością dla obsługiwanego języka zostanie policzone, a łączna liczba wszystkich oczekiwanych wartości dla pól międzynarodowych zostanie zsumowana. Obliczany jest stosunek rzeczywistych umiędzynarodowionych wartości pól do oczekiwanych umiędzynarodowionych pól i porównywany z delegatami progów zdefiniowanymi dla I18NAuditor.

Delegat progu definiuje górną i dolną granicę dla danego wyniku kontroli na podstawie rzeczywistych wartości pól międzynarodowych do oczekiwanych wartości pól.

Na przykład, jeśli stosunek rzeczywisty / oczekiwany wynosi:

• między 0 a 0,6 spowoduje błąd
• między 0,6 a 0,8 spowoduje ostrzeżenie
• od 0,8 do 0,9 spowoduje notatkę
• większy niż 0,9, kontrola przeszła

Delegaci progu zastępują właściwość „level” dla I18NAuditor i umożliwiają zgłaszanie problemów o różnym nasileniu.

I18NAuditor może być skonfigurowany z następującymi właściwościami, oprócz wspólnych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Uwagi auditProperty wymagane unikalny ciąg Definiuje nazwę właściwości do przechowywania nieudanych wyników kontroli. Nazwa właściwości powinna być unikalna wśród audytorów lub audytorzy mogą nadpisać swoje wyniki passProperty opcjonalny unikalny ciąg Definiuje nazwę właściwości do przechowywania prawidłowych łączy. Nazwa właściwości powinna być unikalna wśród audytorów rootUrl wymaga ciągu znaków Definiuje podstawowy adres URL, który ma być używany podczas sprawdzania odnośników względnych. Względne łącza zostaną dodane do podstawowego adresu URL, a następnie zaznaczone, więc podstawowy adres URL powinien kończyć się ukośnikiem. excludedLinks opcjonalnie lista wyrażeń regularnych Java

Definiuje jeden lub więcej wzorców adresów URL, które mają być ignorowane. Możesz zdefiniować więcej niż jedno wyrażenie regularne.

Jeśli nie zdefiniowano żadnych wyrażeń regularnych, wszystkie linki zostaną sprawdzone.

Widzieć https://docs.oracle.com/javase/tutorial/essential/regex/ więcej na temat wyrażeń regularnych Java.

validStatuses opcjonalna lista kodów statusu HTTP jako liczby całkowite

Definiuje oczekiwane kody stanu HTTP dla łącza, które ma zostać uznane za prawidłowe.

Jeśli nie jest ustawiona, lista ważnych kodów statusu to: 200 (SC_OK).

pauseTime opcjonalnie liczba całkowita

Definiuje opóźnienie (w milisekundach) między sprawdzaniem łączy. Możesz ustawić tę właściwość na wartość niezerową, aby uniknąć zalania serwera żądaniami HTTP.

Jeśli nie zostanie ustawiony, czas pauzy wyniesie 0 (brak opóźnienia między żądaniami).

I18NPropertyDefinitionAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.I18NPropertyDefinitionAuditor

I18NPropertyDefinitionAuditor jest towarzyszem dla PropertyDefinitionAuditor. Zamiast sprawdzać definicję właściwości węzła dla języka domyślnego, I18NPropertyDefinitionAuditor może sprawdzić, czy wartości są zdefiniowane dla wszystkich lub niektórych dostępnych języków witryny.

Należy zauważyć, że I18NPropertyDefinitionAuditor tylko sprawdza, czy właściwość jest zdefiniowana, a nie wartość właściwości. Możesz użyć I18NPropertyValidationAuditor, aby sprawdzić, czy wartości dla języka są poprawne.

Oto przykład I18PropertyDefinitionAuditor:

I18NPropertyDefinitionAuditor można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Uwagi właściwość nazwa wymagane łańcuch Określa nazwę właściwości węzła do sprawdzenia. poziom opcjonalny auditBłędy, audytWarnacje, auditNotes

Określa sposób liczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatkę (auditNotes)

validateAll opcjonalny true, false (domyślnie jest true)

Kontroluje, które języki właściwości będą sprawdzane.

Jeśli validateAll jest prawdą, właściwość zostanie sprawdzona pod kątem wariantów językowych dla wszystkich języków zdefiniowanych dla witryny.

Jeśli validateAll jest fałszywe, sprawdzane będą tylko warianty języka zdefiniowane przez właściwość expectedLanguages.

oczekiwaneLanguages ​​opcjonalnie lista kodów językowych lub języka plus kody krajów

expectedLanguages ​​definiuje listę języków do sprawdzenia dla wariantów językowych właściwości. Może to być podzbiór języków zdefiniowanych dla witryny. Języki nieuwzględnione w oczekiwanych językach nie będą sprawdzane.

expectedLanguages ​​będą używane tylko wtedy, gdy validateAll ma wartość false.

I18NPropertyValidationAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.I18NPropertyValidationAuditor

I18NPropertyValidationAuditor jest towarzyszem PropertyValidationAuditor. Zamiast sprawdzania poprawności definicji właściwości węzła dla języka domyślnego, I18NPropertyValidationAuditor może zweryfikować wartości wyznaczonej właściwości dla wszystkich lub niektórych dostępnych języków witryny.

Należy zauważyć, że I18NPropertyValidationAuditor po prostu sprawdza wartości właściwości i nie sprawdza, czy zdefiniowano wszystkie warianty językowe właściwości. Możesz użyć I18NPropertyDefinitionAuditor, aby sprawdzić, czy wszystkie wymagane warianty językowe właściwości są zdefiniowane.

Oto przykład I18NPropertyValidationAuditor:

I18NPropertyValidationAuditor można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Uwagi właściwość nazwa wymagane łańcuch Określa nazwę właściwości węzła do sprawdzenia. poziom opcjonalny auditBłędy, audytWarnacje, auditNotes

Określa sposób liczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatkę (auditNotes)

validateAll opcjonalny true, false (domyślnie jest true)

Kontroluje, które języki właściwości będą sprawdzane.

Jeśli validateAll jest prawdą, cała właściwość zostanie sprawdzona pod kątem wartości językowych dla wszystkich języków zdefiniowanych dla serwisu.

Jeśli validateAll ma wartość false, sprawdzane będą tylko języki zdefiniowane przez właściwość expectedLanguages.

oczekiwaneLanguages ​​opcjonalnie lista kodów językowych lub języka plus kody krajów

expectedLanguages ​​definiuje listę języków do sprawdzenia dla wartości właściwości. Może to być podzbiór języków zdefiniowanych dla witryny. Języki nieuwzględnione w oczekiwanych językach nie będą sprawdzane.

expectedLanguages ​​będą używane tylko wtedy, gdy validateAll ma wartość false.

valuePatterns opcjonalnie mapa kodów języka lub języka plus kody krajów do wartości wyrażeń regularnych

Definiuje wzorzec sprawdzania poprawności - wyrażenie regularne Java - do sprawdzania poprawności wartości właściwości dla danego języka. Jeśli wartości właściwości nie pasują do wzorca wartości dla języka, audyt zakończy się niepowodzeniem.

Jeśli valuePatterns nie ma wpisu dla konkretnego języka, defaultValuePattern (patrz poniżej) będzie używany do sprawdzania poprawności wartości właściwości dla języka.

Widzieć https://docs.oracle.com/javase/tutorial/essential/regex/ więcej na temat wyrażeń regularnych Java.

defaultValuePattern opcjonalne poprawne wyrażenie regularne Java

Definiuje wzorzec sprawdzania poprawności - wyrażenie regularne Java - do użycia, gdy wzorzec wartości specyficzny dla języka nie został zdefiniowany w valuePattern. Jeśli wartości właściwości nie pasują do wzorca wartości dla języka, audyt zakończy się niepowodzeniem.

Widzieć https://docs.oracle.com/javase/tutorial/essential/regex/ więcej na temat wyrażeń regularnych Java.

LinkAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.LinkAuditor

LinkAuditor znajdzie linki na renderowanej stronie HTML i sprawdzi, czy są one dostępne. Adresy URL zawarte w kotwicy HTML, elementach łącza i elementach img są wyodrębniane i sprawdzane. Inne adresy URL, takie jak adresy URL zawarte w funkcjach Javascript, nie zostaną wykryte i nie będą sprawdzane.

Uwaga: sprawdzanie dużej liczby linków może być czasochłonne, możesz użyć właściwości excludedLinks, aby zignorować niektóre linki lub uruchomić LinkAuditor tylko wtedy, gdy jest to konieczne.

Oto przykład LinkAuditor:

Oprócz standardowych właściwości LinkAuditor można skonfigurować następujące właściwości:

Wymagana właściwość / Opcjonalne Dozwolone wartości Poziom notatek wymagany auditErrors, auditWarnings, auditNotes Określa sposób zliczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatka (auditNotes) auditProperty wymagany unikalny ciąg Definiuje nazwa właściwości do przechowywania nieudanych wyników kontroli. Nazwa właściwości powinna być unikalna wśród audytorów lub audytorzy mogą nadpisać swoje wyniki passProperty opcjonalny unikalny ciąg Definiuje nazwę właściwości do przechowywania prawidłowych łączy. Nazwa właściwości powinna być unikalna wśród audytorów rootUrl wymaga ciągu znaków Definiuje podstawowy adres URL, który ma być używany podczas sprawdzania odnośników względnych. Względne łącza zostaną dodane do podstawowego adresu URL, a następnie zaznaczone, więc podstawowy adres URL powinien kończyć się ukośnikiem. excludedLinks opcjonalnie lista wyrażeń regularnych Java

Definiuje jeden lub więcej wzorców adresów URL, które mają być ignorowane. Możesz zdefiniować więcej niż jedno wyrażenie regularne.

Jeśli nie zdefiniowano żadnych wyrażeń regularnych, wszystkie linki zostaną sprawdzone.

Widzieć https://docs.oracle.com/javase/tutorial/essential/regex/ więcej na temat wyrażeń regularnych Java.

validStatuses opcjonalna lista kodów statusu HTTP jako liczby całkowite

Definiuje oczekiwane kody stanu HTTP dla łącza, które ma zostać uznane za prawidłowe.

Jeśli nie jest ustawiona, lista ważnych kodów statusu to: 200 (SC_OK).

pauseTime opcjonalnie liczba całkowita

Definiuje opóźnienie (w milisekundach) między sprawdzaniem łączy. Możesz ustawić tę właściwość na wartość niezerową, aby uniknąć zalania serwera żądaniami HTTP.

Jeśli nie zostanie ustawiony, czas pauzy wyniesie 0 (brak opóźnienia między żądaniami).

Nazwa klasy: info.magnolia.services.seo.audit.impl.MetaDescriptionAuditor

MetaDescriptionAuditor sprawdza węzeł pod kątem właściwości o nazwie „opis” i jeśli jest zdefiniowana, sprawdza długość wartości.

Wiele wyszukiwarek ignoruje długie opisy meta - zazwyczaj cały tekst po około 160 do 180 znaków. MetaDescriptionAuditor może pomóc w sprawdzeniu długich opisów meta.

Uwaga: MetaDescriptionAuditor zakłada, że ​​właściwość „opis” węzła zawiera tekst opisu meta.

Oto przykład MetaDescriptionAuditor:

MetaDescriptionAudit można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Długość notatki opcjonalnie liczba całkowita

Definiuje maksymalną długość opisu meta, długość powyżej maksimum nie powiedzie się z ostrzeżeniem.

Jeśli nie określono długości, maksymalna długość wynosi 160.

ParagraphLengthAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.ParagraphLengthAuditor

ParagraphLengthAuditor sprawdza długość słów w elementach HTML zawierających tekst, a nie całkowitą długość znaków. Możesz użyć ParagraphLengthAuditor, aby sprawdzić strony z nadmiernie długimi blokami tekstu.

ParagraphLengthAuditor może dowolny element HTML zawierający tekst, który można znaleźć za pomocą zapytania jsoup.

Oto przykład ParagraphLengthAuditor:

ParagraphLengthAuditor można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Poziom notatek wymagany auditErrors, auditWarnings, auditNotes Określa sposób zliczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatka (auditNotes) auditProperty wymagany unikalny ciąg Definiuje nazwa właściwości do przechowywania nieudanych wyników kontroli. Nazwa właściwości powinna być unikalna wśród audytorów lub audytorzy mogą nadpisać swoje wyniki auditValue wymagane ciąg znaków

Definiuje komunikat lub wyjaśnienie nieudanego audytu. Wiadomość może zawierać symbole zastępcze, które są zastępowane informacjami o węźle i audytorze:

0 - ścieżka węzła

1 - skonfigurowana właściwość zapytania

Przykład: Ups! Nie można znaleźć & # 123; 1 & # 125; na stronie & # 123; 0 & # 125 ;! zapytanie opcjonalne ciąg

Poprawne zapytanie jsoup. Widzieć https://jsoup.org/cookbook/extracting-data/selector-syntax więcej o zapytaniach jsoup.

Jeśli nie zostanie określony, ParagraphLengthAuditor sprawdzi tekst elementów „p” (akapit) HTML.

maxWords opcjonalnie liczba całkowita

Określa maksymalną liczbę słów dozwolonych w bloku tekstu.

Jeśli nie zostanie określony, limit wyniesie 150.

Audytor właściwościDefinition

Nazwa klasy: info.magnolia.services.seo.audit.impl.PropertyDefinitionAuditor

PropertyDefinitionAuditor sprawdza, czy określona właściwość węzła jest zdefiniowana. Nie sprawdza, czy wartość właściwości używa do tego PropertyValidationAuditor.

Można użyć właściwości PropertyDefinitionAuditor dla brakujących właściwości na stronach lub węzłach treści. Możesz użyć I18NPropertyDefinitionAuditor, aby sprawdzić definicję internacjonalizowanych właściwości (właściwości z wariantami językowymi).

Oto przykład skonfigurowanego kontrolera PropertyDefinitionAuditor:

Właściwość PropertyDefinitionAuditor można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Uwagi właściwość nazwa wymagane łańcuch Określa nazwę właściwości węzła do sprawdzenia. poziom opcjonalny auditBłędy, audytWarnacje, auditNotes

Określa sposób liczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatkę (auditNotes)

PropertyValidationAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.PropertyValidationAuditor

PropertyValidationAuditor jest towarzyszem I18NPropertyValidationAuditor. PropertyValidationAuditor sprawdza wartości wyznaczonej właściwości. Jeśli właściwość jest umiędzynarodowiona (np. Właściwość ma warianty językowe), użyj I18NPropertyValidationAuditor, aby zweryfikować wartości właściwości.

Należy zauważyć, że PropertyValidationAuditor po prostu sprawdza wartości właściwości i nie sprawdza, czy wszystkie warianty językowe właściwości są zdefiniowane. Możesz użyć PropertyDefinitionAuditor, aby sprawdzić, czy właściwość jest zdefiniowana.

Oto przykład PropertyValidationAuditor:

PropertyValidationAuditor można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Uwagi właściwość nazwa wymagane łańcuch Określa nazwę właściwości węzła do sprawdzenia. poziom opcjonalny auditBłędy, audytWarnacje, auditNotes

Określa sposób liczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatkę (auditNotes)

oczekiwaneLanguages ​​opcjonalnie lista kodów językowych lub języka plus kody krajów

expectedLanguages ​​definiuje listę języków do sprawdzenia dla wartości właściwości. Może to być podzbiór języków zdefiniowanych dla witryny. Języki nieuwzględnione w oczekiwanych językach nie będą sprawdzane.

expectedLanguages ​​będą używane tylko wtedy, gdy validateAll ma wartość false.

valuePattern wymagało poprawnego wyrażenia regularnego Java

Definiuje wzorzec sprawdzania poprawności - wyrażenie regularne Java - w celu sprawdzenia wartości właściwości. Jeśli wartość właściwości nie pasuje do wzorca wartości, audyt zakończy się niepowodzeniem.

Widzieć https://docs.oracle.com/javase/tutorial/essential/regex/ więcej na temat wyrażeń regularnych Java.

ValidHtmlAuditor

Nazwa klasy: info.magnolia.services.seo.audit.impl.ParagraphLengthAuditor

ValidHtmlAuditor sprawdza poprawność renderowanego HTML strony za pomocą walidatora HTML W3C (patrz https://validator.w3.org po więcej informacji).

ValidHtmlAuditor przechwyci i zapisze wszelkie błędy HTML znalezione przez walidator HTML W3C; widzieć https://validator.w3.org/docs/errors.html więcej o błędach HTML zwracanych przez walidator W3C.

Oto przykład:

ValidHtmlAuditor można skonfigurować z następującymi właściwościami, oprócz standardowych właściwości powyżej:

Wymagana właściwość / Opcjonalne Dozwolone wartości Poziom notatek wymagany auditErrors, auditWarnings, auditNotes Określa sposób zliczenia nieudanego audytu: jako błąd (auditErrors), jako ostrzeżenie (auditWarnings) lub jako notatka (auditNotes) auditProperty wymagany unikalny ciąg Definiuje nazwa właściwości do przechowywania nieudanych wyników kontroli. Nazwa właściwości powinna być unikalna wśród audytorów lub audytorzy mogą nadpisać swoje wyniki auditValue wymagane ciąg znaków

Definiuje komunikat lub wyjaśnienie nieudanego audytu. Wiadomość może zawierać symbole zastępcze, które są zastępowane informacjami o węźle i audytorze:

0 - ścieżka węzła

1 - skonfigurowana właściwość zapytania

Przykład: Ups! Nie można znaleźć {1} na stronie {0}! strict opcjonalne true, false

Kontroluje poziom walidacji wykonywany przez walidator HTML W3C.

Jeśli wartość strict jest ustawiona na true, HTML W3C zwróci wszystkie znalezione błędy, ostrzeżenia i notatki.

Jeśli wartość strict jest ustawiona na false, zwracane są tylko błędy HTML.

Jeśli nie jest ustawiona, wartość strict jest ustawiona na false.