모듈:TemplateData/doc 포맷

Module

Format TemplateData – 템플릿 문서화를 위한 보조 기능이 있는 모듈, 특히 TemplateData에 의한 모듈.

주요 기능은 문서 페이지의 프레젠테이션 개선입니다.

템플릿 문서 페이지 개선– MediaWiki 실망

VisualEditor 계약에서 템플릿 묘사를 제시하기 위해 모든 마크업과 클릭 가능한 링크를 폐기하고 모든 환경에서 모든 툴팁을 사용할 수 있도록 했습니다.마크업과 클릭 가능한 링크가 있는 툴팁이 HTML 어플리케이션으로 지원되고 있으며 VisualEditor를 사용할 때는 JavaScript가 존재하지만 기본적으로는 타당합니다.

  • 그 결과 템플릿 문서 뷰에서의 프레젠테이션도 효과적인 링크나 마크업을 포함할 수 없게 되었습니다.
  • 많은 템플릿 매뉴얼페이지에서는 2개의 독립된 파라미터 매뉴얼테이블이 필요하며 동시에 유지관리해야 합니다.VisualEditor용 플레인텍스트 버전 1개로 링크와 마크업, 리스트와 테이블이 있는 복잡한 환경에 도움이 됩니다.– BTW, Visual Editor는 툴팁뿐만 아니라 정적 GUI 뷰도 갖추고 있습니다.이 경우 파라미터 설명에 심도 있는 링크가 존재하지 않습니다.

이 상태는 방어할 수 없습니다.

프레젠테이션 개선

MediaWiki에서 지원되며 VisualEditor에 표시되는 간단한 구문 외에 템플릿 문서 페이지의 JSON 코드에 다음 기능을 추가할 수 있습니다.InterfaceText로 분류된 요소에 영향을 미치지만 설명 필드에만 유용합니다.

Wikilinks(내부 형식)

  • 이중 대괄호 사용 시 공통으로 페이지를 연결할 수 있습니다.
  • VisualEditor 에서는 링크 제목만 표시되며, 링크 제목만 표시됩니다.

외부 링크(URL 형식)

  • 열려 있는 URL은, 그 자체로 통상과 같이 링크 됩니다.VisualEditor에서는 일반 텍스트로 표시됩니다.
  • 간단한 대괄호로 둘러싸인 외부 링크는 템플릿 문서 페이지에 정상적으로 표시됩니다.VisualEditor에서는 제목이 생략되고 URL이 표시되므로 사용자는 이를 c&p하여 브라우저의 주소 필드로 전송할 수 있습니다.그 밖에 다른 방법이 없다.

아포스트로프 '이탤릭체와 볼드체

  • 문서 페이지에서 강조하기 위해 사용할 수 있으며 VisualEditor(일반 스크립트)에는 없습니다.

HTML 엔티티

  • 다음 엔티티를 사용할 수 있습니다.< > & "  및 모든 숫자 형식.

HTML 태그

  • HTML 태그(및 미리 대체되지 않은 MediaWiki 요소)는 VisualEditor에서 제거됩니다.그렇지 않으면 유효합니다.
  • Atribute는 대부분의 경우 에 포함됩니다."JSON 구문과 경합합니다.확실히 하는 것이 중요합니다.'템플릿 트랜슬레이션에 문제가 있을 수 있습니다.

<noexport>…</noexport>

  • 둘러싸인 영역은 VisualEditor로 내보내지 않습니다.
  • 보다 복잡한 Wiki 구문 및 자세한 설명은 문서 페이지로 제한될 수 있습니다.
  • no export 영역 내에서는 소스 텍스트의 회선 구조가 고려됩니다.그렇지 않으면 VisualEditor에도 표시되므로 모든 것이 한 줄로 실행됩니다.

템플릿

  • 특히 템플릿 파라미터가JSON=를 사용하면 템플릿을 JSON 코드의 임의의 장소에 배포할 수 있습니다.그러나 확장된 구문이 JSON 구문과 충돌할 수 있습니다.

