MATLAB: lệnh force doc để mở trang HTML tham chiếu được chỉ định

Question

Giả sử tôi đã viết một lớp trong một gói, được gọi là mypackage.myclass. Tôi đã viết tài liệu HTML của riêng tôi cho gói và lớp, và đã bao gồm điều này trong trình duyệt trợ giúp MATLAB như được mô tả trong the MATLAB documentation.

Tôi có thể hiển thị tài liệu HTML này bằng cách sử dụng trình duyệt trợ giúp để điều hướng trực tiếp đến tài liệu đó, nhưng nhập doc mypackage.myclass không hiển thị nó; thay vào đó, nó hiển thị một số tài liệu HTML được tự động tạo bởi helpwin (đây là một tính năng đẹp, nhưng không phải là những gì tôi muốn - tài liệu được tạo tự động quá cao đối với người dùng của tôi).

Làm cách nào để bắt buộc doc hiển thị tài liệu của tôi, chứ không phải tài liệu được tạo tự động?

Tương:

Khi bạn chạy doc docTopic, bên trong lệnh doc lớp Java com.mathworks.mlservices.MLHelpServices.showReferencePage(docTopic) được gọi. Nếu trang tham chiếu cho docTopic tồn tại, nó sẽ hiển thị nó và trả về giá trị thành công. Nếu một trang tham chiếu không tồn tại, nó sẽ trả về một giá trị thất bại, và sau đó gây ra helpwin(docTopic) để được gọi. Một nơi nào đó phải có một số danh mục kết nối các giá trị của docTopic với các tệp HTML tham chiếu riêng lẻ. Làm thế nào tôi có thể fiddle với danh mục đó - hoặc tôi có thể tạo một cho gói của tôi?

MathWorkers và @Yair, xin vui lòng cho tôi đủ dây cung cấp tài liệu để treo bản thân mình với :)

Answer 1

Theo như tôi biết điều này là không thể và không có ý định bởi MathWorks. Tôi cũng không biết cách nào để làm điều này. Theo tôi nhớ từ khóa cho doc được mã hóa cứng ở đâu đó.

Tùy thuộc vào thiết lập của bạn, bạn có thể thử như sau: Chuẩn bị doc lệnh của riêng bạn mà sử dụng web(..., '-helpbrowser') để hiển thị các trang HTML trong trình duyệt giúp đỡ của MATLAB:

function doc(topic) 

    my_topics = { 
     'foo', 'foo.html' 
     'bar', 'bar/help/intro.html' 
    }; 

    for i = 1 : size(my_topics, 1) 
     if strcmpi(topic, my_topics{i, 1})  
      web(my_topics{i, 2}, '-helpbrowser'); 
      return; 
     end 
    end 

    % Fall back to MATLAB's doc. Note that our doc shadows MATLAB's doc. 
    docs = which('doc', '-all'); 
    old_dir = cd(); 
    c = onCleanup(@() cd(old_dir)); 
    cd(fileparts(docs{2})); 
    doc(topic); 
end 

Nếu bạn đặt hàm trong một file doc.m và đặt thư mục tương ứng ở đầu đường dẫn MATLAB (xem help addpath) sau đó nó sẽ được gọi thay vì được xây dựng trong doc.

Tất nhiên bạn có thể sử dụng một số nơi khác để lưu trữ ánh xạ tài liệu tùy chỉnh của bạn (ví dụ: tệp) hoặc sử dụng một loại lược đồ tra cứu động nào đó.

CẬP NHẬT: Kể từ MATLAB R2012b, tùy chọn '-helpbrowser' là web không có giấy tờ. Điều này có thể liên quan đến các thay đổi GUI trong phiên bản MATLAB đó, bao gồm cả trình duyệt trợ giúp. web(..., '-helpbrowser') vẫn hoạt động như dự định, nhưng điều đó có thể thay đổi trong các phiên bản sau của MATLAB. Theo tôi biết, không có cách nào được ghi tài liệu về việc mở bất kỳ trang HTML nào trong trình duyệt trợ giúp trong R2012b.