툴허브
툴허브는 위키미디어 운동에 사용되는 소프트웨어 도구의 커뮤니티 관리 카탈로그입니다. 기술 지원자는 툴허브를 사용하여 자신이 만들거나 유지 관리하는 도구를 문서화할 수 있습니다. 모든 위키미디어인들은 툴허브를 사용하여 작업 흐름에 도움이 되는 도구를 검색하고 다른 사람과 공유할 유용한 도구 목록을 만들 수 있습니다.
"도구"란 무엇입니까?
툴허브에서 "도구"는 미디어위키에서 완전히 구현되지 않고 위키미디어 프로젝트와 상호 작용하는 소프트웨어 애플리케이션을 포괄적으로 지칭하는 용어입니다. 여기에는 사용자 스크립트, 소도구, 봇, 틀, 루아 모듈, 웹 애플리케이션, 모바일 앱 등이 포함됩니다. 카탈로그는 위키미디어 운동의 프로젝트와 상호 작용할 때 워크플로와 사용자 경험을 개선하는 데 유용한 문서인 한 배타적이기보다는 포괄적으로 의도되었습니다.
콘텐츠 라이선스
툴허브에서 수집된 Toolinfo.json 데이터 및 기타 구조화된 데이터는 크리에이티브 커먼즈 CC0 기부(CC0, Creative Commons CC0 Dedication)에 따라 라이선스가 부여됩니다. 재사용자는 툴허브에 다시 연결하여 속성을 제공하는 것이 좋지만 라이선스 준수를 위해 필수 사항은 아닙니다. 외부에서 호스팅되는 toolinfo.json 데이터 파일의 관리자는 기여자가 CC0 라이선스 요구 사항을 알고 있는지 확인해야 합니다. 비CC0 라이선스에 따라 위키미디어 콘텐츠 위키 또는 기타 문서에서 복사한 도구정보 데이터는 복사된 설명 콘텐츠를 50단어/250자로 제한하여 속성과 같은 잠재적인 저작권 라이선스 의무에 대한 주장을 제한해야 합니다. 단어/문자 제한은 "복사된 콘텐츠에만 적용"되며 원본 CC0 설명은 길이 제한이 없습니다.
사용자 계정
툴허브는 OAuth 인증을 사용하여 사용자가 위키미디어 위키 사용자 계정을 사용하여 툴허브에 로그인할 수 있도록 합니다. 새 계정이나 암호가 필요하지 않습니다.
카탈로그에 도구 추가
도구는 등록된 toolinfo.json 파일 URL에서 읽거나 툴허브 API에 직접 데이터를 전송하여 툴허브 카탈로그에 추가할 수 있습니다.
toolinfo.json 파일을 Git 저장소의 일부로 호스팅하면 자원봉사자가 풀 리퀘스트를 제출하여 핵심 도구 정보를 최신 상태로 유지할 수 있습니다.
도구정보 파일을 게시하고 툴허브의 웹 크롤러에 등록하십시오
도구정보 파일은 도구정보 스키마를 준수하는 JSON 문서입니다. 이 표준은 원래 Husky가 헤이의 디렉토리 도구의 일부로 개발한 도구정보 사양의 확장입니다.
- 스키마에 맞는 JSON 파일 생성
- 해당 파일을 웹사이트에 게시
- 툴허브 UI를 사용하여 툴허브의 웹 크롤러에 파일의 URL을 등록하세요.
툴허브는 약 60분마다 등록된 각 도구정보 URL을 확인하고 변경 사항으로 카탈로그를 업데이트합니다.
실제 도구의 toolinfo.json 파일 예:
 | Toolforge에서 호스팅되는 도구는 toolsadmin을 사용하여 툴허브 및 헤이의 디렉토리에서 자동으로 가져올 도구정보 기록을 만들 수 있습니다. |
