- Установка
- Конфігурація
- Дії
- Аудитори
- Визначення порівняно з аудиторами перевірки
- Стандартні властивості аудитора
- HtmlElementAuditor
- I18NPropertyValidationAuditor
- PropertyDefinitionAuditor
- PropertyValidationAuditor
- ValidHtmlAuditor
Модуль SEO надає інструменти для аналізу та перевірки вмісту у вашому репозиторії JCR. Модуль SEO зазвичай використовується для аналізу сторінок, але також може використовуватися для аналізу будь-якого вузла вмісту.
Модуль SEO містить:
- додаток "Тюнер вмісту", який дозволяє запускати аудитори та переглядати їх результати
- керівника аудиту та декількох заздалегідь визначених аудиторів
- AuditPageAction, який запускає активних аудиторів
- FlexiAuditPageAction, який запускає вибрані аудитори
По-перше, ввести трохи термінології. Аудитор - це самостійний тест вибраної сторінки веб-сайту або будь-якого іншого вузла вмісту. Модуль SEO містить різноманітні аудитори, які можна налаштувати для тестування різних аспектів ваших сторінок і вмісту.
Аудитори аналізують вибраний вузол і або передають, або не виконують вузол. Помилки аудиту оцінюються на трьох різних рівнях:
- Помилка - проблема повинна бути виправлена
- Попередження - проблема повинна бути виправлена
- Примітка - проблема не є суворою, але її можна виправити
Аудитори можуть:
- перевірте відображений HTML сторінки
- перевірте, чи визначені необхідні властивості для сторінки чи вмісту
- підключитися до зовнішньої служби, щоб проаналізувати вашу сторінку, наприклад, службу перевірки HTML або службу аналізу SEO
- бути розширеним і налаштованим на будь-який необхідний аналіз
Менеджер з аудиту надає вам рамки для виконання одного або декількох аудиторів та збереження їх результатів. Ви можете додати нових аудиторів до менеджера аудиту та змінити конфігурацію визначених аудиторів.
Установка
Модуль SEO можна встановити:
- Завантаження попередньо побудованого файлу jar модуля додатка SEO і розміщення його в каталозі WEB-INF / lib (див Встановлення модуля для отримання додаткової інформації)
- Додавання залежності Maven
Maven - це найпростіший спосіб встановити модуль. Однак, існує дві різні версії модуля SEO, залежно від того, яку версію Magnolia ви використовуєте.
Додайте наступну залежність до свого пучок якщо ви використовуєте
<залежність> <groupId> info.magnolia.seo </groupId> <artifactId> seo </artifactId> <version> 1.16.1 </version> </dependency>
Додайте наступну залежність до свого пучок якщо ви використовуєте Magnolia v5.5 або старше :
<залежність> <groupId> info.magnolia.seo </groupId> <artifactId> seo </artifactId> <version> 1.15 </version> </dependency>
Додаток "Тюнер вмісту"
Ви можете запустити аудит і переглянути результати в програмі Content Tuner. Ви також можете експортувати результати аудиту як файл Excel або текстовий файл.
Програма Content Tuner встановлюється в групі "Редагування центра адміністратора":
Програма Content Tuner має два види: перегляд веб-переглядача та перегляд деталей аудиту.
У вікні переглядача відображається поточне дерево сторінок з двома новими стовпцями: статус аудиту, що вказує, чи на сторінці є помилки, попередження або примітки та коли був виконаний останній аудит.
Перегляд деталей аудиту (доступний, коли аудит виконувався на вибраній сторінці) дає інформацію про результати аудиту.
Перегляд деталей аудиту показує огляд, що показує, скільки помилок, попереджень та приміток було знайдено під час останнього аудиту. Перегляд деталей аудиту також містить розділ для кожного успішного або невдалого аудиту, який був виконаний.
Ви можете натиснути на розділ аудиту, щоб розгорнути його та знайти більше подробиць щодо виявленої проблеми. Для деяких перевірок можна також знайти кнопку, яка пов'язує вас з програмою, в якій ви можете виправити проблему.
У цьому прикладі кнопка в розділі Невизначена властивість "title" відкриє додаток "Сторінки" та редактор сторінок, де можна редагувати властивості сторінки та додавати назву.
Конфігурація
Ви можете налаштувати дії модуля SEO і аудиторів SEO за допомогою програми Config. Конфігурація кожного з них докладно описана нижче.
Дії
Модуль SEO містить дві користувацькі дії, які можна налаштувати в інших програмах. Обидві дії запускають аналіз менеджером аудиту за допомогою налаштованих аудиторів:
- AuditPageAction
- FlexiAuditPageAction
AuditPageAction запускає аналіз запуску всіх активних аудиторів (див. Нижче активне властивість для налаштування аудитора).
FlexiAuditPageAction відкриває діалогове вікно, в якому відображаються всі поточні налаштовані аудитори, що дозволяє користувачеві обирати та вибирати, які аудитори виконуються.
Обидва дії налаштовуються так само, як і будь-які інші дії. Наприклад:
Ні AuditPageAction, ні FlexiAuditPageAction не мають додаткових властивостей, обидва вони можуть бути налаштовані як стандартні дії. Подивитися Визначення дії більше про налаштування дій.
Аудитори
Модуль SEO містить кілька аудиторів:
- HtmlElementAuditor
- I18NAditor
- I18NPropertyDefinitionAuditor
- I18NPropertyValidationAuditor
- LinkAuditor
- MetaDescriptionAuditor
- ПакетLengthAuditor
- PropertyDefinitionAuditor
- PropertyValidatorAuditor
- ValidHtmlAuditor
Те, що робить кожен з цих аудиторів і як вони можуть бути налаштовані, описано нижче.
Визначення порівняно з аудиторами перевірки
Є два набори аудиторів, які роблять пов'язані, але окремі робочі місця.
Для інтернаціоналізованих властивостей (властивості з варіантами мови), у вас є I18NPropertyDefinitionAuditor і I18NPropertyValidationAuditor.
Для простих властивостей ванілі (властивості без мовних варіантів) у вас є PropertyDefinitionAuditor і PropertyValidationAuditor.
Аудитори визначення - PropertyDefinitionAuditor та I18NPropertyDefinitionAuditor - перевіряють, чи визначено значення (властивостей) властивості. Вони не підтверджують значення (а) власності.
Аудитори перевірки - PropertyValidationAuditor та I18NPropertyValidationAuditor - перевіряють значення для визначеного властивості, якщо визначено властивість (або його мовний варіант).
Аудитори перевірки та визначення функціонують спільно. Вони відокремлюють роботу визначення того, чи визначається властивість, чи є вона дійсним і містить вміст відповідного змісту.
Стандартні властивості аудитора
Є кілька властивостей, спільних для всіх аудиторів:
Властивість Необхідна / Додатково Дозволені значення Потрібне ім'я для назви
унікальний рядок
Ім'я аудитора, як правило, ім'я вузла (з конфігурації JCR або YAML).
Важливо, щоб кожен аудитор мав унікальну назву серед усіх налаштованих аудиторів. Аудитори збережуть деякі результати за своїм ім'ям.
опис вимагав рядок
Короткий опис аудитора.
Опис відображається при виборі аудиту.
активний необхідний true, false
Визначає, чи активний аудитор.
AuditPageAction виконує лише активні аудитори, неактивні аудитори пропускаються.
FlexiAuditPageAction дозволяє користувачам вибирати, які аудитори запускаються, а також можна вибрати як активних, так і неактивних аудиторів.
HtmlElementAuditor
Назва класу: info.magnolia.services.seo.audit.impl.HtmlElementAuditor
HtmlElementAuditor перевіряє наявність вказаного елемента HTML. Якщо знайдений елемент HTML знайдений принаймні один раз, аудит проходить, інакше аудит не вдасться. HtmlElementAuditor може бути застосований до будь-якого вузла, який може бути виведений за допомогою Magnolia RenderingEngine.
HtmlElementAuditor використовує запити jsoup для розбору і пошуку елементів HTML https://jsoup.org докладніше про jsoup. Запити jsoup мають синтаксис типу jQuery або CSS.
Ось кілька прикладів.
a [href]
Знайти всі якірні елементи з атрибутом href.
meta [name = "keywords")
Знайти елементи ключових слів у HTML.
Подивитися https://jsoup.org/cookbook/extracting-data/selector-syntax більше про запити jsoup.
Ось приклад налаштованого HtmlElementAuditor:
На додаток до стандартних властивостей аудитора, описаних вище, HtmlElementAuditor може бути налаштований з такими властивостями:
Властивість Необхідна / Необов'язкова Дозволені значення Рівень приміток необхідний аудитПомилки, аудитПопередження, auditNotes Визначає, як буде враховано невдалий аудит: як помилка ( auditErrors ), як попередження ( auditWarnings ) або як примітка ( auditNotes ) auditProperty, що вимагає унікального рядка Визначає ім'я властивості для зберігання невдалих результатів аудиту. Ім'я властивості має бути унікальним серед аудиторів, або аудитори можуть перезаписати результати аудитуВизначення, яке вимагається в рядку
Визначає повідомлення або пояснення невдалого аудиту. У повідомленні можуть бути заповнювачі, які замінюються інформацією про вузол і аудитор:
0 - вузол шляху
1 - властивість налаштованих запитів
Приклад: Ой! Не вдалося знайти {1} на сторінці {0}! query required string Рядний запит jsoup. Подивитися https://jsoup.org/cookbook/extracting-data/selector-syntax більше про запити jsoup. invalidValue потрібно, якщо визначено valuePattern, необов'язково в іншому випадку рядок
Визначає повідомлення або пояснення, якщо результат запиту не відповідає valuePattern . У повідомленні можуть бути заповнювачі, які замінюються на:
0 - результат запиту
1 - значенняPattern
valuePattern необов'язковий дійсний вираз Java Якщо визначено, valuePattern буде застосовано до повернутих результатів запиту jsoup. Якщо valuePattern не відповідає результату, буде позначено результат аудиту рівня
I18NAditor
Назва класу: info.magnolia.services.seo.audit.impl.I18NAuditor
I18NAuditor знайде всі міжнародні поля на сторінці та визначить, чи має поле значення для всіх підтримуваних мов. Підтримувані мови та мови за замовчуванням виводяться з призначених сайтів, визначених у Менеджері сайтів.
Кожне поле зі значенням для підтримуваної мови буде підраховано, а загальна кількість всіх очікуваних значень для міжнародних полів буде нараховано. Співвідношення фактичних значень міжнародних полів до очікуваних міжнародних полів обчислюється і порівнюється з пороговими делегатами, визначеними для I18NAuditor.
Пороговий делегат визначає верхню і нижню межу для даного результату аудиту на основі фактичних значень міжнародних полів для очікуваних значень полів.
Наприклад, якщо фактичне / очікуване співвідношення:
- від 0 до 0,6 призведе до помилки
- від 0,6 до 0,8 призведе до попередження
- від 0,8 до 0,9 дасть записку
- більше 0,9, аудит пройшов
Порогові делегати замінюють властивість "level" для I18NAuditor і дозволяють їй повідомляти про проблеми різного ступеня тяжкості.
Крім того, загальні властивості, описані вище, можуть бути налаштовані з наступними властивостями:
Властивість Необхідна / Необов'язкова Дозволені значення Примітки auditProperty вимагає унікального рядка Визначає назву властивості для збереження невдалих результатів аудиту. Назва властивості повинна бути унікальною серед аудиторів або аудиторів, які можуть перезаписати їхні результати, переданіProperty необов'язково, унікальний рядок Визначає назву властивості для зберігання дійсних посилань. Ім'я властивості має бути унікальним серед аудиторів rootUrl, який вимагає рядка Визначає базову URL-адресу, яка буде використовуватися при перевірці відносних посилань. Відносні посилання додаються до базової URL-адреси, а потім перевіряються, тому основна URL-адреса має закінчуватися косою рискою. exceptLinks необов'язковий список регулярних виразів Java
Визначає один або кілька шаблонів URL-адрес, які потрібно ігнорувати. Ви можете визначити більше одного регулярного виразу.
Якщо регулярні вирази не визначені, всі посилання будуть перевірені.
Подивитися https://docs.oracle.com/javase/tutorial/essential/regex/ більше про регулярні вирази Java.
validStatuses необов'язково список кодів статусу HTTP як цілі числа
Визначає очікувані коди статусу HTTP для посилання, яке вважається дійсним.
Якщо не встановлено, список дійсних кодів стану: 200 (SC_OK).
pauseTime необов'язкове ціле число
Визначає затримку (у мілісекундах) між перевіркою посилань. Ви можете встановити це властивість ненульовим значенням, щоб уникнути затоплення сервера за допомогою HTTP-запитів.
Якщо не встановлено, час паузи буде 0 (без затримки між запитами).
I18NPropertyDefinitionAuditor
Назва класу: info.magnolia.services.seo.audit.impl.I18NPropertyDefinitionAuditor
I18NPropertyDefinitionAuditor є супутником для PropertyDefinitionAuditor. Замість того щоб перевіряти визначення властивості вузла для мови за замовчуванням, I18NPropertyDefinitionAuditor може перевірити, що значення визначені для всіх або деяких доступних мов для сайту.
Зверніть увагу, що I18NPropertyDefinitionAuditor просто перевіряє, чи визначено властивість, а не значення властивості. Ви можете використовувати I18NPropertyValidationAuditor, щоб перевірити, що значення для кожної мови є дійсними.
Ось приклад I18PropertyDefinitionAuditor:
I18NPropertyDefinitionAuditor може бути налаштований з такими властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Примітки propertyName необхідний рядок Визначає ім'я властивості вузла, який слід перевірити. Рівень необов'язкового аудитуВідхилення, аудитПопередження, перевіркизаписів
Визначає, як буде враховано невдалий аудит: як помилку (errorErrors), як попередження (auditWarnings) або як примітка (auditNotes)
validateAll необов'язковий true, false (за замовчуванням - true)
Контролює які мови буде перевірятися.
Якщо validateAll є істинним, властивість буде перевірятися на мовні варіанти для всіх мов, визначених для сайту.
Якщо validateAll є помилковим, перевіряються лише мовні варіанти, визначені властивістю expectedLanguages.
Очікується, що мови додатково містять список кодів мов або кодів мов плюс країни
expectedLanguages визначає список мов, які повинні перевірятися на мовні варіанти властивості. Це може бути підмножина мов, визначених для сайту. Мови, не включені до очікуваних мов, не перевіряються.
expectedLanguages буде використовуватися, тільки якщо для validateAll встановлено значення false.
I18NPropertyValidationAuditor
Назва класу: info.magnolia.services.seo.audit.impl.I18NPropertyValidationAuditor
I18NPropertyValidationAuditor є супутником PropertyValidationAuditor. Замість перевірки визначення властивості вузла для мови за замовчуванням, I18NPropertyValidationAuditor може перевірити значення призначеного властивості для всіх або деяких доступних мов для сайту.
Зверніть увагу, що I18NPropertyValidationAuditor просто перевіряє значення властивостей і не перевіряє, що всі мовні варіанти властивості визначені. Ви можете використовувати I18NPropertyDefinitionAuditor, щоб перевірити, що всі необхідні мовні варіанти властивості визначені.
Ось приклад I18NPropertyValidationAuditor:
I18NPropertyValidationAuditor може бути налаштований з такими властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Примітки propertyName необхідний рядок Визначає ім'я властивості вузла, який слід перевірити. Рівень необов'язкового аудитуВідхилення, аудитПопередження, перевіркизаписів
Визначає, як буде враховано невдалий аудит: як помилку (errorErrors), як попередження (auditWarnings) або як примітка (auditNotes)
validateAll необов'язковий true, false (за замовчуванням - true)
Контролює які мови буде перевірятися.
Якщо validateAll є істинним, всі властивості будуть перевірені на мовні значення для всіх мов, визначених для сайту.
Якщо validateAll є помилковим, перевірятимуться лише мови, визначені властивістю expectedLanguages.
Очікується, що мови додатково містять список кодів мов або кодів мов плюс країни
expectedLanguages визначає список мов, які повинні бути перевірені на значення властивостей. Це може бути підмножина мов, визначених для сайту. Мови, не включені до очікуваних мов, не перевіряються.
expectedLanguages буде використовуватися, тільки якщо для validateAll встановлено значення false.
valuePatterns необов'язково карта мовних кодів або мови плюс коди країн до значень регулярних виразів
Визначає шаблон перевірки - регулярний вираз Java - для перевірки значення властивості певної мови. Якщо значення властивості не відповідає шаблону значення для мови, аудит не пройде.
Якщо valuePatterns не має запису для певної мови, defaultValuePattern (див. Нижче) буде використовуватися для перевірки значення властивості мови.
Подивитися https://docs.oracle.com/javase/tutorial/essential/regex/ більше про регулярні вирази Java.
defaultValuePattern необов'язковий дійсний регулярний вираз Java
Визначає шаблон перевірки - регулярний вираз Java, який буде використовуватися, коли шаблон значення конкретного мови не було визначено у valuePattern. Якщо значення властивості не відповідає шаблону значення для мови, аудит не пройде.
Подивитися https://docs.oracle.com/javase/tutorial/essential/regex/ більше про регулярні вирази Java.
LinkAuditor
Назва класу: info.magnolia.services.seo.audit.impl.LinkAuditor
LinkAuditor знайде посилання на наданій HTML-сторінці і перевірить, чи є вони доступними. URL-адреси, що містяться в HTML-якорі, елементах посилання та img, вилучаються та перевіряються. Інші URL-адреси, наприклад URL-адреси, які містяться в функціях Javascript, не будуть виявлені, тому їх не буде перевірено.
Примітка: перевірка великої кількості посилань може зайняти багато часу, можливо, ви захочете використати властивість excludedLinks, щоб ігнорувати деякі посилання або запускати LinkAuditor тільки тоді, коли це необхідно.
Ось приклад LinkAuditor:
LinkAuditor може бути налаштований з наступними властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Рівень приміток необхідний аудитПомилки, аудитПопередження, auditNotes Визначає, як буде враховано невдалий аудит: як помилка (auditErrors), як попередження (auditWarnings) або як примітка (auditNotes) auditProperty, що вимагає унікального рядка Визначає ім'я властивості для зберігання невдалих результатів аудиту. Назва властивості повинна бути унікальною серед аудиторів або аудиторів, які можуть перезаписати їхні результати, переданіProperty необов'язково, унікальний рядок Визначає назву властивості для зберігання дійсних посилань. Ім'я властивості має бути унікальним серед аудиторів rootUrl, який вимагає рядка Визначає базову URL-адресу, яка буде використовуватися при перевірці відносних посилань. Відносні посилання додаються до базової URL-адреси, а потім перевіряються, тому основна URL-адреса має закінчуватися косою рискою. exceptLinks необов'язковий список регулярних виразів Java
Визначає один або кілька шаблонів URL-адрес, які потрібно ігнорувати. Ви можете визначити більше одного регулярного виразу.
Якщо регулярні вирази не визначені, всі посилання будуть перевірені.
Подивитися https://docs.oracle.com/javase/tutorial/essential/regex/ більше про регулярні вирази Java.
validStatuses необов'язково список кодів статусу HTTP як цілі числа
Визначає очікувані коди статусу HTTP для посилання, яке вважається дійсним.
Якщо не встановлено, список дійсних кодів стану: 200 (SC_OK).
pauseTime необов'язкове ціле число
Визначає затримку (у мілісекундах) між перевіркою посилань. Ви можете встановити це властивість ненульовим значенням, щоб уникнути затоплення сервера за допомогою HTTP-запитів.
Якщо не встановлено, час паузи буде 0 (без затримки між запитами).
Назва класу: info.magnolia.services.seo.audit.impl.MetaDescriptionAuditor
MetaDescriptionAuditor перевіряє вузол властивості з назвою "description" і, якщо визначено, перевіряє довжину значення.
Багато пошукових систем ігнорують довгі мета-описи - зазвичай весь текст приблизно з 160 до 180 символів. MetaDescriptionAuditor може допомогти вам перевірити сторінки для довгих метаописів.
Примітка: MetaDescriptionAuditor припускає, що властивість вузла "description" містить текст опису мета.
Ось приклад MetaDescriptionAuditor:
MetaDescriptionAudit може бути налаштований з такими властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Довжина примітки необов'язкова ціле число
Визначає максимальну довжину опису мета, довжини вище максимуму буде невдало з попередженням.
Якщо довжина не визначена, максимальна довжина буде 160.
ПакетLengthAuditor
Назва класу: info.magnolia.services.seo.audit.impl.ParagraphLengthAuditor
ParagraphLengthAuditor перевіряє довжину в словах елементів HTML, що містять текст, а не загальну довжину в символах. Ви можете використовувати ParagraphLengthAuditor для перевірки сторінок з надто довгими текстовими блоками.
ParagraphLengthAuditor може будь-який елемент HTML, який містить текст, який можна знайти за допомогою запиту jsoup.
Ось приклад за алгоритмом ParagraphLengthAuditor:
Параметр ParagraphLengthAuditor може бути налаштований з такими властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Рівень приміток необхідний аудитПомилки, аудитПопередження, auditNotes Визначає, як буде враховано невдалий аудит: як помилка (auditErrors), як попередження (auditWarnings) або як примітка (auditNotes) auditProperty, що вимагає унікального рядка Визначає ім'я властивості для зберігання невдалих результатів аудиту. Ім'я властивості має бути унікальним серед аудиторів, або аудитори можуть перезаписати результати аудиту
Визначає повідомлення або пояснення невдалого аудиту. У повідомленні можуть бути заповнювачі, які замінюються інформацією про вузол і аудитор:
0 - вузол шляху
1 - властивість налаштованих запитів
Приклад: Ой! Не вдалося знайти & # 123; 1 & # 125; на сторінці & # 123; 0 & # 125 ;! запитувати необов'язково рядок
Дійсний запит jsoup. Подивитися https://jsoup.org/cookbook/extracting-data/selector-syntax більше про запити jsoup.
Якщо не вказано, то параметр ParagraphLengthAuditor перевірить текст елементів "p" (абзацу) HTML.
maxWords необов'язково це ціле число
Визначає максимальну кількість слів, дозволених у текстовому блоці.
Якщо не вказано, ліміт буде 150.
PropertyDefinitionAuditor
Назва класу: info.magnolia.services.seo.audit.impl.PropertyDefinitionAuditor
PropertyDefinitionAuditor перевіряє, чи визначено властивість вказаного вузла. Він не перевіряє, якщо значення властивості, використовуйте PropertyValidationAuditor для цього.
Ви можете використовувати PropertyDefinitionAuditor для відсутності властивостей на сторінках або вузлах вмісту. Ви можете використовувати I18NPropertyDefinitionAuditor для перевірки визначення інтернаціоналізованих властивостей (властивості з варіантами мови).
Ось приклад налаштованого PropertyDefinitionAuditor:
PropertyDefinitionAuditor може бути налаштований з наступними властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Примітки propertyName необхідний рядок Визначає ім'я властивості вузла, який слід перевірити. Рівень необов'язкового аудитуВідхилення, аудитПопередження, перевіркизаписів
Визначає, як буде враховано невдалий аудит: як помилку (errorErrors), як попередження (auditWarnings) або як примітка (auditNotes)
PropertyValidationAuditor
Назва класу: info.magnolia.services.seo.audit.impl.PropertyValidationAuditor
PropertyValidationAuditor є супутником до I18NPropertyValidationAuditor. PropertyValidationAuditor перевіряє значення призначеного властивості. Якщо властивість інтернаціоналізовано (наприклад, властивість має мовні варіанти), використовуйте I18NPropertyValidationAuditor для перевірки значень властивості.
Зверніть увагу, що PropertyValidationAuditor просто перевіряє значення властивостей і не перевіряє, що всі мовні варіанти властивості визначені. Ви можете використовувати PropertyDefinitionAuditor, щоб перевірити, що властивість визначена.
Ось приклад PropertyValidationAuditor:
PropertyValidationAuditor може бути налаштований з такими властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Примітки propertyName необхідний рядок Визначає ім'я властивості вузла, який слід перевірити. Рівень необов'язкового аудитуВідхилення, аудитПопередження, перевіркизаписів
Визначає, як буде враховано невдалий аудит: як помилку (errorErrors), як попередження (auditWarnings) або як примітка (auditNotes)
Очікується, що мови додатково містять список кодів мов або кодів мов плюс країни
expectedLanguages визначає список мов, які повинні бути перевірені на значення властивостей. Це може бути підмножина мов, визначених для сайту. Мови, не включені до очікуваних мов, не перевіряються.
expectedLanguages буде використовуватися, тільки якщо для validateAll встановлено значення false.
valuePattern вимагав дійсний регулярний вираз Java
Визначає шаблон перевірки - регулярний вираз Java - для перевірки значення властивості. Якщо значення властивості не відповідає шаблону значень, аудит не виконається.
Подивитися https://docs.oracle.com/javase/tutorial/essential/regex/ більше про регулярні вирази Java.
ValidHtmlAuditor
Назва класу: info.magnolia.services.seo.audit.impl.ParagraphLengthAuditor
ValidHtmlAuditor перевіряє візуалізацію HTML сторінки для коректності за допомогою валідатора HTML W3C (див https://validator.w3.org для отримання додаткової інформації).
ValidHtmlAuditor захопить і збереже будь-які помилки HTML, знайдені валідатором HTML W3C; подивитися https://validator.w3.org/docs/errors.html більше про помилки HTML, повернені валідатором W3C.
Ось приклад:
ValidHtmlAuditor може бути налаштований з такими властивостями, на додаток до стандартних властивостей вище:
Властивість Необхідна / Необов'язкова Дозволені значення Рівень приміток необхідний аудитПомилки, аудитПопередження, auditNotes Визначає, як буде враховано невдалий аудит: як помилка (auditErrors), як попередження (auditWarnings) або як примітка (auditNotes) auditProperty, що вимагає унікального рядка Визначає ім'я властивості для зберігання невдалих результатів аудиту. Ім'я властивості має бути унікальним серед аудиторів, або аудитори можуть перезаписати результати аудиту
Визначає повідомлення або пояснення невдалого аудиту. У повідомленні можуть бути заповнювачі, які замінюються інформацією про вузол і аудитор:
0 - вузол шляху
1 - властивість налаштованих запитів
Приклад: Ой! Не вдалося знайти {1} на сторінці {0}! строгий необов'язковий true, false
Контролює рівень перевірки, виконаний валідатором HTML W3C.
Якщо встановлено значення true, HTML W3C поверне всі помилки, попередження та знайдені нотатки.
Якщо для строгої функції встановлено значення "false", повертаються лише помилки HTML.
Якщо не встановлено, для строгого значення встановлено значення false.