Drupal용 Editoria11y

핵심 기능

Drupal 모듈은 검사기 라이브러리를 편집 백엔드와 연결하고, 보고, 거버넌스 및 구성을 위한 여러 서버 측 도구를 추가합니다

설치 및 주요 설정 단계

Drupal.org의 번들 설치 프로그램에는 여러 모듈이 포함되어 있습니다:

• Editoria11y: 핵심 콘텐츠 검사기 및 대시보드.
• Editoria11y CSA: 개발자 테스트 및 대시보드 유지 관리 도구.
• Editoria11y Export: CSV 보고 도구.

다른 모듈과 동일하게 설치한 후 다음 주요 단계를 수행하세요:

1. 권한을 확인하세요. 신뢰할 수 있는 작성자에게는 「확인 표시」, 「무시됨으로 표시」 및 「대시보드 보기」 권한이 있어야 합니다.
2. 주요 페이지에서 반복적이거나 도움이 되지 않는 알림을 확인하세요. 툴팁에서 확인으로 표시하거나, 구성을 조정하여 선택자로 요소를 무시하세요.
3. 보기 어려운 팁(화면 밖, 잘린 상태, 다른 요소 뒤, 숨겨진 요소에 있는 팁)을 찾으세요. 아래의 「팁 위치 수정」 안내를 참고하세요.
4. 사이트에 이미 콘텐츠가 있고 CSA 구독이 있는 경우, 대시보드 「재검사」 탭을 방문하여 사이트를 크롤링하고 보고서를 미리 불러오세요. 이 작업은 선택 사항이지만, 이전 페이지는 로그인한 사용자가 방문하거나 크롤링되기 전까지 보고서에 표시되지 않습니다.

구성 옵션에 대한 동영상 소개를 시청하세요(v2.4).

불필요한 알림 숨기기

좋은 구성은 불필요한 알림을 줄여 콘텐츠 작성자가 실제로 수정해야 할 문제에 집중할 수 있게 합니다.

테스트를 완전히 끌 수도 있지만, 특정 요소나 페이지에서 알림을 숨기는 것이 일반적으로 더 좋습니다.

각 테스트 실행 시, Editoria11y는 「이 컨테이너에서 콘텐츠 확인」 설정에서 단일 요소 집합을 수집한 후 여러 번 필터링합니다. 테스트 실행의 모습은 다음과 같습니다:

1. 이 페이지 또는 이 사용자에 대한 구성이 검사를 방지하는 경우 검사를 취소합니다.
2. 수집: 지정된 페이지 영역의 요소 수집, 예:
   body > *:not('.ed11y-element')
   Editoria11y CSA 사용자의 경우, 이는 개발자 테스트 탭의 영역입니다.
3. 제외: 무시 선택자와 일치하는 요소 제외, 예:
   .widgets, .utility-menu
   Editoria11y CSA 사용자의 경우, 이는 개발자 테스트 탭의 선택자입니다.
4. 테스트를 실행하고 결과를 대시보드에 동기화합니다.
5. 분리 구성이 활성화되어 있고 사용자가 콘텐츠 편집자인 경우, 개발자 결과를 필터링합니다:
   • 제외: 「개발자 전용」으로 설정된 테스트의 결과 제외.
   • 제외: 지정된 콘텐츠 영역 밖의 요소에 대한 결과 제외, 예:
     main, footer
   • 제외: 콘텐츠 무시 선택자와 일치하는 요소에 대한 결과 제외.
   Note that there is not a second "gather" phase. The developer page regions must include the content regions.
6. 자동 열기 설정과 구성이 일치하면 패널을 열고 알림을 표시합니다.

알림 닫기

테스트는 라이브러리에서 오류 또는 경고(「수동 확인」)로 구성할 수 있습니다. 경고는 닫을 수 있습니다. 각 툴팁 하단에서 두 가지 유형의 닫기가 제공됩니다:

• 「무시」는 사용자 기본 설정으로 저장됩니다. 알림은 현재 사용자에게만 숨겨지며, 다른 사용자에게는 그대로 표시됩니다.
• 「확인 표시」는 모든 사용자에게 알림을 숨깁니다.

사용자가 알림을 닫을 수 있는지 여부는 Drupal 사용자 권한에서 역할 수준으로 제어됩니다. 대부분의 작성자는 알림을 닫을 수 있어야 합니다. 항목이 확인되었음을 표시할 수 없다면 수동 확인을 할당하는 의미가 없습니다.

