# doc-view

**Repository Path**: cxdgrck/doc-view

## Basic Information

- **Project Name**: doc-view
- **Description**: 该仓库专门存储doc-view工具插件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-29
- **Last Updated**: 2023-11-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[中文](#doc-viewer-中文描述)|[English](#doc-viewer-readme)

#  KylinSDK Doc Viewer 中文描述 

KylinSDK Doc Viewer插件为KylinSDK代码帮助工具，光标放置符号属性处，点击Shift+F1，将显示该符号的帮助文档。该插件支持点击shift-f1跳转到KylinSDK、Qt5(因文件体量较大，本插件只显示Qt-5.15.2中的部分文档)或者Man手册中的帮助文档。

## 插件依赖
### 1. 依赖插件
- 安装依赖插件KylinIDETeam.vscode-clangd
### 2.插件相关依赖包
- 安装KylinIDETeam.vscode-clangd插件后使用时需要安装以下软件包
    - 安装clangd软件包（用于c/c++编辑语法高亮、跳转等功能）
    可使用系统源apt直接安装

    ``` shell
        sudo apt install clangd 
    ```
    或使用插件管理器进行安装（KylinIdeTeam.extension-dependency）
- 若开发c/c++程序并需要跳转到帮助文档时需安装c/c++支持软件包，可以参考如下安装：

    ```shell
        sudo apt install build-essential
    ```
- 若使用KylinSDK开发程序并需要跳转到帮助文档时需安装KylinSDK相关依赖包：   
    - 以下为其中一个KylinSDK软件包，例如：
    ```shell
        sudo apt install libkysdk-qtwidgets libkysdk-qtwidgets-dev
    ```
- 若跳转到man手册中命令帮助文档时需安装以下依赖包：    
    ```shell
        sudo apt install manpages-dev
    ```
- 若开发Qt5项目并需要跳转到帮助文档时需安装以下依赖包：   
        
    - 安装qtbase5-dev（支持Qt5帮助文档跳转）
    ```shell
        sudo apt install  qtbase5-dev 
    ```

## 快速开始
- 环境
  - 本插件暂支持银河麒麟SP1桌面操作系统以及openKylin桌面操作系统。
- 插件安装
    - 需要安装clangd、doc-viewer插件。
	- 插件安装完成后，如果点击shift+F1无反应则需要shift+P，输入并选择Reload Window重新加载窗口使插件生效。

- 安装插件相关依赖
    - 参考[插件相关依赖](#插件依赖)
	
- 侧边栏展示视图
    - 点击活动栏文档图标，侧边栏显示api参考视图以及用户手册视图，用户可根据提示操作两个视图进行查看帮助文档

- 点击shift-f1跳转
	- 打开程序在编辑区显示，光标放置符号处上，按shift-f1进行跳转，最右侧显相关帮助文档页面。


[返回中文描述](#doc-viewer-中文描述)
#  Doc Viewer README

The doc-viewer extension is a KylinSDK coding help tool.The cursor is placed over the symbol, and click Shift+F1 to display the help document of the symbol.The extension can click shift-f1 to jump to the help document in KylinSDK, Qt5(due to the large size of the file, this extension only displays part documents of the Qt-5.15.2 ) or the Man manual.

##  Extension depend
### 1. Extensions included
- When the doc-view extension package is installed, the KylinIDETeam.vscode-clangd extension is installed together
### 2.Extensions dependency package
- The following software packages need to be installed before using the KylinIDETeam.vscode-clangd extension
    - Install clangd (clangd is used in c/ C ++ program editing  syntax highlighting, jumping, etc.)
    It can be installed directly using apt-get

    ``` shell
        sudo apt install clangd 
    ```
    Or install it using the extension manager (KylinIdeTeam.extension-dependency)
- You need to install the c/c++ support package when developing c/c++ programs and need to show the help documentation, you can refer to the following installation package:

    ```shell
        sudo apt install build-essential
    ```   
- You need to install the KylinSDK support package when developing KylinSDK programs and need to show the help documentation, you can refer to the following installation package:
    - Here is tow packages of the KylinSDK, for example:
    ```shell
        sudo apt install libkysdk-qtwidgets libkysdk-qtwidgets-dev
    ``` 
- If you want to see the command help document in the man manual, you need to install the following dependency packages:

    ```shell
        sudo apt install manpages-dev
    ``` 
- If you are developing a Qt5 project and see the help document, install the following dependency packages:
        
    - Install qtbase5-dev (support show Qt5 help document )
    ```shell
        sudo apt install  qtbase5-dev 
    ```

## Quick start
- Environment
  - This extension temporarily supports the kylin SP1 desktop operating system and openKylin desktop operating system.
- Extension installation
    - The clangd and doc-viewer extension need to be installed.
    - After extensions are installed, If nothing happens by clicking shift+F1, you can click shift+P and run the Reload Window command to reload the window for the extension to work.

- Install extension dependens
    - see [extension Depend](#extension-depend)
	
- The sidebar shows the view
    - Click the active bar document icon, and  displays the api reference view and user manual view in the sidebar. Users can operate the two views according to the prompts to see the help document

- Click shift-f1 to jump
    - Open the program and display it in the editing area. The cursor is placed over the symbol, click shift-f1 to jump  and then the relevant help documentation html is displayed on the far right.