예제 Readme 도구

소개

Readme 편집기에서는 다른 플러그인이 사용할 사용자 확장점을 정의하는 방법을 표시합니다. 또한 자원 팝업 메뉴 항목의 확장, 새 자원 마법사, 확장자(.readme) 파일 편집기, 사용자 정의 보기 및 특성 페이지를 작성하는 방법을 표시합니다.

예제 실행

이 예제를 사용하여 시작하려면 파일 작성 마법사를 사용하여 확장자가 .readme인 파일을 작성하거나 예제 작성 마법사를 사용하여 파일을 작성하십시오. 이 예제에서 제공하는 추가 보기는 창 > 보기 표시 > 기타를 선택하고 Readme 섹션을 펼쳐서 표시할 수 있습니다. 조치 보기는 네비게이터 보기에서 readme 아이콘을 클릭하여 표시할 수 있습니다.

새 Readme 파일 작성

확장자가 .readme인 새 파일을 작성하십시오.  파일 메뉴에서 새로 작성을 선택한 다음 서브 메뉴에서 기타...를 선택하십시오.  마법사에서 단순을 클릭한 다음 왼쪽 목록에서 파일을 선택하십시오.  다음을 클릭하여 파일 이름(확장자가 .readme인지 확인하십시오) 및 파일이 포함된 폴더를 제공하십시오.

예제 작성 마법사

파일 메뉴에서 새로 작성을 선택하고 서브 메뉴에서 예제...를 선택한 다음  예제 작성 마법사를 선택하십시오. Readme 파일을 선택하십시오. 다음을 클릭하십시오. 파일을 작성하려는 대상 폴더를 선택하십시오. 확장자가 .readme인 파일 이름을 입력하십시오. 완료를 클릭하십시오.

Readme 보기 확장 조치

네비게이터 보기에서 확장자가 .readme인 파일을 선택하십시오. 파일이 없으면 해당 확장자를 가진 파일을 작성하십시오. 네비게이터 보기의 로컬 도구 모음에 Readme 보기 확장 실행이라고 표시된 풍선 도움말을 가진 단추가 표시됩니다.  이 단추를 클릭하십시오.  실행된 조치 보기라고 표시된 대화 상자가 나타납니다.

팝업 메뉴

네비게이터 보기에서 확장자가 .readme인 파일을 선택하십시오.  파일이 없으면 해당 확장자를 가진 파일을 작성하십시오.  파일을 선택하여 팝업 메뉴를 표시하십시오.  팝업 메뉴에서 Readme 조치 표시라고 표시된 메뉴 항목이 있는지 주의하십시오.  이 메뉴 항목을 선택하여 실행된 팝업 메뉴 조치라고 표시된 대화 상자를 여십시오.

환경 설정 페이지

창 메뉴에서 환경 설정을 선택하십시오.  Readme 예제라고 하는 페이지를 클릭하십시오.  이 페이지에는 환경 설정 페이지의 예제가 표시됩니다.

특성 페이지

네비게이터 보기에서 확장자가 .readme인 파일을 선택하십시오.  파일이 없으면 해당 확장자를 가진 파일을 작성하십시오.  파일을 선택하여 팝업 메뉴를 표시한 다음 특성 메뉴 항목을 선택하십시오.  Readme 도구라고 하는 페이지를 클릭하여 특성 페이지의 예제를 표시하십시오.

Readme 파일 편집기

Readme 파일 편집기는 유형 파일 *.readme에 대한 기본 편집기입니다.  확장자가 .readme인 파일을 작성하여 두 번 클릭하여 파일을 열거나 팝업 메뉴를 표시하고 연결 프로그램을 선택한 다음 서브 메뉴에서 Readme 파일  편집기를 선택하여 파일을 여십시오.  편집기에는 연필 모양 아이콘이 있음에 주의하십시오.  이 편집기는 readme 도구가 기본적으로 유형 파일 *.readme에 사용하는 편집기입니다.

Readme 편집기 조치

다음은 특정 편집기에만 적용할 수 있는 조치 예제를 보여 줍니다.  readme 파일 편집기에 초점이 있으면 4개의 추가 도구 모음 표시줄 단추인 Readme 편집기 확장 실행, Readme 편집기 조치 1, Readme 편집기 조치 2 및 Readme 편집기 조치 3이 표시됩니다.

Readme라고 하는 풀다운 메뉴는 readme 파일 편집기에 초점이 있을 때 나타납니다.  이 풀다운 메뉴에는 이전에 설명한 Readme 편집기 조치 1, Readme 편집기 조치 2 및 Readme 편집기 조치 3이 포함됩니다.

Readme 섹션 보기

이 Readme 섹션 보기를 보려면 창 메뉴에서 보기 표시를 선택한 다음 서브 메뉴에서 기타...를 선택하십시오.  Readme 항목을 펼친 다음 Readme 섹션을 선택하십시오.  이렇게 하면 .readme 파일을 네비게이터 보기에서 선택할 때 현재 *.readme 파일에 섹션 목록이 표시됩니다.  또한 아웃라인 보기에 *.readme 파일의 구조를 표시할 수 있습니다.

확장자가 .readme인 파일은 각 섹션이 숫자로 시작할 경우 섹션으로 구분할 수 있습니다.  예를 들어 readme 파일 편집기에 다음 텍스트가 입력되어 있는 경우 readme 도구가 두 개의 섹션을 발견합니다.  readme 도구에서 섹션이 발견되는 방법을 보려면 readme 파일 편집기에 특정 텍스트를 입력하고, CTRL-S를 입력하거나 파일->저장을 선택하여 파일을 저장하십시오. Readme 섹션 보기를 열고 네비게이터 보기에서 .readme 파일을 선택하십시오.