툴허브 사용자 인터페이스를 사용하여 도구정보 기록 생성 및 편집
"도구 추가 또는 제거 > 툴허브에서 새 도구 만들기" 화면을 사용하여 툴허브 카탈로그에서 직접 새 도구 정보 레코드를 만들 수 있습니다. 도구정보 생성 양식에서 수집되지 않은 추가 정보는 도구의 "편집 도구" 화면을 사용하여 후속 편집을 통해 추가할 수 있습니다.
툴허브 API를 사용하여 도구정보 레코드 생성 및 편집
툴허브 API의 POST /api/tools/ 끝점을 사용하여 툴허브 카탈로그에서 직접 새 도구정보 기록을 만들 수 있습니다. 이 API는 툴허브 사용자 인터페이스에서 배후에서 사용됩니다. 이 API 끝점의 예상 입력 및 출력에 대한 자세한 내용은 툴허브의 API 설명서를 참조하십시오.
편집 도구 정보
도구 정보 레코드에 포함된 정보 중 일부는 누구나 편집할 수 있지만 일부는 소유자나 관리자만 편집할 수 있습니다. 툴허브의 데이터 모델은 도구 정보를 핵심 도구 정보와 주석의 두 부분으로 나눕니다.
| 메타데이터의 종류 | 그것이 어떻게 만들어지는가 | 누가 그것을 바꿀 수 있나요? | 변경 사항을 적용할 위치 |
| 핵심 도구 정보
도구에 대한 기본적이고 필수적인 정보입니다. |
API 또는 툴허브를 사용하여 생성(UI는 백엔드의 API를 사용함)
또는 크롤링할 toolinfo.json URL을 제출하여 |
소유자, 관리자 및 기록보호자
또는 외부에 저장된 toolinfo.json 파일을 변경하거나 풀 리퀘스트를 제출할 수 있는 사용자 |
기록이 생성된 동일한 장소. 도구 기록이 원래 툴허브를 통해 제출된 경우 툴허브를 통해서만 편집할 수 있습니다.
도구 기록 데이터가 toolinfo.json 파일에 외부적으로 저장된 경우 해당 파일에서만 편집이 가능합니다. |
| 커뮤니티 주석
도구에 대한 추가 정보. |
툴허브 UI, API 또는 API를 사용하는 툴헌트와 같은 도구를 통해 | 위키미디어 계정이 있는 인증된 사용자 | 툴허브 UI, API 또는 API를 사용하는 툴헌트와 같은 도구를 통해 |
핵심 도구 정보
툴허브의 모든 도구에는 도구 이름 및 작성자와 같은 기본 정보가 포함된 핵심 도구 레코드가 있습니다. 소유자, 관리자 및 감독자만 툴허브의 핵심 도구 정보를 편집할 수 있습니다. 도구 핵심 정보의 소유자는 툴허브 내에서 도구를 만든 사용자입니다(도구를 만든 방법과 관계없이).
외부에 저장된 도구 정보 레코드의 경우 크롤링된 도구 정보 파일을 편집할 수 있는 권한이 있는 사람은 누구나 핵심 도구 정보를 편집할 수 있습니다.
편집 도구 URL
도구의 URL은 핵심 도구 정보 데이터의 일부입니다. 이는 toolinfo.json 파일의 일부로 제출하거나 도구정보 레코드의 소유자가 UI 및 API를 통해 편집할 수 있음을 의미합니다. 현재는 커뮤니티 전체에서 편집할 수 없습니다. "편집" 버튼을 클릭한 후 "핵심 도구 정보 편집"을 선택할 수 있는 경우에만 도구의 URL을 편집할 수 있습니다. 그렇지 않으면 도구 정보 레코드의 "주석" 레이어를 편집하기 위한 양식이 표시됩니다. 도구의 URL을 편집할 수 없습니다.
귀하가 도구 관리자이고 귀하의 레코드를 https://toolsadmin.wikimedia.org에서 가져온 경우 toolsadmin의 편집 양식은 양식 하단 근처에 "이것은 웹 서비스입니다"라는 확인란이 표시됩니다. 도구정보 레코드의 URL을 자동으로 설정하려면 이 상자를 선택하십시오. 툴허브 크롤러는 한 시간에 한 번 실행되므로 Toolsadmin을 통해 수행된 toolinfo 레코드의 변경 사항이 표시되는 데 한 시간 이상 걸립니다.
커뮤니티 주석
툴허브에서 핵심 도구 기록을 받으면 자원봉사자는 주석을 제출할 수 있습니다. 주석은 추가 정보를 제공하여 도구를 더 쉽게 찾을 수 있도록 도와줍니다. 주석은 toolinfo.json 파일에 저장할 수 없습니다. 커뮤니티 구성원이 항상 편집할 수 있도록 되어 있습니다.
주석 필드는 다음과 같습니다:
- 아이콘
- 도구가 더 이상 사용되지 않거나 실험적이거나 다른 도구로 대체되는지 여부
- 도구 유형
- 위키의 경우
- 청중
- 콘텐츠 유형
- 작업
- 주제 도메인
- 사용 가능한 UI 언어
- 링크: API, 최종 사용자 문서, 피드백, 개인 정보 보호 정책, 버그 추적기, 번역, 개발자 문서
- 위키데이터 QID
주석 레이어의 일부인 필드에 대한 세부 정보는 https://toolhub.wikimedia.org/api-docs#put-/api/tools/-name-/annotations/의 API 설명서에 있습니다.
일부 주석은 핵심 toolinfo.json 사양의 필드를 반영합니다. 툴허브는 핵심 레코드의 해당 필드가 비어 있거나 누락된 경우에만 커뮤니티 편집을 위한 주석 필드를 표시합니다. 주어진 필드에 대한 핵심 데이터와 주석 데이터가 모두 채워지면 툴허브는 주석 데이터가 아닌 핵심 데이터를 표시합니다. 이는 도구 유지 관리자가 데이터 레코드를 최종적으로 제어하려는 욕구와 커뮤니티가 도구에 대한 문서를 개선할 수 있기를 바라는 상충되는 욕구 사이의 타협안으로 선택되었습니다.
도구 찾기
검색 화면은 Elasticsearch 단순 쿼리 문자열 구문을 사용합니다:
+는 AND 연산을 나타냅니다.|는 OR 연산을 의미합니다.-는 단일 토큰을 무효화합니다."는 검색할 구문을 나타내기 위해 여러 토큰을 래핑합니다.- 용어 끝에 있는
*는 접두사 쿼리를 의미합니다. (및)은 우선 순위를 나타냅니다.~N 편집 거리를 의미하는 단어 뒤(흐릿함)~N 슬롭 금액을 의미하는 구 뒤에- 특수 문자(
+,|,-,",*,(,)그리고~)는\로 이스케이프 처리하거나 검색할 따옴표로 묶어야 합니다. - 검색은 대소문자를 구분하지 않습니다.
자동 완성 기능은 검색어를 입력할 때 관련 추천을 제공하도록 설계되었습니다.
도구 목록 생성 및 공유
"제 목록" 화면은 로그인한 사용자가 사용할 수 있는 사용자 메뉴의 링크에서 찾을 수 있습니다. 언어 선택기 옆 상단 탐색 표시줄에서 사용자 아이콘을 클릭하여 사용자 메뉴를 엽니다. 여기에서 도구 목록을 만들고 편집할 수 있으며 준비가 되면 공개로 표시하여 다른 사람과 공유할 수 있습니다.
도구 카드의 메뉴 버튼과 도구 정보 페이지의 메뉴 버튼에서 직접 기존 또는 새로 생성된 목록에 도구를 추가(또는 제거)할 수도 있습니다.
공개 및 추천 목록
공개 목록은 왼쪽 탐색 창에서 '게시된 목록' 섹션으로 이동하여 보고 검색할 수 있습니다. 관리자는 공개 목록을 추천으로 표시하여 툴허브 랜딩 페이지에 표시할 수 있습니다.
목록은 브라우저의 URL 표시줄에서 목록의 URL을 복사하거나 목록 세부 정보 화면에서 링크 복사 및 다른 사람과 공유 링크를 클릭하여 공유할 수 있습니다.
즐겨찾는 도구를 특별 목록에 저장
도구는 로그인한 사용자가 "즐겨찾기"로 표시할 수 있습니다. 즉, 현재 사용자만 볼 수 있는 특별 목록에 도구가 저장됩니다. 이 즐겨찾기 목록은 오른쪽 상단 모서리에 있는 사용자 메뉴에서 접근할 수 있습니다. 도구를 즐겨찾기로 표시하려면 도구 카드를 클릭하여 도구 정보 페이지에 도달한 다음 즐겨찾기 버튼을 클릭하십시오.
사용자 권한 수준
익명 사용자
모든 읽기 전용 작업은 툴허브에 인증하지 않고 사용할 수 있습니다.
사용자
인증된 사용자는 익명 사용자와 동일한 방식으로 모든 읽기 전용 작업을 수행할 수 있습니다. 또한 새 도구 정보 레코드를 만들고, 이전에 만든 도구 정보 레코드를 편집하고, 다른 사람이 만든 도구 레코드에 주석을 추가하고, 새 목록을 만들고, 이전에 만든 목록을 편집할 수 있습니다.
사무관
사무관은 자신을 포함한 다른 사용자의 권한을 변경할 수 있습니다. 여기에는 권한 부여 및 제거가 모두 포함됩니다.
점검자
점검자는 모든 도구 정보 레코드에 대한 편집 내용을 검토하고 점검됨으로 표시하거나 점검되지 않은 상태로 둘 수 있습니다. 현재 점검자가 편집을 거부할 수 있는 방법은 없습니다.
기록보호자
기록보호자는 모든 편집 내용을 숨길(감독/억제) 수 있습니다. 이전에 숨겨진 편집 내용을 표시할 수 있습니다. 기록보호자는 또한 다른 사용자가 만든 도구 정보 레코드 및 목록을 편집하여 문제 콘텐츠를 제거하기 위해 변경 사항을 되돌리거나 새로 편집할 수 있습니다.
관리자
관리자는 사무관, 점검자 및 기록보호자의 모든 능력을 가집니다.
점검 변경
점검자와 관리자는 변경 사항을 순찰할 수 있습니다. 점검 권한은 사무관 또는 관리자가 부여합니다.
도구 정보 또는 도구 목록 레코드가 변경되면 다음 세 위치 중 하나에서 순찰할 수 있습니다:
- 페이지 기록에서: 기록된 항목에서 "점검된 것으로 표시" 옵션을 클릭합니다.
- 변경 자체에 대한 링크에서: 페이지 상단의 변경 요약 정보에서 "점검된 것으로 표시" 링크를 클릭합니다.
- 왼쪽의 탐색 창에서 접근할 수 있는 "최근 변경사항"에서. 여기에서 레코드 유형(도구 또는 목록), 사용자 이름 및 점검 상태와 같은 여러 기준으로 최근 변경 사항을 검색하고 필터링할 수 있습니다.
변경 사항은 수락(점검)하거나 그대로 둘 수만 있습니다. 거부하거나 사양할 수 없습니다.
사용자 권한 변경
관리자와 사무관은 자신과 다른 사용자의 권한을 변경할 수 있습니다. 권한을 추가하거나 제거할 수 있습니다. 각 개별 권한 추가 또는 제거는 감사 로그에 표시됩니다. 즉, 두 개의 권한이 변경되면 각 권한에 대해 하나씩 두 개의 감사 로그 항목이 있게 됩니다.
권한을 추가하려면
- "회원" 화면으로 이동합니다.
- 수정할 사용자를 선택합니다. 검색 필터를 사용하여 사용자를 찾습니다.
- 사용자 이름 뒤의 연필 아이콘을 클릭합니다. 사용자의 현재 권한을 보여주는 대화 상자가 표시됩니다.
- 드롭다운 목록에서 추가할 그룹을 선택합니다.
- "추가" 버튼을 클릭합니다.
- 변경이 성공했다는 알림이 화면에 나타납니다.
권한을 회수하려면
- "회원" 화면으로 이동합니다.
- 수정할 사용자를 선택합니다. 검색 필터를 사용하여 사용자를 찾습니다.
- 사용자 이름 뒤의 연필 아이콘을 클릭합니다. 사용자의 현재 권한을 보여주는 대화 상자가 표시됩니다.
- 제거할 권한을 식별합니다. 권한을 회수하려면 빨간색 휴지통 버튼을 클릭하십시오.
- 변경이 성공했다는 알림이 화면에 나타납니다.
기록보호
기록보호자를 통해 도구정보 레코드에 대한 개별 편집 내용을 숨길 수 있습니다. 예를 들어 사용자가 개인 정보를 실수로 게시한 경우에 사용할 수 있습니다. 관리자와 기록보호자는 편집 내용을 숨기거나 표시하는 데 필요한 권한이 있습니다.
기록보호된 개정에는 개정 날짜/시간, 사용자 이름 및 도구정보 레코드의 기록 보기에 숨겨진 편집 요약이 있습니다. 모든 기록보호 조치는 기록보호자의 이름을 포함하여 감사 로그에 기록됩니다.
개정을 숨기려면
- 숨길 콘텐츠를 식별합니다.
- 기록을 검토하여 콘텐츠가 처음 추가된 시기를 식별합니다.
- 숨길 콘텐츠가 더 이상 도구정보 레코드에 표시되지 않는지 확인합니다.
- 여전히 표시되는 경우 도구벙보 레코드 소유자, 관리자 또는 기록보호자는 도구정보 레코드를 편집하여 문제 콘텐츠를 제거할 수 있습니다.
- 도구정보 레코드 기록에서 기록보호해야 하는 모든 변경 사항을 식별합니다.
- 개정판을 숨기려면 "숨기기" 링크를 클릭하십시오.
- 모든 관련 편집을 기록보호하기 위해 필요에 따라 반복합니다.
숨겨진 버전을 표시하려면
- 도구정보 레코드 기록에서 공개해야 하는 모든 변경 사항을 식별합니다.
- 개정판을 보려면 "공개" 링크를 클릭하십시오.
- 필요한 만큼 반복하여 관련 편집 내용을 모두 표시합니다.
번역
위키미디어 재단의 다른 프로젝트 및 도구와 마찬가지로 도구정보의 언어 번역은 translatewiki.net 커뮤니티에서 처리합니다.
툴허브는 번역 완료가 아닌 알려진 언어 목록을 기반으로 언어 선택을 제공합니다. 그리고 선택한 언어 또는 다른 구성된 대체 언어로 된 문자열에 대한 번역이 없는 경우 영어로 기본 설정하여 다양한 관련성 순서로 대체 언어 목록을 기반으로 번역을 제공하도록 구성됩니다. 이러한 이유로 페이지의 번역 중 일부는 선택한 언어로 되어 있고 다른 일부는 다른 언어나 영어로 되어 있는 상황을 자주 접하게 됩니다. translatewiki.net에서 도구 허브 번역에 자원하여 이 문제를 해결하는 데 도움을 줄 수 있습니다.