ynkmr/Sourcetrail
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

web: updated documentation

Browse Source 
* maven project setup
* reset layout option
* use 0 indexer threads for auto-detection
* multi process setting
* bookmarking
* depth graph
* updated menu and shortcuts
* updated images
This commit is contained in:
Eberhard Graether
2017-05-16 10:52:52 +02:00
parent c58b6ae23c
commit 6d0f633d24
15 changed files with 241 additions and 1022 deletions
Download Patch File Download Diff File Expand all files Collapse all files
web/documentation/index.html
+237 -34
View File
@@ -38,20 +38,18 @@
padding-top: 20px;
}
#nav {
position:fixed;
.backlink {
position: fixed;
width: 20%;
margin-left: 2%;
}
.tocify {
position:static;
width: 100%;
margin-left: 0px;
margin-top: 30px;
}
@media (max-width: 767px) {
#nav {
.tocify {
position: relative;
width: 100%;
}
@@ -64,19 +62,11 @@
<div class="row-fluid">
<div class="col-xs-12 col-sm-3">
<div id="nav">
<div class="row">
<div class="col-xs-12">
<p><span class="glyphicon glyphicon-arrow-left"></span> <a href="http://www.sourcetrail.com/">back to sourcetrail.com</a></p>
</div>
</div>
<div class="row" style="height:10px;"></div>
<div class="row">
<div class="col-xs-12">
<div id="toc"></div><!-- Our table of contents will be here !-->
</div>
</div>
<div class="row" style="height:40px;"></div>
<div class="row">
<p class="backlink"><span class="glyphicon glyphicon-arrow-left"></span> <a href="http://www.sourcetrail.com/">sourcetrail.com</a></p>
</div>
<div class="row">
<div id="toc"></div><!-- Our table of contents will be here !-->
</div>
</div>
<div class="col-xs-12 col-sm-9 col-md-6">
@@ -86,7 +76,7 @@
</div>
</div>
<div class="row" style="text-align:center; margin-top: 10px;">
<p>Documentation for version 0.11</p>
<p>Documentation for version 0.12</p>
</div>
<div class="row" style="height:20px;"></div>
@@ -229,11 +219,23 @@
<div class="row" style="height:10px;"></div>
<h4>Project setup for Java</h4>
Java projects can currently only be created as Empty Projects. Please follow the descriptions at <a href="#CreateAnEmptyJavaProject">Create an Empty Java Project</a>.
<strong>Are you using Maven?</strong>
<p>If you are using Maven you can continue at <a href="#CreateAProjectFromMavenConfiguration">Project creation from Maven</a> to automatically setup your project using your Maven configuration.</p>
<div class="row">
<div class="col-sm-8 col-sm-offset-2">
<img src="img/project_setup_wizard_start_java.png" style="width:100%;">
<img src="img/project_setup_wizard_start_java_maven.png" style="width:100%;">
</div>
</div>
<strong>Create empty</strong>
If you do not have your project configured using Maven then please continue at <a href="#CreateAnEmptyJavaProject">Create an Empty Java Project</a> and come back here as soon as the project is created.
<div class="row">
<div class="col-sm-8 col-sm-offset-2">
<img src="img/project_setup_wizard_start_java_empty.png" style="width:100%;">
</div>
</div>
@@ -421,7 +423,7 @@
<div class="panel-body">
<p>Sourcetrail does two things with the data collected during indexing:</p>
<ol>
<li>The data is stored in the <code>.sourcetraildb</code> file in the same directory as the <code>.sourcetrailproject</code> file. This database file is used by Sourcetrail to serve its purpose of letting you navigate your source code. And it allows Sourcetrail to reopen the project without reindexing the source code every time.</li>
<li>The data is stored in the <code>.srctrldb</code> file in the same directory as the <code>.srctrlprj</code> file. This database file is used by Sourcetrail to serve its purpose of letting you navigate your source code. And it allows Sourcetrail to reopen the project without reindexing the source code every time.</li>
<li>If logging is enabled, some of the data gets logged into a log file saved in <a href="#Datafolder">data</a>/logs. These logs can be useful to us for fixing bugs. We might ask for log information on bug reports, but you should only provide it, if your source code is not confidental.</li>
</ol>
</div>
@@ -646,7 +648,11 @@
</tr>
<tr>
<th scope="row">Indexer threads</th>
<td>Define how many parallel threads are used during indexing.</td>
<td>Define how many parallel threads are used during indexing. Setting this value to 0 will cause Sourcetrail to detect the number of available CPU cores and use as many threads for indexing.</td>
</tr>
<tr>
<th scope="row">Multi process C/C++ indexing</th>
<td>Enable C/C++ indexer threads to run in a different process. This prevents the application from crashing due to unforseen exceptions while indexing.</td>
</tr>
<tr>
<th scope="row">Sourcetrail Port</th>
@@ -664,6 +670,10 @@
<th scope="row">JVM Maximum Memory</th>
<td>Specify the maximum amount of memory that should be allocated by the indexer's JVM. A value of <code>-1</code> ignores this setting.</td>
</tr>
<tr>
<th scope="row">Maven Path</th>
<td>Only required for indexing projects using Maven. Provide the location of your installed Maven executable. You can also use the auto detection.</td>
</tr>
<tr>
<th scope="row">Global Include Paths</th>
<td>Set header search paths that are used for <strong>all</strong> of your projects (e.g. std headers). An option for automatic detection of these paths is available for Clang, GCC and the Visual Studio compiler. For instructions on how to add paths manually see <a href="#PathListBox">Path List Box</a>. For instructions on how to find the system header paths see <a href="#FindingSystemHeaderLocations">Finding System Header Locations</a>.</td>
@@ -708,7 +718,7 @@
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.sourcetrailproject</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.srctrlprj</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Location</th> <td>Choose the location of the project file from the dialog.</td> </tr>
<tr> <th scope="row">Standard</th> <td>Select the language standard that should be used for indexing your project. Usually the most recent language standard is preselected here. (See <a href="#SupportedLanguages">Language Support</a>)</td> </tr>
</tbody>
@@ -852,7 +862,7 @@
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.sourcetrailproject</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.srctrlprj</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Location</th> <td>Choose the location of the project file from the dialog.</td> </tr>
<tr> <th scope="row">Compilation Database</th> <td>Select the compilation database <code>.json</code> for the project. Sourcetrail will index the project based on the compile commands in this file. If the compilation database changes you can <a href="#Refresh">Refresh</a> Sourcetrail to the new files.</td> </tr>
</tbody>
@@ -879,12 +889,12 @@
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Source Files</th> <td>Clicking <strong>show source files</strong> will show you a list of all source files in the compilation database.</td> </tr>
<tr> <th scope="row">Indexed Header Paths</th> <td>Specify one or multiple locations that contain the header files to the source files defined in the compilation database. (For instructions on how to add paths see <a href="#PathListBox">Path List Box</a>.)</td> </tr>
</tbody>
</table>
<strong>Interactions:</strong>
<ul>
<li>Clicking <var>show source files</var> will show you a list of all source files in the compilation database.</li>
<li>Clicking <var>Select From Include Paths</var> will display a dialog showing a list of all the Include Paths used within the Compilation Database. You can select paths and all headers that are included within these paths will also get indexed.</li>
<li>Clicking <var>Cancel</var> or pressing <var>ESC</var> will close the window and abort the setup process.</li>
<li>Clicking <var>Next</var> will take you to the next step of the setup process.</li>
@@ -930,7 +940,7 @@
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.sourcetrailproject</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.srctrlprj</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Location</th> <td>Choose the location of the project file from the dialog.</td> </tr>
<tr> <th scope="row">Standard</th> <td>Select the language standard that should be used for indexing your project. We currently only support Java 8</td> </tr>
</tbody>
@@ -993,6 +1003,91 @@
<div class="row" style="height:20px;"></div>
<h4 id="CreateAProjectFromMavenConfiguration">Create a Java Project from your Maven Configuration</h4>
<p>If you are using a Maven configuration to manage and build your project use this approach to create a Sourcetrail project.</p>
<strong>Maven Project Meta Data</strong>
<p>In the first step you need to enter meta information about the project.</p>
<div class="row">
<div class="col-sm-8 col-sm-offset-2">
<img src="img/project_setup_wizard_empty_meta_java.png" style="width:100%;">
</div>
</div>
<table class="table table-hover">
<thead>
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Sourcetrail Project Name</th> <td>The name of the project. This will also be the name of the <code>.srctrlprj</code> file generated by Sourcetrail.</td> </tr>
<tr> <th scope="row">Sourcetrail Project Location</th> <td>Choose the location of the project file from the dialog.</td> </tr>
<tr> <th scope="row">Standard</th> <td>Select the language standard that should be used for indexing your project. We currently only support Java 8</td> </tr>
</tbody>
</table>
<strong>Interactions:</strong>
<ul>
<li>Clicking <var>Cancel</var> or pressing <var>ESC</var> will close the window and abort the setup process.</li>
<li>Clicking <var>Next</var> will take you to the next step of the setup process.</li>
<li>Clicking <var>Previous</var> will take you to the previous step of the setup process. All the information you entered will be saved.</li>
</ul>
<div class="row" style="height:20px;"></div>
<strong>Maven Project Indexed Paths</strong>
<p>In the first step you need to enter meta information about the project.</p>
<div class="row">
<div class="col-sm-10 col-sm-offset-1">
<img src="img/project_setup_wizard_java_maven.png" style="width:100%;">
</div>
</div>
<table class="table table-hover">
<thead>
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Maven Project File</th> <td> The path to the <code>pom</code> file in the root folder of your Maven project. </tr>
<tr> <th scope="row">Should Index Tests</th> <td> This checkbox indicates whether or not Sourcetrail indexes the test code that is part of your Maven project. </tr>
<tr> <th scope="row">Intermediate Dependencies Directory</th> <td>Directory where Sourcetrail stores all of the project's <code>.jar</code> dependencies.</td> </tr>
</tbody>
</table>
<strong>Interactions:</strong>
<ul>
<li>Clicking <var>show source files</var> will show you a list of all source files that have been detected in the Maven project. If <var>Should Index Tests</var> is checked this list also includes the test source files. </li>
<li>Clicking <var>Cancel</var> or pressing <var>ESC</var> will close the window and abort the setup process.</li>
<li>Clicking <var>Next</var> will take you to the next step of the setup process.</li>
<li>Clicking <var>Previous</var> will take you to the previous step of the setup process.</li>
</ul>
<div class="row" style="height:20px;"></div>
<strong>Advanced Settings</strong>
<p>In this dialog you can enter additional settings. You can define source file extentions and you can exclude certain paths or files from indexing.</p>
<div class="row">
<div class="col-sm-10 col-sm-offset-1">
<img src="img/project_setup_wizard_advanced_java.png" style="width:100%;">
</div>
</div>
<table class="table table-hover">
<thead>
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Source File Extensions</th> <td>Define extensions for source files including the dot e.g. <code>.cpp</code> or <code>.java</code></td> </tr>
<tr> <th scope="row">Exclude Paths</th> <td>Exclude Paths define the files and directories that will be left out from indexing. (For instructions on how to add paths see <a href="#PathListBox">Path List Box</a>.)</td> </tr>
</tbody>
</table>
<strong>Interactions:</strong>
<ul>
<li>Clicking <var>Cancel</var> or pressing <var>ESC</var> will close the window and abort the setup process.</li>
<li>Clicking <var>Next</var> will take you to the next step of the setup process.</li>
<li>Clicking <var>Previous</var> will take you to the previous step of the setup process. All the information you entered will be saved.</li>
</ul>
<div class="callout callout-info">
<p>After this step the <a href="#NewProjectSummary">New Project Summary</a> will appear as last step in the project creation proccess.</p>
</div>
<div class="row" style="height:20px;"></div>
<h3>New Project Summary</h3>
<p>This window appears at the end of the <a href = "ProjectSetupWizard">Project Setup Wizard</a> to summarize all the information entered before. It is the same as the <a href="#EditProjectWindow">Edit Project Window</a>.</p>
@@ -1272,7 +1367,31 @@
<strong>Reset font size</strong>
<ul>
<li>Shortcut: <a href="#Shortcuts">Reset font size</a></li>
<li>Decrease the font size to the original size.</li>
<li>Resets the font size to the original size.</li>
</ul>
</li>
<li>
<strong>Reset window layout</strong>
<ul>
<li>Resets all the dock widgets to their original layout.</li>
</ul>
</li>
</ul>
<h3>Bookmarks</h3>
<ul>
<li>
<strong>Bookmark Active Symbol</strong>
<ul>
<li>Shortcut: <a href="#Shortcuts">Bookmark Active Symbol</a></li>
<li>Opens the <a href="#BookmarkCreator">Bookmark Creator</a> dialog create a new bookmark.</li>
</ul>
</li>
<li>
<strong>Bookmark Manager</strong>
<ul>
<li>Shortcut: <a href="#Shortcuts">Bookmark Manager</a></li>
<li>Opens the <a href="#BookmarkManager">Bookmark Manager</a> dialog for viewing all bookmarks.</li>
</ul>
</li>
</ul>
@@ -1438,15 +1557,27 @@
<td><kbd>Cmd + 0</kbd></td>
<td><kbd>Ctrl + 0</kbd></td>
</tr>
<tr>
<th scope="row">Bookmark Active Symbol</th>
<td><kbd>Ctrl + D</kbd></td>
<td><kbd>Cmd + D</kbd></td>
<td><kbd>Ctrl + D</kbd></td>
</tr>
<tr>
<th scope="row">Bookmark Manager</th>
<td><kbd>Ctrl + B</kbd></td>
<td><kbd>Cmd + B</kbd></td>
<td><kbd>Ctrl + B</kbd></td>
</tr>
</tbody>
</table>
<div class="row" style="height:40px;"></div>
<h2>Graph View</h2>
<p>The graph view visualizes the currently selected symbol and all its relationships to other symbols as an interactive graph visualization.</p>
<p>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 at <a href="#Depth Graph">Depth Graph</a>.</p>
<div class="row">
<div class="col-sm-8 col-sm-offset-2">
<div class="col-sm-10 col-sm-offset-1">
<img src="img/graph_view.png" style="width:100%;">
</div>
</div>
@@ -1460,7 +1591,7 @@
<strong>Zooming:</strong>
<ul>
<li>Press the <kbd>+</kbd> and <kbd>-</kbd> buttons in the lower left corner.</li>
<li>Hold <kbd>Shift</kbd> and scroll with mouse wheel or mouse pad.</li>
<li>Hold <kbd>Ctrl/Cmd</kbd> and scroll with mouse wheel or mouse pad.</li>
<li>Press <kbd>Shift + W</kbd> or <kbd>Shift + S</kbd>.</li>
<li>Press <kbd>0</kbd> to reset zoom.</li>
</ul>
@@ -1518,6 +1649,22 @@
<li>Hover an edge to see a tooltip that displays the edge’s type.</li>
</ul>
<h3>Depth Graph</h3>
<p>Using the toolbar in the top left you can display whole call graphs, inheritance chains or include trees for the currently active symbol if the right symbol type is currently active.</p>
<div class="row">
<div class="col-sm-12">
<img src="img/call_graph.png" style="width:100%;">
</div>
</div>
<strong>Interactions:</strong>
<ul>
<li>Click the arrow button to expand/collapse the <var>Depth Graph</var> controls.</li>
<li>Click the <var>Depth Graph</var> buttons to show a graph or depending/dependent nodes.</li>
<li>Change the slider position to change the maximum depth of the graph. Moving it to the top will use infinite depth.</li>
<li>Click on a node to activate it.</li>
<li>Click on an edge to show it's source location in the <a href="#CodeView">Code View</a>.</li>
</ul>
<div class="row" style="height:40px;"></div>
<h2>Code View</h2>
@@ -1605,7 +1752,7 @@
<h3>Back & Forward</h3>
<p>The left <var>Backward</var> button lets you undo your last navigation actions (see <a href="#Back">Back</a>) and the right <var>Forward</var> button lets you redo your undone navigation actions again (see <a href="#Forward">Forward</a>). Both buttons are only enabled when the respective actions are available at the moment.</p>
<div class="row">
<div class="col-xs-2 col-xs-offset-5">
<div class="col-xs-3 col-xs-offset-4">
<img src="img/undo_redo_buttons.png" style="width:100%;">
</div>
</div>
@@ -1694,6 +1841,62 @@
<li>Start a query with <code>??</code> to do a case-sensitive full text search.</li>
</ul>
<h3>Bookmarking Buttons</h3>
<p>The <var>Bookmark Active Symbol</var> button on the left opens the <a href="#BookmarkCreator">Bookmark Creator</a> to create a new bookmark. The <var>Bookmark Manager</var> button on the right is used to display the <a href="#BookmarkManager">Bookmark Manager</a> for activating and editing your bookmarks.</p>
<div class="row">
<div class="col-xs-3 col-xs-offset-4">
<img src="img/bookmark_buttons.png" style="width:100%;">
</div>
</div>
<strong>Interactions:</strong>
<ul>
<li>Hover the buttons to see a tool tip.</li>
<li>Press the buttons to execute the respective action.</li>
</ul>
<h3>Bookmark Creator</h3>
<p>Use the <var>Bookmark Creator</var> to create or edit bookmarks.</p>
<div class="row">
<div class="col-xs-8 col-xs-offset-2">
<img src="img/bookmark_creator.png" style="width:100%;">
</div>
</div>
<table class="table table-hover">
<thead>
<tr> <th>Setting</th> <th>Description</th> </tr>
</thead>
<tbody>
<tr> <th scope="row">Name</th> <td>The name of the bookmark. Initially the name of the node or edge is used.</td> </tr>
<tr> <th scope="row">Comment</th> <td>Add an optional comment to the bookmark.</td> </tr>
<tr> <th scope="row">Category</th> <td>Add the bookmark to a certain category. Bookmarks with the same category are grouped together in the <a href="#BookmarkManager">Bookmark Manager</a>.</td> </tr>
</tbody>
</table>
<strong>Interactions:</strong>
<ul>
<li>Press <var>Cancel</var> to close without changes.</li>
<li>Press <var>Create/Save</var> to save the bookmark or apply the changes.</li>
</ul>
<h3>Bookmark Manager</h3>
<p>Use the <var>Bookmark Manager</var> 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 <var>default</var> category. The buttons for removing/editing categories or bookmarks are only visible when hovering the respective line. Bookmark information is stored within a separate <code>.srctrlbm</code> file next to your <code>.srctrlprj</code> project file.</p>
<div class="row">
<div class="col-xs-10 col-xs-offset-1">
<img src="img/bookmark_manager.png" style="width:100%;">
</div>
</div>
<strong>Interactions:</strong>
<ul>
<li>Activate bookmarks by clicking on the name.</li>
<li>Open/Collapse the bookmark comment by clicking within the bookmark line.</li>
<li>Click the <var>Edit</var> button to change the contents of the bookmark.</li>
<li>Click the <var>Delete</var> button at a bookmark to remove the bookmark.</li>
<li>Open/Collapse categories by clicking in their line.</li>
<li>Click the <var>Delete</var> button at a category to remove the category and all bookmarks within.</li>
<li>Change the <var>Show</var> filter to switch between display of nodes and/or edges.</li>
<li>Change the <var>Sorting</var> to change the order of bookmarks within their categories.</li>
</ul>
<div class="row" style="height:40px;"></div>
<h2>Status View</h2>
@@ -2135,7 +2338,7 @@
<script src="js/jquery-1.12.0.min.js"></script>
<script src="js/jquery-ui.min.js"></script>
<script src="js/jquery.tocify.js"></script>
<script src="js/jquery.tocify.min.js"></script>
<script>
$(function() {