Trợ giúp theo ngữ cảnh Eclipse

Question

Bây giờ tôi có thể đăng ký trợ giúp theo ngữ cảnh trong Eclipse WizardDialog/Editor.

1) Tôi đã tạo tệp help_contexts.xml.

<?xml version="1.0" encoding="UTF-8"?> 
<?NLS TYPE="org.eclipse.help.contexts"?> 
<contexts> 
    <context id="my.plugin.help.general" > 
     <description>test</description> 
     <topic label="test" href="http://domain.com/help.html"/> 
    </context> 
</contexts> 

2) Tôi tham chiếu tập tin này trong plugin.xml tôi

<extension 
     point="org.eclipse.help.contexts"> 
     <contexts file="help_contexts.xml" plugin="my.plugin.MainEditor"> 
     </contexts> 
    </extension> 

3) Tôi đã thêm một dòng trong build.properties tôi để bao gồm tập tin này trong thư mục bin (bin.includes = help_contexts .xml, ...)

4) Khi chạy plugin dựa trên GEF, tôi thấy "Không tìm thấy kết quả phù hợp cho" my.plugin.MainEditor "" dưới trợ giúp động.

Tôi biết tôi cần phải tạo ra một cái gì đó giống như một nơi nào đó, nhưng tôi không biết được nơi để thiết lập này lên cho WizardDialog tôi hoặc ít nhất là cho toàn bộ biên tập của tôi:

public void createPartControl(Composite parent) { 
     ... 
     PlatformUI.getWorkbench().getHelpSystem().setHelp(parent, 
     "my.plugin.help.general"); 
    } 

Lưu ý: Câu hỏi này ban đầu chứa hai câu hỏi. Tôi đã xóa phần đầu tiên (phần chưa được trả lời) được đăng ở nơi khác.

Answer 1

Đây là cách bạn thực hiện: 1) Tôi đã tạo tệp help_contexts.xml. Không có dấu chấm trong id ngữ cảnh. Không bao gồm tên plugin của bạn trong đó.

<?xml version="1.0" encoding="UTF-8"?> 
<?NLS TYPE="org.eclipse.help.contexts"?> 
<contexts> 
    <context id="help_general" > 
     <description>test</description> 
     <topic label="test" href="http://domain.com/help.html"/> 
    </context> 
</contexts> 

2) Tôi đã tham chiếu tệp này trong plugin.xml của tôi. Không bao gồm plugin-id nếu bạn tham chiếu plugin của riêng bạn.

<extension 
     point="org.eclipse.help.contexts"> 
     <contexts file="help_contexts.xml"> 
     </contexts> 
    </extension> 

3) Tôi đã thêm một dòng trong build.properties tôi để bao gồm tập tin này trong thư mục bin (bin.includes = help_contexts.xml, ...). Lưu ý Bundle-SymbolicName của bạn trong Manifest.MF (cũng hiển thị trong trình soạn thảo plugin.xml của bạn). Ví dụ: my.plugin

4) Thiết lập id ngữ cảnh trong WizardPage (tín dụng đi vào @VonC)

public class MyWizardPage extends WizardPage 
    public void createControl(Composite parent) { 
     PlatformUI.getWorkbench.getHelpSystem.setHelp(parent, "my.plugin.help_general"); 
    } 
} 

Answer 2

Đối với câu hỏi chính, tôi không chắc về tham số thứ hai setHelp của bạn. Xem this thread:

Trong lời gọi phương thức

PlatformUI.getWorkbench().getHelpSystem().setHelp() 

tham số thứ hai là contextID.
Cần có tiền tố là pluginID như: "pluginID.contextID".
Bây giờ tôi không chắc chắn nơi tìm ID trình cắm thêm cho trình cắm của tôi.
Vì vậy, tôi đã sử dụng giá trị của thuộc tính này: Bundle-NameBundle-Symbolic-Name từ MANIFEST.MF làm ID trình cắm.
Bây giờ nó hoạt động.

---

Đối với sidenote (trợ giúp cho WizardDialog), this thread có thể giúp (từ David Kyle và blog của mình "Eclipse RCP"):

Chúng tôi thiết lập id bối cảnh trong trang wizard của chúng tôi.

public class MyWizardPage extends WizardPage 
    public void createControl(Composite parent) { 
     PlatformUI.getWorkbench.getHelpSystem.setHelp(parent, 
MyPluginActivator.ID + ".mycontexthelpid"); 
    } 
} 

và chúng tôi thiết lập trợ giúp cho hộp thoại wizard.

WizardDialog dialog = new WizardDialog(.....); 
PlatformUI.getWorkbench().getHelpSystem().setHelp(dialog.getShell(), 
"mycontexthelp.id"); 

Chúng tôi không ghi đè performHelp().

Đối với id ngữ cảnh trợ giúp. Xác định tệp xml ngữ cảnh trong plugin của bạn.

<?xml version="1.0" encoding="UTF-8"?> 
<?NLS TYPE="org.eclipse.help.contexts"?> 
<contexts> 
    <context id="mycontexthelpid" > 
     <description>My wizard help.</description> 
     <topic label="Wizard help" href="reference/wizard/help.xhtml"/> 
    </context> 
</contexts> 

trong plugin của bạn

<plugin> 
    <extension point="org.eclipse.help.contexts"> 
     <contexts file="mywizard.xml" plugin="com.mypluginid"/> 
    </extension> 
</plugin> 

Một vấn đề thường gặp là rối tung lên các plugin và giúp đỡ bối cảnh id. Bạn có thể đặt một vài điểm ngắt để xem id ngữ cảnh nào đang được yêu cầu.