요소 무시

이 두 가지 구성 설정이 가장 중요합니다!

콘텐츠 작성자가 편집할 수 있는 페이지의 모든 부분을 포함하도록 첫 번째를 설정하세요. 예를 들어, main 콘텐츠 영역, .sidebar 및 .footer-column-two를 편집할 수 있다면 해당 선택자를 콘텐츠 확인 영역으로 설정하세요.

두 번째를 사용하여 하위 섹션을 「제외」하세요. 예를 들어, main에 개발자만 수정할 수 있는 다양한 위젯과 임베드가 포함되어 있다면 해당 항목을 나열하세요: .widget-1, .social-embed;

분리 구성을 사용하는 경우, 개발자 테스트 탭에서 유사한 설정 쌍을 볼 수 있습니다:

개발자 확인 영역에 대해 알아야 할 핵심은 콘텐츠 확인 영역과 독립적이지 않다는 것입니다. 분리 구성에서 개발자 영역을 확인한 후 해당 결과를 콘텐츠 영역에 맞게 필터링합니다. 개발자에게 제외된 영역은 콘텐츠 편집자에게도 제외됩니다. 편집 가능한 콘텐츠 영역을 제외하지 마세요!

일부 테스트는 영향받은 요소에서 특정 알림만 숨길 수 있도록 더 정밀한 구성을 허용합니다. 다음에서 확인하세요:

• 콘텐츠 테스트: 확인할 링크
• 콘텐츠 테스트: 확인할 임베드
• 콘텐츠 테스트: 동적 및 섀도우 콘텐츠 감지
• 개발자 테스트: 명도 대비

특정 페이지 또는 사용자에게 숨기기

이를 수행하는 가장 쉬운 방법은 이 옵션에 CSS 클래스 또는 ID를 전달하는 것입니다:

첫 번째는 검사 실행을 방지하며 툴바가 표시되지 않습니다.

두 번째는 검사기를 최소화된 상태로 시작하고, (현재 사용자에 대해) 오류인 경우에도 모든 문제를 자동으로 「무시됨」으로 표시합니다. 이를 통해 테스트를 실행하고 대시보드를 업데이트할 수 있지만 사용자를 방해하지 않습니다.

이를 사용하여 어떤 사용자가 검사기를 볼지 제어하려면 테마를 조정하여 클래스(예: .user-247)를 출력해야 할 수 있습니다.

사이트 전체 결과 관리

숨겨지거나 화면 밖 팁 수정

모듈은 팁 배치 방법을 변경하기 위한 라이브러리 구성 옵션 두 가지의 필드를 제공합니다:

일부 테마에는 가로 또는 세로 오버플로를 숨기는 열이나 위젯이 있습니다. 라이브러리는 토글이 페이지의 보이는 부분 밖에 위치할 때 자동으로 감지합니다. 특정 컨테이너가 오버플로를 숨긴다고 라이브러리에 알리면 해당 컨테이너 내의 요소에 대한 팁을 컨테이너 경계 내에 배치하려고 시도합니다.

일부 테마에는 아코디언, 탭, 슬라이드쇼와 같이 콘텐츠의 가시성을 전환하는 위젯이 있습니다. 이 요소 내의 팁도 숨겨집니다. 이러한 위젯의 선택자 목록을 제공하면 사용자가 이전 또는 다음 버튼을 사용하여 해당 팁으로 이동하려 할 때 Editoria11y가 잠시 일시 중지합니다. Drupal 테마와 모듈은 숨겨진 콘텐츠의 팁 처리에 관한 라이브러리 섹션의 지침을 따라 숨겨진 콘텐츠를 표시할 수 있습니다.

사용자 정의 구성 작성

PHP에서: Drupal 모듈은 모듈이나 테마에서 drupalSettings.editoria11y의 내용을 변경하기 위한 hook_editoria11y_alter_config를 제공합니다. 예를 들어:

drupalSettings 수정은 모듈 JS가 이미 해당 값을 라이브러리에 전달하도록 설정되어 있는 경우에만 도움이 됩니다. 파라미터를 더 추가하려면 JS options 객체를 직접 수정해야 합니다. 모듈은 editoria11yOptionsOverride라는 하나의 전역 JS 변수를 확인합니다. 이것이 설정되면 모듈 또는 테마에서 제공한 editoria11yOptions 함수에 options 객체를 전달합니다. 이제 라이브러리 파라미터를 모두 설정할 수 있습니다.