효과 향상

  • 상태(필수, 제안, 옵션, 권장되지 않음)에 따라 테이블 행이 밝은 파란색, 흰색, 회색 및 옅은 빨간색으로 강조 표시됩니다.
  • 상태별로 정렬할 때는 키워드의 알파벳 순서가 아니라 이 중요도가 고려됩니다.
  • 각 파라미터는 점프처로 지정할 수 있습니다.그 조각은#templatedata:parameter-name 입니다.
  • 누락된 라벨은 오류로 강조 표시됩니다.
  • 오류가 발생하면 유지 보수 범주가 트리거됩니다.
  • 파라미터가 없는 경우 요소는params:{}는 필수가 아닙니다.

단점 제거

2013-2017년에는 두 가지 측면이 특히 방해가 되는 것으로 나타났다.

  1. 파라미터가 전혀 정의되어 있지 않은 경우에도 내용이 없는 테이블에 대해서는 항상 테이블헤드가 표시됩니다.더군다나 이것은 분류할 수 있다.
    • Fabricator에서 축소가 거부되었습니다.테이블에는 행이 전혀 없고 헤더 행으로만 구성되어 있는 경우에도 파라미터의 정렬 가능한 테이블이 항상 필요합니다.
    • 이 어처구니없는 말이 2016년 이 모듈 개발로 이어졌다.
  2. 컨텍스트에서 기본값 또는 AutoValue 사양의 정의가 허용되지 않는 경우에도 개개의 파라미터 값별로 콘텐츠가 필요 없는6 행의 정의 리스트가 출력됩니다.

일반적인 코멘트를 보면 MediaWiki는 VisualEditor에서 TemplateData 사양의 프레젠테이션만을 중요하게 간주하고 있습니다.단, 사용자는 템플릿을 프로그래밍하고 유지관리해야 하며, 누군가는 템플릿 설명을 생성하여 Visual Editor 폼의 기능 외에 관리할 수 있도록 해야 합니다.그러나 이는 이해할 수 없습니다.

  • 2년 후, 비교적 쉬운 태스크인 Fabricator는 커뮤니티에서 유래한 패치를 통해 해결되었습니다.

일반 워크플로우

  • 전달된 템플릿파라미터에서 JSON 오브젝트(문자열)를 읽으려고 합니다.
  • 이 작업이 실패하면 현재 및 문서 페이지의 소스 코드가 검색됩니다.<templatedata>요소들.
  • JSON 객체 입력에서 다음 두 가지 표현을 얻을 수 있습니다.
    1. JSON 형식으로 현지화된 버전, 마크업 등이 삭제되었습니다.
    2. 기본적으로 MediaWiki 표현과 유사한 HTML 구조이며 파라미터 표가 있을 수 있으며 기능이 강화되어 있습니다.
  • 템플릿의 결과는 마크업과 함께 표시되는 문서와 숨겨진 문서입니다.<templatedata>요소.이는 내보내기에 대해 수행되며 MediaWiki 가이드라인에 준거합니다.
    • 현재 페이지가 문서 페이지로 식별된 경우 숨김 페이지<templatedata>는 억제되어 있습니다.이러한 페이지는, 「스페셜」에 개별적으로 표시되지 않습니다.Pages With Prop/templatata.

템플릿의 함수

세부 사항

에프
템플릿에서 사용되는 TemplateData-Presentation 개선:템플릿 데이터 포맷
템플릿 변환 환경의 파라미터(모두 옵션):
1
JSON 문자열 또는<templatedata>물건
JSON
JSON 문자열
(제1항)
이행처<templatedata>파이프 기호가 있는 개체에는 특별한 주의가 필요합니다.파이프는 다음과 같이 표시되어야 한다.{{!}}이중 괄호에서는 HTML 엔티티에 의해 부호화되어야 합니다.
TOC
1– 목차는 범용 설명 뒤에 삽입하지만 파라미터 목록 앞에 삽입(존재하는 경우)
예
언어
ISO 639 등에 따른 언어 코드
게으른
1– 프레젠테이션만, 효과적인 데이터 블록 생성 안 함
일반적인 방법에 대한 설명입니다.
디버깅
1– 개발자 모드
원천
1– 디버깅을 위한 효과적인 JSON 소스 텍스트(템플릿 확장 후) 표시
파라미터 #invoke 특정 프로젝트 어댑테이션(모두 옵션):
언어
ISO 639 등에 따른 언어 코드
디버깅
개발 모드(제공되어 동일하지 않은 경우)0
고양이
유효하지 않은 파라미터 값 등에 대한 유지보수 카테고리의 제목.
권장되지 않음 – 구성 모듈 사용
docpage Create(작성)
하위 페이지 이름 생성 패턴%s/Doku
권장되지 않음 – 구성 모듈 사용
docpageDetect(검출)
하위 페이지 이름 인식 패턴/Doku$
권장되지 않음 – 구성 모듈 사용
msgDescMiss
현지화: 분실 시 불만 사항 텍스트description
권장되지 않음 – 구성 모듈 사용
반환: HTML 코드 및/또는 오류 메시지(아마도 다음 중 하나)class="error"
페일 세이프
버전 관리

