Discourse 문서 카드 필터

:discourse2: 요약 Discourse Docs Card Filter는 Discourse Docs 플러그인과 함께 사용되며, 사용자가 /docs 페이지에 진입할 때 더 빠른 필터 결과를 얻기 위해 클릭 가능한 필터 역할을 하는 "카드"를 배치할 수 있도록 합니다.
:eyeglasses: 미리보기 Discourse Theme Creator에서 미리보기
:hammer_and_wrench: 리포지토리 링크 https://github.com/discourse/discourse-docs-card-filter
:open_book: Discourse 테마 초보자? Discourse 테마 사용 입문 가이드

이 테마 컴포넌트 설치

기능

위 내용은 docs 플러그인에서 다음 설정으로 렌더링됩니다:

설정

카테고리 또는 태그 카드 필터마다 사용자 정의 아이콘을 선택할 수 있습니다. 또한 카테고리 카드 필터에 카테고리 설명이 렌더링되도록 허용할 수도 있습니다.

이름 설명
카테고리 아이콘 해당 카테고리 ID에 대한 아이콘 및 주제 순서를 선택합니다. 예: '6,heart,title-asc’는 카테고리 6에 하트 아이콘을 할당하고 주제 목록을 활동 순으로 정렬합니다. 참고: 순서는 (title,activity)-(asc/desc)일 수 있습니다.
카테고리 설명 docs 페이지의 카테고리 카드 필터에 카테고리 설명이 표시되도록 활성화합니다.
태그 아이콘 해당 태그 슬러그에 대한 아이콘 및 주제 순서를 선택합니다. 예: 'featured,heart,activity-desc’는 featured 태그에 하트 아이콘을 할당하고 주제 목록을 활동 순으로 정렬합니다. 참고: 순서는 (title,activity)-(asc/desc)일 수 있습니다.
번역 기본값
topics 주제들
topic 주제

:discourse2: 우리가 호스팅을 하고 있나요? 테마 컴포넌트는 Standard, Business, Enterprise 플랜에서 사용 가능합니다.

35개의 좋아요

이 기능을 만들어 주셔서 감사합니다! 사용자가 (비공개) 범리에 대한 보기 권한이 없으면, 검색 상단(또는 사이드바)에 해당 비공개 범리의 카드가 표시되지 않는 건가요? (일관된 동작인지 확인하고 싶어서요.)

1개의 좋아요

이렇게 되어야 합니다. 카테고리 정보는 다음 코드에서 가져오기 때문입니다.

@discourseComputed("category")
  categoryInfo(category) {
    return this.site.categories.findBy("id", category.id);
  },

제가 아는 바로는, this.site.categories는 현재 사용자가 볼 수 있는 카테고리만 반환합니다.

2개의 좋아요

훌륭네요. 이렇게 하면 여러 작업 그룹에 속한 사람들이 각 그룹의 참고 자료를 빠르게 접근하고, A그룹과 B그룹 등을 신속하게 필터링할 수 있어 실제로 사용하기 쉬운 도구가 될 것입니다. 감사합니다!

3개의 좋아요

/docs의 카운터가 이미 생성된 카테고리에서 나중에 이동된 주제들을 반영하지 못할 수 있나요?

방금 새 카테고리를 만들고 docs에 추가한 뒤 몇 가지 주제를 이동했는데, 카운터에는 여전히 "0 topic"이라고 표시됩니다.

수정: 업데이트에 시간이 좀 걸리는 것 같습니다.

카드의 정렬 순서를 변경할 수 있는 방법이 있을까요? 코드를 수정해야 하더라도 괜찮습니다. 주제 수 기준으로 정렬되는 대신, 알파벳 순서로 정렬되길 바랍니다. 감사합니다!

1개의 좋아요

안녕하세요. 문서(Docs)와 이 문서 확장 기능이 정말 훌륭합니다. 다만 한 가지 질문이 있습니다. 이 카드들을 top_menu나 홈페이지 섹션에 어떻게 추가할 수 있는지 도와주실 수 있나요? 기본적으로 '최신(Latest)'이 표시되는 표준적인 홈페이지를 유지하면서, 상단에 이 카드들이 표시되면 좋겠습니다. 그런 다음 카드를 클릭하면 필터링된 문서 페이지로 이동하면 완벽할 것 같습니다.

또한, top_menu 섹션에 다른 플러그인(검색 상자)이 하나 더 있습니다. 이 섹션에 여러 플러그인이 표시될 때 순서를 변경하는 방법을 아직 찾지 못했습니다.

감사합니다.

3개의 좋아요

Hey @jordan.vidrine

tc를 테스트해 보았는데, 사용 사례에 완벽하게 작동합니다. 이제 KB를 생성할 수 있습니다.

