Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

여러 사용자가 동시에 문서를 편집할 수 있는 실시간 협업 플러그인입니다.

Image Added

지원 브라우저

  • 공식적으로 지원하는 웹 브라우저는 다음과 같습니다.
    • Microsoft Edge 최신버전
    • Google Chrome 최신버전
    • Apple Safari 최신버전
    • Mozilla Firefox 최신버전
  • 다른 브라우저에서도 작동할 수는 있지만 모든 기능이 올바르게 작동하지 않을 수 있습니다.
  • Internet Explorer 브라우저는 지원하지 않습니다.


사용방법

플러그인 파일 불러오기

Code Block
languagexml
themeEmacs
<!-- SynapEditor 객체가 존재해야 적용할 수 있기 때문에 에디터 스크립트 파일 아래에 include 해야 합니다 -->
<script src="collaboration.min.js의 url"></script>


플러그인 설정하기

웹소켓 URL 설정 (필수)

웹소켓 URL을 설정합니다. (필수) 설정을 하지 않으면 플러그인이 초기화되지 않습니다.

...

사용자의 이름과 커서의 색을 설정할 수 있습니다.설정을 하지 않으면 플러그인에 기본으로 정의된 이름과 색이

사용자 이름이 설정되지 않은 경우 10개의 형용사와, 10개의 동물 이름을 랜덤하게 조합해 표기합니다.

사용자 커서의 색이 설정되지 않은 경우 10개의 기본 색 목록에서 랜덤으로 설정됩니다.

Code Block
languagejs
themeEmacs
titlesynapeditor.config.js
//...
'collaboration.config': { 
    'userName': 'SynapEditor', // 사용자 이름 설정
    'userColor': '#39B6B8' // 사용자 커서 색 설정
}
// ...


기본 이름, 기본 색 설정

사용자 이름과 색을 설정을 하지 않았을 때 보여질 기본 이름 목록과 기본 색 목록을 설정할 수 있습니다.

사용자 이름(userName)과 색(userColor)을 설정하지 않은 경우 기본 이름 목록과 기본 색 목록에서 랜덤으로 설정됩니다.

Code Block
languagejs
themeEmacs
titlesynapeditor.config.js
//...
'collaboration.config': { 
    'defaultNames': ['강아지', '고양이', '참새'],  // 기본 이름 목록 설정
    'defaultColors': ['#CDB4DB', '#F5CAC3', '#87BBA2']  // 기본 색 목록 설정
}
// ...

커서 표시

  • 다른 사용자가 편집 중인 셀렉션 위치를 실시간으로 표시합니다. 
  • 다른 사용자의 셀렉션은 커서의 형태로 제공되며, 사용자 이름을 설정할 수 있습니다.
    Image Removed

...



접속 사용자 정보 보기

기본 제공 UI


Image Added

Image Added


  • 실시간 협업에 참여 중인 사용자 정보를 표시하는 UI가 기본으로 제공됩니다.
  • 툴바에 버튼 형태로 추가 할 수 있습니다.Image Removed
  • 사용자 이름이 설정되지 않은 경우 10개의 형용사와, 10개의 동물 이름을 랜덤하게 조합해 표기합니다.
    Image Removed
  • 사용자 이름과 색상은 설정으로 변경이 가능합니다.
  • 필요한 정보는 API형태로 제공됩니다.


Custom UI

Image Added

  • API정보로 직접 사용자 정보를 표현 할 수 있습니다.
  • 사용자 정보가 있다면 설정이 가능합니다.
    Image Removed



업데이트 기록 보기

  • 실시간 협업 중 발생한 편집 이력을 최대 100개까지 확인 할 수 있습니다.
  • 목록을 선택하여 편집 내용을 확인 할 수 있고 내용을 복원 할 수 있습니다.
  • 실시간 협업에 참여 중인 사용자가 없는 경우 내역이 초기화 됩니다.

적용예시

...