Lua 모듈(API)의 함수

위에서 설명한 일부 기능은 다른 모듈에서 사용할 수 있습니다.

현지의 행운의, 템플릿 데이터 = pcall( 요구하다, "모듈: 서식 템플릿 데이터" ) 한다면 유형( 템플릿 데이터 ) == "테이블" 그리고나서     템플릿 데이터 = 템플릿 데이터.템플릿 데이터() 또 다른     --failure. TemplateData는 오류 메시지입니다.     돌아가다 "<span class='error'>" .. 템플릿 데이터 .. "</span>" 끝.
TemplateData.failsafe(최소)
  1. 적어도
    선택적.
    0 또는 최소 버전 요청 또는"wikidata"
반환: string 또는 false
TemplateData.getPlainJSON(적응)
확장 JSON 정보를 MediaWiki JSON으로 축소합니다.
  1. 적응하다
    문자열, JSON 사용(확장)
반환: 문자열, JSON 포함(MediaWiki )
TemplateData.test(adapt, arglist)
템플릿 기능 시뮬레이션
  1. 적응하다
    테이블,#invoke파라미터
  2. 리스트
    테이블, 템플릿파라미터
반환: 문자열

사용.

현재 하나의 템플릿에만 초점을 맞추고 있습니다.

의존 관계

설정

로컬 모듈:서식 템플릿데이터/구성(존재하는 경우)을 사용하면 로컬 프로젝트에 쉽게 적응할 수 있습니다.

테이블은 다음을 통해 기대됩니다.mw.loadData. 다음 엔트리는 옵션컴포넌트입니다

고양이 문제
유효하지 않은 파라미터 값 등에 대한 유지보수 카테고리의 제목.
클래스 번호TOC
목차 클래스 이름. 특히 번호부여를 억제하기 위한 것입니다.
nonumtoc
클래스 테이블
테이블에는 파라미터 테이블에 대한 클래스가 포함되어 있습니다.
{ "wikitable" }
css패럴
단일 파라미터 포맷을 위한 CSS 할당이 있는 테이블
cssParWrap
파라미터 테이블 전체를 포맷하기 위한 CSS 할당이 있는 테이블
docpage Create(작성)
하위 페이지 이름 생성 패턴%s/Doku
%s/Doku
docpageDetect(검출)
하위 페이지 이름 인식 패턴/Doku$
/Doku$
도움말****************
세부 정보에 대한 상황별 도움말을 위한 링크 대상
헬프부리안
도움말 콘텐츠
help Date(도움말 날짜)
도움말 파일
도움말 포맷
Wikitext 변환 레이아웃에 대한 도움말에 대한 대상 링크 대상
헬프라인
도움말 번호
도움말 페이지
도움말 문자열
도움말 템플릿
도움말 URL
도움말 사용자
msgDescMiss
현지화: 분실 시 불만 사항 텍스트description
허용하다
단일 모수에 대한 특성 사양이 포함된 표, 성분:
불이 붙다
부울 표시 사양이 있는 표
2개의 컴포넌트true그리고.false– 각 표:
css
이 값에 대한 설명은 CSS가 있는 표에서 확인할 수 있습니다.
이끌다
true– 설명 표시0또는1각각 그 값보다 앞서서
false– 설명 표시0또는1각각 그 가치를 따르는
표시하다
설명, 문자열 또는false억누르다
css
파라미터 테이블의 렌더링 사양이 기재된 표.구성요소:
테이블 헤드
테이블 헤드용 CSS가 있는 테이블
필수의
CSS가 있는 테이블required
제안된
CSS가 있는 테이블suggested
선택적.
CSS가 있는 테이블optional
권장되지 않다
CSS가 있는 테이블deprecated