-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
134 changed files
with
5,360 additions
and
569 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /target/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <projectDescription> | ||
| <name>com.minres.scviewer.doc</name> | ||
| <comment></comment> | ||
| <projects> | ||
| </projects> | ||
| <buildSpec> | ||
| </buildSpec> | ||
| <natures> | ||
| </natures> | ||
| </projectDescription> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <artifactId>com.minres.scviewer.doc</artifactId> | ||
| <version>1.0.0-SNAPSHOT</version> | ||
| <packaging>pom</packaging> | ||
| <parent> | ||
| <groupId>com.minres.scviewer</groupId> | ||
| <artifactId>com.minres.scviewer.parent</artifactId> | ||
| <version>2.16.0</version> | ||
| <relativePath>../..</relativePath> | ||
| </parent> | ||
|
|
||
| <properties> | ||
| <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
| <asciidoctor.maven.plugin.version>2.0.0</asciidoctor.maven.plugin.version> | ||
| <asciidoctorj.pdf.version>1.6.2</asciidoctorj.pdf.version> | ||
| <help.plugin.target.dir>../../plugins/com.minres.scviewer.e4.application.help</help.plugin.target.dir> | ||
| </properties> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.asciidoctor</groupId> | ||
| <artifactId>asciidoctor-maven-plugin</artifactId> | ||
| <version>${asciidoctor.maven.plugin.version}</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.asciidoctor</groupId> | ||
| <artifactId>asciidoctorj-pdf</artifactId> | ||
| <version>${asciidoctorj.pdf.version}</version> | ||
| </dependency> | ||
| </dependencies> | ||
| <configuration> | ||
| <sourceDirectory>src/asciidoc</sourceDirectory> | ||
| <sourceDocumentName>SCViewerHelp.adoc</sourceDocumentName> | ||
| <headerFooter>true</headerFooter> | ||
| </configuration> | ||
| <executions> | ||
| <execution> | ||
| <id>output-html</id> | ||
| <phase>generate-resources</phase> | ||
| <goals> | ||
| <goal>process-asciidoc</goal> | ||
| </goals> | ||
| <configuration> | ||
| <sourceHighlighter>coderay</sourceHighlighter> | ||
| <backend>html</backend> | ||
| <attributes> | ||
| <toc /> | ||
| <linkcss>false</linkcss> | ||
| </attributes> | ||
| </configuration> | ||
| </execution> | ||
| <execution> | ||
| <id>output-docbook</id> | ||
| <phase>generate-resources</phase> | ||
| <goals> | ||
| <goal>process-asciidoc</goal> | ||
| </goals> | ||
| <configuration> | ||
| <backend>docbook</backend> | ||
| </configuration> | ||
| </execution> | ||
| <execution> | ||
| <id>output-pdf</id> | ||
| <phase>generate-resources</phase> | ||
| <goals> | ||
| <goal>process-asciidoc</goal> | ||
| </goals> | ||
| <configuration> | ||
| <backend>pdf</backend> | ||
| <sourceHighlighter>coderay</sourceHighlighter> | ||
| <attributes> | ||
| <icons>font</icons> | ||
| <pagenums /> | ||
| <toc /> | ||
| <idprefix /> | ||
| <idseparator>-</idseparator> | ||
| </attributes> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-resources-plugin</artifactId> | ||
| <version>2.6</version> | ||
| <executions> | ||
| <execution> | ||
| <id>copy-asciidoc-resources</id> | ||
| <phase>generate-resources</phase> | ||
| <goals> | ||
| <goal>copy-resources</goal> | ||
| </goals> | ||
| <configuration> | ||
| <resources> | ||
| <resource> | ||
| <directory>target/generated-docs/</directory> | ||
| <includes> | ||
| <include>SCViewerHelp.xml</include> | ||
| <include>**/*.jpg</include> | ||
| <include>**/*.png</include> | ||
| <include>**/*.svg</include> | ||
| </includes> | ||
| </resource> | ||
| </resources> | ||
| <outputDirectory>src/docbkx</outputDirectory> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>com.agilejava.docbkx</groupId> | ||
| <artifactId>docbkx-maven-plugin</artifactId> | ||
| <version>2.0.17</version> | ||
| <executions> | ||
| <execution> | ||
| <!-- <phase>generate-sources</phase> --> | ||
| <phase>generate-resources</phase> | ||
| <goals> | ||
| <goal>generate-eclipse</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.docbook</groupId> | ||
| <artifactId>docbook-xml</artifactId> | ||
| <version>4.4</version> | ||
| <scope>runtime</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| <configuration> | ||
| <sourceDirectory>src/docbkx</sourceDirectory> | ||
| <targetDirectory>${help.plugin.target.dir}</targetDirectory> | ||
| <preProcess> | ||
| <copy todir="${help.plugin.target.dir}/images"> | ||
| <fileset dir="src/docbkx/images" /> | ||
| </copy> | ||
| <copy todir="${help.plugin.target.dir}/css"> | ||
| <fileset dir="src/docbkx/css" /> | ||
| </copy> | ||
| </preProcess> | ||
| <imgSrcPath>./</imgSrcPath> | ||
|
|
||
| <useExtensions>1</useExtensions> | ||
| <highlightSource>1</highlightSource> | ||
| <highlightDefaultLanguage>java</highlightDefaultLanguage> | ||
| <calloutsExtension>1</calloutsExtension> | ||
| <paperType>A4</paperType> | ||
| <!--<fop1Extensions>1</fop1Extensions> | ||
| <foCustomization>${basedir}/conf/customization-fopdf.xsl</foCustomization>--> | ||
|
|
||
| <!-- This copies content (images, etc) for the HTML version --> | ||
| <!-- Any parameters specific to HTML version go here --> | ||
| <htmlStylesheet>css/narrow_style.css</htmlStylesheet> | ||
| <!-- <includes>titlepage/titlepage.templates.xml</includes> --> | ||
| <includes>SCViewerHelp.xml</includes> | ||
| <chunkedOutput>true</chunkedOutput> | ||
| <xincludeSupported>true</xincludeSupported> | ||
| <!-- <foCustomization>src/test/resources/docbook-fo.xsl</foCustomization> --> | ||
| <eclipsePluginId>com.minres.scviewer.e4.application.help</eclipsePluginId> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| [#_introduction] | ||
| == Introduction | ||
| [#_overview] | ||
| === SCViewer overview | ||
| SCViewer is composed of a set of eclipse plugins to display VCD and transaction streams | ||
| created by the SystemC VCD trace implementation and the SystemC Verification Library (SCV). | ||
| For further description of the SCV please refer to | ||
| http://www.accellera.org/activities/committees/systemc-verification. | ||
| [#_features] | ||
| === SCViewer features | ||
| Features include: | ||
| * support of VCD files (compressed and uncompressed) | ||
| ** real numbers | ||
| ** showing vectors and real numbers as analog (step-wise & continuous) | ||
| * various value representations of bit vectors | ||
| * support of SCV transaction recordings in various formats | ||
| ** text log files (compressed and uncompressed) | ||
| ** sqlite based | ||
| ** visualization of transaction relations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| [#_reference] | ||
| == Reference | ||
| In this section you will find detailed descriptions of all GUI and menu elements of the SCViewer including their functions and keyboard shortcuts. | ||
| [#_keybindings] | ||
| === Key Shortcuts | ||
| Legend: | ||
| * Left Mouse Button: LMB | ||
| * Middle Mouse Button: MMB | ||
| * Mouse Scroll wheel: MScrl | ||
| * Context any means Name List, Value List or Waveform | ||
| [cols="1,1,1,4",options="header"] | ||
| |=== | ||
| | Input | Modifier | Context | Action | ||
| | LMB click | | any | select | ||
| | LMB click | Shift | Waveform | move selected marker to position | ||
| | LMB click | Control | Waveform | move cursor to position | ||
| | LMB drag | | Waveform | zoom to range | ||
| | MMB click | | Waveform | move selected marker to position | ||
| | MScrl | | any | scroll window up/down | ||
| | MScrl | Shift | any | scroll window left/right | ||
| | Key left | | Waveform | scroll window to the left (slow) | ||
| | Key right | | Waveform | scroll window to the right (slow) | ||
| | Key left | Shift | Waveform | scroll window to the left (fast) | ||
| | Key right | Shift | Waveform | scroll window to the right (fast) | ||
| | Key up | | Waveform | move selection up | ||
| | Key down | | Waveform | move selection down | ||
| | Key up | Control | Waveform | move selected track up | ||
| | Key down | Control | Waveform | move selected track down | ||
| | Key + | Control | Waveform | zoom in | ||
| | Key - | Control | Waveform | zoom out | ||
| | Key Pos1 | | Waveform | jump to selected marker | ||
| | Key End | | Waveform | jump to cursor | ||
| | Key Del | | any | delete selected entries | ||
| | LMB click | | ZoomBar | increment/decrement 1 page | ||
| | LMB drag | | ZoomBar | drag both markers (pan) | ||
| | LMB drag | Control | ZoomBar | drag one marker (zoom) | ||
| | MMB drag | | ZoomBar | drag one marker (zoom) | ||
| | xMB dclick | | ZoomBar | pan to position | ||
| | MScrl | | ZoomBar | scroll window left/right | ||
| | MScrl | Shift | ZoomBar | scroll window left/right double speed | ||
| | MScrl | Control | ZoomBar | zoom in/out | ||
| | Key left | | ZoomBar | scroll window to the left (slow) | ||
| | Key right | | ZoomBar | scroll window to the right (slow) | ||
| | Key up | | ZoomBar | scroll window to the left (slow) | ||
| | Key down | | ZoomBar | scroll window to the right (slow) | ||
| | Key PgUp | | ZoomBar | scroll window to the left (fast) | ||
| | Key PgDown | | ZoomBar | scroll window to the right (fast) | ||
| | Key Pos1 | | ZoomBar | scroll to begin | ||
| | Key End | | ZoomBar | scroll to end | ||
| |=== |
39 changes: 39 additions & 0 deletions
39
doc/com.minres.scviewer.doc/src/asciidoc/SCViewerHelp.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| [#_start] | ||
| = SCViewer User Guide | ||
| :title-logo-image: image:Minres_logo_docs.png[width=750, align="right"] | ||
| :doctype: book | ||
| :source-highlighter: coderay | ||
| :coderay-linenums-mode: inline | ||
| :coderay-css: class | ||
| :listing-caption: Listing | ||
| :icons: font | ||
| //add table-of-contents (toc) and set its depth | ||
| :toc: | ||
| :toclevels: 3 | ||
| :data-uri: | ||
| :sectnums: | ||
| :toc-title: Contents | ||
| :homepage: https://www.minres.com/ | ||
| :keywords: | ||
| :title-page: | ||
| :xrefstyle: short | ||
| :table-caption: Table | ||
| :figure-caption: Figure | ||
| :appendix-caption: Appendix | ||
| :section-refsig: Chapter | ||
| //set directories | ||
| :imagesdir: ./images | ||
| :iconsdir: ./icons | ||
| :stylesdir: ./styles | ||
| :scriptsdir: ./js | ||
| :pdf-themesdir: ./themes | ||
| :pdf-theme: mnrs-doc | ||
| :pdf-fontsdir: ./fonts | ||
| // unset toc, otherwise it appears in table cells -> known bug, should be fixed in later versions! | ||
| :toc!: | ||
| include::Overview.adoc[] | ||
| include::Reference.adoc[] |
Oops, something went wrong.