예제 텍스트:

99.1 첫 번째 섹션입니다.
내 첫 번째 섹션의 특정 텍스트입니다.

99.1.1 서브 섹션입니다.
내 서브 섹션의 특정 텍스트입니다.

끌어서 놓기

끌어서 놓기 기능은 아웃라인 보기에서 섹션을 선택하고 텍스트 파일의 맨 위로 선택을 끌면 표시할 수 있습니다. 해당 선택의 컨텐츠가 파일에 추가됩니다.

도움말 지시문

readme 도구 예제는 또한 도구가 제공하는 보기, 다양한 조치 및 마법사 페이지와 같은 모든 확장에 대한 컨텍스트 도움말을 사용하고 구현하는 방법을 보여 줍니다.  조치에 대한 컨텍스트 도움말을 가져오려면 메뉴 항목 위로 마우스를 가져다 놓지만 선택하지 않은 다음 F1 키를 누르십시오.  또한 Readme 섹션 보기 및 예제 마법사 페이지(새로 작성 마법사에서)에 대한 컨텍스트 감지(F1) 도움말도 가져올 수 있습니다.
 

세부사항

Readme 도구 예제에서는 하나의 확장점을 선언하고 많은 확장을 제공합니다.  제공된 확장은 Workbench가 선언한 많은 흥미로운 확장점을 활용할 때 Workbench가 기능하는 방식에 대한 포괄적인 개념입니다.  이 예제에 포함된 제공된 확장은 보기와 보기 조치, 환경 설정 페이지, 특성 페이지, 마법사, 편집기와 편집기 조치, 팝업 메뉴, 조치 세트, 도움말 지시문, 도움말 컨텍스트 및 놓기 조치 등입니다.

이 예제에서는 또한 플러그인에 선언된 확장점을 제공합니다. IReadmeFileParser 클래스는 이 예제가 정의하는 org.eclipse.ui.examples.readmetool.sectionParser 확장을 사용하는 플러그인에 필요합니다. DefaultSectionParser 클래스는 IReadmeFileParser의 예제 구현입니다.

ReadmeEditor 클래스는 IEditorPart를 구현하고 org.eclipse.ui.editors 확장점을 사용하는 plugin.xml에 확장자가 .readme인 파일 편집기로 정의됩니다. ReadmeSectionsView 클래스는 IViewPart를 구현하고 org.eclipse.ui.views 확장점을 사용하는 보기로 정의됩니다. 이 확장점은 보기 선택에 사용할 보기 카테고리도 정의합니다.

이 예제에서는 두 가지 유형의 환경 설정인 Workbench 환경 설정 및 자원 특성이 정의됩니다. Workbench 환경 설정은 IWorkbenchPreferencePage를 구현하는 ReadmePreferencePage 클래스에 정의되어 창->환경 설정 대화 상자에 추가됩니다. 이 클래스는 plugin.xml에 확장점 org.eclipse.ui.preferencePages를 사용하여 정의됩니다. 두 개의 자원 특성 페이지인 ReadmeFilePropertyPage 및 ReadmeFilePropertyPage2는 모두 IWorkbenchPropertyPage를 구현합니다. 이러한 특성은 모두 plugin.xlm에 확장점 org.eclipse.ui.propertyPages를 사용하여 objectClass 태그에 의해 IFile 유형에서 호출되도록 정의됩니다.

ReadmeCreationWizard 클래스는 INewWizard를 구현하고 plugin.xml에 확장점 org.eclipse.ui.newWizards를 사용하여 정의됩니다. 이 확장점은 사용자가 파일->새로 작성->예제...를 선택할 때 표시되는 마법사 카테고리도 정의합니다.

여러 조치 스텁은 이 예제에 추가됩니다. 조치 세트는 Readme 파일 편집기라는 레이블의 메뉴를 선언하여 Workbench 창 메뉴 표시줄에 확장점 org.eclipse.ui.actionSets를 사용하여 포함됩니다. 또한 toolbarPath 및 menubarPath 태그를 사용하여 Workbench 도구 모음 및 메뉴 표시줄에 대한 조치를 정의합니다. 조치 세트는 IWorkbenchWindowActionDelegate를 구현하는 WindowActionDelegate 클래스를 사용하여 조치를 구현합니다. 팝업 메뉴의 조치는 PopupMenuActionDelegate 클래스에 의해 확장점 org.eclipse.ui.popupMenus에서 objectContribution으로 정의됩니다. PopupMenuActionDelegate는 IObjectActionDelegate를 구현하고 제공된 IWorkbenchPart를 사용하여 메시지 대화 상자를 엽니다. 보기 조치 ViewActionDelegate는 확장점 org.eclipse.ui.viewActions를 사용하여 정의되고 IViewActionDelegate를 구현합니다. 보기 조치가 나타나는 보기는 이 예제에서는 org.eclipse.ui.views.ResourceNavigator인 태그 targetID가 정의합니다. 편집기 조치는 IEditorActionDelegate를 구현하는 EditorActionDelegate 클래스가 정의하고 확장점 org.eclipse.ui.editorActions를 사용하여 추가됩니다. 편집기 조치가 적용된 편집기는 이 예제에서는 org.eclipse.ui.examples.readmetool.ReadmeEditor에 정의된 태그 targetID가 정의합니다.

ReadmeDropActionDelegate 클래스는 IDropDelegate를 구현합니다. Workbench에서 수행된 놓기 조치가 있을 때마다 IDropDelegates에 알립니다. 이 조치의 확장점은 org.eclipse.ui.dropActions입니다.