docs: Changed image sizes to not cover the full width
This commit is contained in:
Eberhard Graether
+51
-51
@@ -1,4 +1,4 @@
|
||||
|
||||
<img src="docs/documentation/logo.png" height="250" alt="Sourcetrail">
|
||||
|
||||
Documentation for version 2021.4
|
||||
|
||||
@@ -10,7 +10,7 @@ This document is the official documentation of Sourcetrail and explains everythi
|
||||
|
||||
Sourcetrail is an interactive source explorer that simplifies navigation in existing source code by indexing your code and gathering data about its structure. Sourcetrail then provides a simple interface consisting of three interactive views, each playing a key role in helping you obtain the information you need:
|
||||
|
||||
|
||||
<img src="docs/documentation/concept.png" height="400" alt="Sourcetrail Concept">
|
||||
|
||||
* **Search:** Use the search field to quickly find and select indexed symbols in your source code. The autocompletion box will instantly provide an overview of all matching results throughout your codebase.
|
||||
* **Graph:** The graph displays the structure of your source code. It focuses on the currently selected symbol and directly shows all incoming and outgoing dependencies to other symbols.
|
||||
@@ -54,7 +54,7 @@ After launching Sourcetrail you will see the [Start Window](#start-window). From
|
||||
> * Click **New Project** to create a new project.
|
||||
> * or select one from the **Recent Projects** _(ex: TicTacToe)_ and continue with the [UI Intro](#ui-intro)
|
||||
|
||||
|
||||
<img src="docs/documentation/start_window.png" height="600" alt="Start Window">
|
||||
|
||||
## Creating a New Project
|
||||
|
||||
@@ -64,7 +64,7 @@ When creating a new Sourcetrail project you will use the [Project Setup Wizard](
|
||||
> * Give your project a **Name** and select a **Location** for your Sourcetrail project to live.
|
||||
> * Click **Add Source Group** to add source files to the project.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start.png" height="500" alt="Project Setup Wizard Start">
|
||||
|
||||
### Add Source Group
|
||||
|
||||
@@ -75,7 +75,7 @@ Scroll past the image for detailed instructions on setting this up.
|
||||
> **Tasks:**
|
||||
> * Select your chosen **Source Group** setup type and come back here as soon as the project is created.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_source_group_type.png" height="600" alt="Project Setup Wizard Source Group Type">
|
||||
|
||||
#### Source Group Setup for C/C++
|
||||
|
||||
@@ -92,20 +92,19 @@ Exporting a Compilation Database:
|
||||
|
||||
If you managed to export a `compile_commands.json` file, then please continue at [Create a Source Group from Compilation Database](#create-a-project-from-compilation-database) and come back after you finished creating the project.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start_cdb.png" height="600" alt="Project Setup Wizard Start CDB">
|
||||
|
||||
**Are you using Visual Studio?**
|
||||
|
||||
If you are using Visual Studio you can continue at [Source Group creation from Visual Studio](#create-a-project-from-visual-studio) and export a Compilation Database with our [Visual Studio Plugin](#visual-studio).
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start_vs.png" height="600" alt="Project Setup Wizard Start VS">
|
||||
|
||||
**Create Empty**
|
||||
|
||||
If neither of the above options apply to your project, please continue at [create an empty C/C++ Source Group](#create-an-empty-cxx-project) and return here once the project is created.
|
||||
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_source_group_type.png" height="600" alt="Project Setup Wizard Source Group Type">
|
||||
|
||||
#### Source Group Setup for Java
|
||||
|
||||
@@ -113,19 +112,19 @@ If neither of the above options apply to your project, please continue at [creat
|
||||
|
||||
If you are using Gradle you can continue at [Source Group creation from Gradle](#create-a-project-from-gradle-configuration) to automatically setup your Source Group using your Gradle build configuration.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start_java_gradle.png" height="600" alt="Project Setup Wizard Start Java Gradle">
|
||||
|
||||
**Are you using Maven?**
|
||||
|
||||
If you are using Maven please continue at [Source Group creation from Maven](#create-a-project-from-maven-configuration) to automatically setup your Source Group using your Maven build configuration.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start_java_maven.png" height="600" alt="Project Setup Wizard Start Java Maven">
|
||||
|
||||
**Create Empty**
|
||||
|
||||
If you do not have your project configured using Gradle or Maven, please continue at [Create an Empty Java Source Group](#create-an-empty-java-project) and come back here as soon as the project is created.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start_java_empty.png" height="600" alt="Project Setup Wizard Start Java Empty">
|
||||
|
||||
#### Source Group Setup for Python
|
||||
|
||||
@@ -133,7 +132,7 @@ If you do not have your project configured using Gradle or Maven, please continu
|
||||
|
||||
If you want to browse your Python source code with Sourcetrail, please continue at [Create an Empty Python Source Group](#create-an-empty-python-project) and come back here as soon as the project is created.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start_python_empty.png" height="600" alt="Project Setup Wizard Start Python Empty">
|
||||
|
||||
## Source Indexing
|
||||
|
||||
@@ -170,11 +169,11 @@ All three views display information about the currently selected symbol:
|
||||
|
||||
The [Search Field](#search-bar) allows for easy access to all indexed symbols. Use it to find all classes and functions you wish to investigate. In addition, it also holds the UI buttons for navigating [back & forward](#back-&-forward) as well as [refreshing](#refresh).
|
||||
|
||||
|
||||
<img src="docs/documentation/search_view.png" width="750" alt="Search View">
|
||||
|
||||
When entering a search query, the [autocompletion popup](#autocompletion-popup) will provide you with a concise list of all matching symbols. Note that Sourcetrail uses a fuzzy matching algorithm, that allows you to skip characters while entering a query.
|
||||
|
||||
|
||||
<img src="docs/documentation/search_view_completion.png" width="800" alt="Search View Completion">
|
||||
|
||||
### 2. Graph Visualization
|
||||
|
||||
@@ -207,7 +206,7 @@ For a full list on all existing nodes and edges take a look at the integrated [G
|
||||
|
||||
The [code view](#code-view) displays all locations of the currently active symbol within the indexed source files. It does not allow for editing the source code. Syntax highlighting is used to increase readability. Source locations that are surrounded by a box when hovered can be clicked to activate the respective symbol. Active source locations are highlighted.
|
||||
|
||||
|
||||
<img src="docs/documentation/code_view.png" width="800" alt="Code View">
|
||||
|
||||
The source locations are displayed as code snippets, containing the line of interest and extra lines added to the top and bottom to give information about its context. Code snippets are then bundled together into files.
|
||||
|
||||
@@ -215,15 +214,15 @@ The source locations are displayed as code snippets, containing the line of inte
|
||||
|
||||
* **Minimized:** The file does not show any content
|
||||
|
||||
|
||||
<img src="docs/documentation/snippet_minimized.png" width="800" alt="Snippet Minimized">
|
||||
|
||||
* **Snippets:** The file displays the snippets containing active locations separated by lines.
|
||||
|
||||
|
||||
<img src="docs/documentation/snippet_snippets.png" width="800" alt="Snippet Snippets">
|
||||
|
||||
* **Maximized:** The [code view](#code-view) switches to [single file mode](#single-file-mode) and the whole content of the file is visible.
|
||||
|
||||
|
||||
<img src="docs/documentation/code_view_single.png" width="800" alt="Code View Single">
|
||||
|
||||
For more information, please visit the [Code View Files](#files) section.
|
||||
|
||||
@@ -248,7 +247,7 @@ Download and open the zip file and extract its contents into a temporary folder
|
||||
## macOS
|
||||
Download and open the Sourcetrail.dmg file and drag Sourcetrail.app into the applications folder. You can now launch Sourcetrail from your Applications.
|
||||
|
||||
|
||||
<img src="docs/documentation/installation_mac.png" width="800" alt="Installation macOS">
|
||||
|
||||
## Linux
|
||||
|
||||
@@ -411,7 +410,7 @@ The On-Screen Search Bar is used to search visible contents of the [Graph View](
|
||||
|
||||
On every start of Sourcetrail you are shown the start window. It allows for creating new projects or opening existing ones.
|
||||
|
||||
|
||||
<img src="docs/documentation/start_window.png" width="700" alt="Start Window">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -428,7 +427,7 @@ The Path List Box is a user interface element that is used within the [Preferenc
|
||||
If you want to use environment variables you can use either of the following notations.
|
||||
`${VARIABLE_NAME}` or `%VARIABLE_NAME%`
|
||||
|
||||
|
||||
<img src="docs/documentation/path_list_box.png" width="700" alt="Path List Box">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -444,7 +443,7 @@ If you want to use environment variables you can use either of the following not
|
||||
|
||||
By pressing the pen icon in the bottom right corner you can open the plain text edition dialog. It allows you to edit the whole list within a text field. Each line will be one list item.
|
||||
|
||||
|
||||
<img src="docs/documentation/path_list_box_edit.png" width="600" alt="Path List Box Edit">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -456,7 +455,7 @@ By pressing the pen icon in the bottom right corner you can open the plain text
|
||||
|
||||
The Preferences window lets you define settings for all projects. You can open the Preferences from the menu via [Edit/Preferences](#edit).
|
||||
|
||||
|
||||
<img src="docs/documentation/preferences_screen.png" width="800" alt="Preferences Screen">
|
||||
|
||||
| Setting | Description
|
||||
| --- | ---
|
||||
@@ -491,7 +490,7 @@ The Project Setup Wizard lets you create a new Sourcetrail project. It allows fo
|
||||
|
||||
For detailed information continue at [PROJECT SETUP](#project-setup).
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start.png" width="800" alt="Project Setup Wizard Start">
|
||||
|
||||
### Indexing Dialogs
|
||||
|
||||
@@ -511,7 +510,7 @@ This dialog displays the number of files for indexing and clearing before indexi
|
||||
|
||||
For Python projects a checkbox **Shallow Python Indexing** is additionally displayed. When checked, references within your code base (calls, usages, etc.) are resolved by name, which is imprecise but much faster than in-depth indexing. Use this option for a quick first indexing pass and start browsing the code base while running a second pass for in-depth indexing.
|
||||
|
||||
|
||||
<img src="docs/documentation/start_indexing_dialog.png" width="600" alt="Start Indexing Dialog">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -523,7 +522,7 @@ For Python projects a checkbox **Shallow Python Indexing** is additionally displ
|
||||
|
||||
This dialog shows that Sourcetrail is currently doing processing that can't be interrupted.
|
||||
|
||||
|
||||
<img src="docs/documentation/progress_dialog.png" width="600" alt="Progress Dialog">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -533,7 +532,7 @@ This dialog shows that Sourcetrail is currently doing processing that can't be i
|
||||
|
||||
This dialog shows the indexing progress of your project, by displaying the number of already indexed files, the last file that was started indexing, the number of errors and a progress estimate in percent.
|
||||
|
||||
|
||||
<img src="docs/documentation/indexing_dialog.png" width="600" alt="Indexing Dialog">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -544,13 +543,13 @@ This dialog shows the indexing progress of your project, by displaying the numbe
|
||||
|
||||
This dialog is shown after indexing finished, giving you information about indexed files, duration and errors.
|
||||
|
||||
|
||||
<img src="docs/documentation/finished_indexing_dialog.png" width="600" alt="Finished Indexing Dialog">
|
||||
|
||||
#### Interrupted Indexing Dialog
|
||||
|
||||
This dialog is shown after indexing was stopped, giving you information about indexed files, duration and errors. You can choose to either use the new index or continue using the old one.
|
||||
|
||||
|
||||
<img src="docs/documentation/finished_indexing_dialog.png" width="600" alt="Interrupted Indexing Dialog">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -748,7 +747,7 @@ This dialog is shown after indexing was stopped, giving you information about in
|
||||
## Graph View
|
||||
The graph view visualizes the currently selected symbol and all its relationships to other symbols as an interactive graph visualization. You can also display whole call graphs, inheritance chains or include trees by using the toolbar in the top left. Read more about that at [Custom Trail](#custom-trail).
|
||||
|
||||
|
||||
<img src="docs/documentation/graph_view.png" width="750" alt="Graph View">
|
||||
|
||||
#### Interactions:
|
||||
|
||||
@@ -856,7 +855,7 @@ Using the toolbar in the top left you can display whole call graphs, inheritance
|
||||
#### Custom Trail Dialog
|
||||
The Custom Trail Dialog can be accessed within the trail controls in the top left of the graph view. It allows to display Custom Trails based on certain criteria.
|
||||
|
||||
|
||||
<img src="docs/documentation/custom_trail.png" width="700" alt="Custom Trail">
|
||||
|
||||
Every Custom Trail has a specific Start Symbol, then 1 of 3 different modes can be chosen:
|
||||
|
||||
@@ -893,13 +892,13 @@ Using grouping buttons in the top left you can specify if nodes in the graph sha
|
||||
|
||||
All nodes that belong to the same namespace or package are grouped together in a separate group node.
|
||||
|
||||
|
||||
<img src="docs/documentation/grouping_namespace.png" width="800" alt="Grouping Namespace">
|
||||
|
||||
#### File Grouping
|
||||
|
||||
All nodes defined in the same source or header file are grouped together in a separate group node.
|
||||
|
||||
|
||||
<img src="docs/documentation/grouping_file.png" width="800" alt="Grouping File">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -916,7 +915,7 @@ Click the `?` button in the bottom right corner of the graph view or enter the k
|
||||
|
||||
The code view displays the corresponding source code of the currently selected symbols. The code view has two modes. In list mode it contains a list of one or more files. In single file mode it shows one full source file at a time.
|
||||
|
||||
|
||||
<img src="docs/documentation/code_view.png" width="800" alt="Code View">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -925,7 +924,7 @@ The code view displays the corresponding source code of the currently selected s
|
||||
* Switch between Snippet List and Single File mode with the `mode selection` in the upper right corner.
|
||||
* Scroll up and down to see the different source files.
|
||||
|
||||
|
||||
<img src="docs/documentation/code_view_show_errors.png" width="800" alt="Code View Show Errors">
|
||||
|
||||
If a viewed file had errors during indexing, its file icon will contain an `x` and there is a `Show Errors`-button visible in the files title bar. Clicking one `Show Errors` will show you only the errors that cause this specific file to be incomplete in the [Errors Tab](#errors-tab).
|
||||
|
||||
@@ -939,11 +938,11 @@ Each file has a title bar with the file's name. Clicking the title bar will chan
|
||||
|
||||
* **Minimized:** The file does not show its content.
|
||||
|
||||
|
||||
<img src="docs/documentation/snippet_minimized.png" width="800" alt="Snippet Minimized">
|
||||
|
||||
* **Snippets:** The file displays the snippets containing active locations separated by lines.
|
||||
|
||||
|
||||
<img src="docs/documentation/snippet_snippets.png" width="800" alt="Snippet Snippets">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -957,7 +956,7 @@ Each file has a title bar with the file's name. Clicking the title bar will chan
|
||||
|
||||
A code snippet contains the lines of interest for the currently active symbol surrounded by some more lines to provide some context. Other symbols that were indexed by Sourcetrail are framed by a box when hovered. Here Sourcetrail distinguishes between local symbols and symbols that can be related to any other part of the code base. In case the snippet is part of a class, function or namespace, an additional line at the top of the snippet provides information about the snippet’s context (e.g. the surrounding scope).
|
||||
|
||||
|
||||
<img src="docs/documentation/code_view_snippet.png" width="800" alt="Code View Snippet">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -969,7 +968,7 @@ A code snippet contains the lines of interest for the currently active symbol su
|
||||
|
||||
In single file mode you will only every have one file visible at a time. The first file shown is usually the file containing the definition of the active snippet if available. Other than that the user interface is the same as in [Snippet List Mode](#snippet-list-mode).
|
||||
|
||||
|
||||
<img src="docs/documentation/code_view_single.png" width="800" alt="Code View Single">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -981,7 +980,7 @@ In single file mode you will only every have one file visible at a time. The fir
|
||||
|
||||
The Search View contains the search field and some other related user interface elements.
|
||||
|
||||
|
||||
<img src="docs/documentation/search_view.png" width="800" alt="Search View">
|
||||
|
||||
### Back, Forward and History
|
||||
|
||||
@@ -990,6 +989,7 @@ The left `Backward` button lets you undo your last navigation actions (see [Back
|
||||
The middle button shows a list of the recently active symbol stack. Select a symbol to activate it.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**Interactions:**
|
||||
@@ -1037,7 +1037,7 @@ The search bar allows you to enter search requests to find one of Sourcetrail's
|
||||
|
||||
The Autocompletion Popup displays all [Nodes](#nodes) matching your search request within all indexed symbols. The match results are determined by a fuzzy matching algorithm, that allows you to skip characters. The popup shows which characters in the words are matching and displays their corresponding node color. The node type is displayed on the right.
|
||||
|
||||
|
||||
<img src="docs/documentation/search_view_completion.png" width="800" alt="Search View Completion">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -1080,7 +1080,7 @@ The `Bookmark Active Symbol` button on the left opens the [Bookmark Creator](#bo
|
||||
|
||||
Use the `Bookmark Creator` to create or edit bookmarks.
|
||||
|
||||
|
||||
<img src="docs/documentation/bookmark_creator.png" width="700" alt="Bookmark Creator">
|
||||
|
||||
| Setting | Description
|
||||
| --- | ---
|
||||
@@ -1097,7 +1097,7 @@ Use the `Bookmark Creator` to create or edit bookmarks.
|
||||
|
||||
Use the `Bookmark Manager` to view and activate your bookmarks. Bookmarks are displayed as lines below their respective category. If a bookmark does not have a category it will be placed within the `default` category. The buttons for removing/editing categories or bookmarks are only visible when hovering the respective line. Bookmark information is stored within a separate `.srctrlbm` file next to your `.srctrlprj` project file.
|
||||
|
||||
|
||||
<img src="docs/documentation/bookmark_manager.png" width="800" alt="Bookmark Manager">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -1159,7 +1159,7 @@ The following information is provided:
|
||||
|
||||
Show information about hovered symbols in the [Graph View](#graph-view) and [Code View](#code-view)
|
||||
|
||||
|
||||
<img src="docs/documentation/tooltip.png" width="500" alt="Tooltip">
|
||||
|
||||
**The following information is provided:**
|
||||
|
||||
@@ -1182,7 +1182,7 @@ The Project Setup Wizard lets you create a new Sourcetrail project. It allows fo
|
||||
|
||||
After you added Source Groups to your project this dialog allows you to edit their configurations, as well as removing or duplicating them.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_start.png" width="800" alt="Project Setup Wizard Start">
|
||||
|
||||
| Setting | Description
|
||||
| --- | ---
|
||||
@@ -1202,7 +1202,7 @@ After you added Source Groups to your project this dialog allows you to edit the
|
||||
|
||||
This window is also used when editing the project. You can select a Source Group from the list on the left and edit it's contents then. Additionally you can also set the `active` flag of certain Source Groups to false, so they won't get indexed when refreshing the project.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_edit.png" width="800" alt="Project Setup Wizard Edit">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -1214,7 +1214,7 @@ This window is also used when editing the project. You can select a Source Group
|
||||
|
||||
When creating a new Source Group you can choose between different methods of setup depending on your project language. Please have a look at our [QUICK START GUIDE](#getting-started) section for help on choosing the right Source Group type.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_source_group_type.png" width="600" alt="Project Setup Wizard Source Group Type">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -1265,7 +1265,7 @@ C/C++ Source Groups from Compilation Database offer the following configuration
|
||||
|
||||
If you are using Visual Studio you can export a Compilation Database with our [Visual Studio Plugin](#visual-studio) and use it to create a project with Sourcetrail.
|
||||
|
||||
|
||||
<img src="docs/documentation/project_setup_wizard_visual_studio.png" width="700" alt="Project Setup Wizard Visual Studio">
|
||||
|
||||
**Interactions:**
|
||||
|
||||
@@ -1394,7 +1394,7 @@ Incoming messages are in the form:
|
||||
|
||||
If you want your editor to open a file at a specific location from within Sourcetrail, you can achieve this by either selecting the option `Set IDE Cursor` from the right-click menu in the <a href="#CodeView">Code View]() or by simply clicking into a line in the [Code View](#code-view) while holding down the `Ctrl` or `Cmd` key.
|
||||
|
||||
|
||||
<img src="docs/documentation/plugin_use_in_sourcetrail.png" width="600" alt="Plugin Use In Sourcetrail">
|
||||
|
||||
## To Sourcetrail
|
||||
|
||||
@@ -1517,7 +1517,7 @@ If you want QtCreator to activate a certain element in Sourcetrail, click a loca
|
||||
|
||||
If you want Sublime to activate a certain element in Sourcetrail, click a location to place the cursor, right-click to bring up the context menu and choose the “Sourcetrail - Set active Token” option. Please note that the position of the cursor will be sent to Sourcetrail and not the position you opened the context menu at.
|
||||
|
||||
|
||||
<img src="docs/documentation/plugin_use_in_sublime_text.png" width="600" alt="Plugin Use In Sublime Text">
|
||||
|
||||
### Vim
|
||||
|
||||
|
||||
Reference in New Issue
Block a user