이 맥락에서 질문이 하나 있습니다: 각 카테고리 또는 태그 카드에 매개변수를 추가할 수 있는 우회 방법을 제안해 주실 수 있을까요? 이렇게 하면 각 개별 카테고리 또는 태그 카드의 정렬에 영향을 주기 위해 &order=title을 추가하고 싶습니다.

P.S.

음.. 잘 모르겠어요.

카테고리 및 태그 카드의 정렬 방식을 어떻게 원하시나요?

제이던, 안녕?

category icons 테마 설정에 정렬 파라미터를 추가할 수 있을 것 같아. 예를 들어, 6,heart의 경우 추가 정렬 명령을 붙일 수 있어. 예를 들어, 주제 제목 오름차순으로 정렬하려면 6,heart,title-asc처럼 사용할 수 있지.

카테고리 카드를 열면 문서 URL에 다음과 같은 파라미터가 자동으로 추가될 거야: /docs?ascending=true&category=71&order=title

이거 어떻게 생각해?

1개의 좋아요

사이트에서 잘 작동할 가능성은 있지만, 카드 정렬 기능에 초점을 맞춘 피드백이 거의 없는 상황이라, 현재 이 기능을 제대로 작동시키기에 소요되는 시간이 반드시 필요한 것은 아니라고 생각합니다.

다만, 컴포넌트에 대한 PR을 환영하며, 컴포넌트를 포크하여 원하는 방식으로 사용하는 것도 장려합니다!

이 기능을 포함한 PR을 자유롭게 제출하거나, 포크하여 직접 개발해 보세요.

3개의 좋아요

@jrgong이 이 작업을 후원하고 있으므로, 이 요청에 대해 PR을 만들 수 있습니다.

4개의 좋아요

이 글 다시 올립니다! 혹시 방법을 알아낸 분이 계신가요?

2개의 좋아요

제 해결책은 카드를 끄는 것이었습니다(카테고리가 너무 많아 어차피 유용하지 않으므로). 그리고 Docs의 정렬 순서를 수정했습니다. 자세한 내용은 여기에서 확인하실 수 있습니다: Modifying Discourse Docs to only allow for sorting by Title - #2 by Nick_Chomey

2개의 좋아요

우리 컴포넌트에 도움이 되는 PR은 언제나 환영합니다!

이 카드들을 정렬할 수 있는 기능을 추가하신다면, 카테고리 ID와 태그 ID를 기준으로 카드 순서를 지정할 수 있는 새로운 value-list를 생성하는 것을 제안합니다. 무관한 항목에 기존 value-list를 재사용하는 것은 권장하지 않습니다.

:smile:

1개의 좋아요

@jordan.vidrine 훌륭한 컴포넌트를 디자인해 주셔서 감사합니다. 모바일 기기에서는 비활성화하고 PC/Mac에서는 표시하는 방법이 있을까요?

공감합니다. 하지만 최소한 category icons 설정을 value-list로 바꿔주실 수 있을까요? 여러 텍스트 필드에서 카드를 관리하는 것이 하나의 필드에서 관리하는 것보다 훨씬 편합니다. :wink:

그리고 임시 대안으로, 각 문서 카드에 해당 카테고리나 태그 슬러그를 포함한 CSS 클래스가 붙어 있으면 정말 유용할 것 같습니다.

변경 전: <a class="docs-card-box category-card">
변경 후: <a class="docs-card-box [category-slug] category-card">

1개의 좋아요

좋은 제안입니다 :+1:

2개의 좋아요

테스트에 도움이 필요하면 말해 주세요. 기꺼이 실험용 쥐가 되어 드리죠 :slight_smile:

1개의 좋아요

좀 더 생각한 결과, category icons 설정을 값 목록(value list)으로 변경하는 방안을 보류하기로 했습니다. 폴백 옵션이 없으면 기존 사용자의 컴포넌트가 깨질 수 있기 때문입니다.

폴백을 추가하려면 사용자가 현재 필드에 아이콘을 설정했는지, 아니면 새로운 value-list 필드에 설정했는지를 확인하는 로직이 필요합니다. 하지만 이 컴포넌트에 이를 추가하는 것은 설정 계층을 하나 더 늘리고 혼란을 초래할 수 있어 지나치게 복잡하다고 생각합니다.

클래스 추가 건은 좋은 아이디어이지만, 더 시급한 작업들이 있어 언제 추가될지 일정은 아직 잡히지 않았습니다.

그럼에도 불구하고, 가능할 때 저희 컴포넌트에 대한 PR도 환영합니다. 결국 저희는 오픈 소스이니까요!

1개의 좋아요