| 7 | | == Main features == |
| 8 | | * Semantic Queries (to query different kinds of syntactic and semantic information about the source code) |
| 9 | | * User-defined [wiki:SemanticQuery semantic queries] (see [wiki:QueryComponents the reference of available components]) and integrated with them, [wiki:MetricQuery metric queries] |
| 10 | | * [wiki:PreDefinedSemanticQuery Pre-defined semantic queries] in the web interface |
| 11 | | * [wiki:SideEffect Side effect] analysis |
| 12 | | * [wiki:DataFlow Data-flow] and [wiki:DynFunAnal dynamic function call] analysis |
| 13 | | * [wiki:Dependency Dependency] analysis |
| 14 | | * [wiki:InterfaceLayers Interface layer] consistency check |
| 15 | | * [wiki:ModuleFunctionClustering Module and function clustering] |
| 16 | | * 24 different [wiki:RefactoringSteps refactoring steps] |
| 17 | | * Layout preservation for unmodified source parts |
| 18 | | * Two different storage backends: [wiki:MnesiaDB Mnesia] and [wiki:NifDB C++ graph based] |
| | 7 | == Getting started |
| | 8 | |
| | 9 | ==== Installation |
| | 10 | |
| | 11 | * [http://www.erlang.org/doc/installation_guide/users_guide.html How to install Erlang] |
| | 12 | * [wiki:Install How to install the tool] |
| | 13 | * [http://yaws.hyber.org/configuration.yaws How to install Yaws] (required for the web UI) |
| | 14 | |
| | 15 | * HowtoConfigureRefactorErl |
| | 16 | * HowtoConfigureEmacs |
| | 17 | * HowtoConfigureEclipse |
| | 18 | * HowtoConfigureVim |
| | 19 | * HowtoSetupWebInterface |
| | 20 | |
| | 21 | ==== Starting up |
| | 22 | |
| | 23 | * [FirstUsage How to start the tool] |
| | 24 | * HowtoStartAsStandaloneServer |
| | 25 | |
| | 26 | == Analysing Source Code |
| | 27 | |
| | 28 | * HowtoAddFiles |
| | 29 | * HowtoAddIncludePaths |
| | 30 | * [InitialLoadingError Handling errors at initial loading] |
| | 31 | |
| | 32 | == Feature Highlights |
| | 33 | |
| | 34 | * Static Analysis |
| | 35 | * [SideEffects Side effects] |
| | 36 | * [DataFlow Data-flow] and [DynFunAnal dynamic function calls] |
| | 37 | * [wiki:Dependency Module and function dependencies] |
| | 38 | * [InterfaceLayers Interface layer] consistency check |
| | 39 | |
| | 40 | * Comprehension (getting syntactic and semantic information about the source code) |
| | 41 | * [SemanticQuery Custom semantic queries] (see the reference of [wiki:QueryComponents available components]) and [MetricQuery metric queries] |
| | 42 | * [PreDefinedSemanticQuery Pre-defined semantic queries] (available via the web interface) |
| | 43 | |
| | 44 | * Code refactoring: 24 different [RefactoringSteps refactoring steps] |
| | 45 | |
| | 46 | * [ModuleFunctionClustering Module and function clustering] |
| | 47 | |
| | 48 | * Multiple storage back-ends: [wiki:MnesiaDB Mnesia] and [wiki:NifDB C++ graph based] |
| 24 | | * [wiki:WebInterface Web interface] |
| 25 | | * [wiki:CommandLineInterface Linux shell interface (CLI)] |
| 26 | | * [wiki:EmacsInterface Emacs/XEmacs interface] |
| 27 | | * [wiki:EclipseInterface Eclipse], [wiki:VimInterface Vim plugin] |
| 28 | | |
| 29 | | == HOWTOs == |
| 30 | | |
| 31 | | === Installing and configuring the tool or the interfaces === |
| 32 | | |
| 33 | | * [wiki:HowtoInstallErlang How to install Erlang?] |
| 34 | | * [wiki:Install How to install the tool?] |
| 35 | | * [wiki:HowtoInstallYaws How to install Yaws?] |
| 36 | | * [wiki:HowtoConfigureEmacs] |
| 37 | | * [wiki:HowtoConfigureEclipse] |
| 38 | | * [wiki:HowtoConfigureVim] |
| 39 | | * [wiki:HowtoWebInterface] |
| 40 | | |
| 41 | | === Starting the tool === |
| 42 | | |
| 43 | | * [wiki:HowtoStartAsAStandaloneServer] |
| 44 | | * [wiki:] |
| 45 | | |
| 46 | | [wiki:FirstUsage Starting the tool] |
| 47 | | |
| 48 | | === Analysing the source code === |
| 49 | | |
| 50 | | * [wiki:HowtoAddFiles] |
| 51 | | * [wiki:HowtoAddIncludePaths] |
| 52 | | * [wiki:] |
| 53 | | |
| 54 | | [wiki:InitialLoadingError Handling errors at initial loading] |
| 55 | | |
| 56 | | == To be continued... == |
| 57 | | |
| 58 | | |
| 59 | | |
| 60 | | |
| 61 | | |
| 62 | | |
| 63 | | |
| 64 | | |
| 65 | | |
| 66 | | {{{#!comment |
| 67 | | = Welcome to Trac 0.12.2 = |
| 68 | | |
| 69 | | Trac is a '''minimalistic''' approach to '''web-based''' management of |
| 70 | | '''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress. |
| 71 | | |
| 72 | | All aspects of Trac have been designed with the single goal to |
| 73 | | '''help developers write great software''' while '''staying out of the way''' |
| 74 | | and imposing as little as possible on a team's established process and |
| 75 | | culture. |
| 76 | | |
| 77 | | As all Wiki pages, this page is editable, this means that you can |
| 78 | | modify the contents of this page simply by using your |
| 79 | | web-browser. Simply click on the "Edit this page" link at the bottom |
| 80 | | of the page. WikiFormatting will give you a detailed description of |
| 81 | | available Wiki formatting commands. |
| 82 | | |
| 83 | | "[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created |
| 84 | | a new Trac environment, containing a default set of wiki pages and some sample |
| 85 | | data. This newly created environment also contains |
| 86 | | [wiki:TracGuide documentation] to help you get started with your project. |
| 87 | | |
| 88 | | You can use [wiki:TracAdmin trac-admin] to configure |
| 89 | | [http://trac.edgewall.org/ Trac] to better fit your project, especially in |
| 90 | | regard to ''components'', ''versions'' and ''milestones''. |
| 91 | | |
| 92 | | |
| 93 | | TracGuide is a good place to start. |
| 94 | | |
| 95 | | Enjoy! [[BR]] |
| 96 | | ''The Trac Team'' |
| 97 | | |
| 98 | | == Starting Points == |
| 99 | | |
| 100 | | * TracGuide -- Built-in Documentation |
| 101 | | * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project |
| 102 | | * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions |
| 103 | | * TracSupport -- Trac Support |
| 104 | | |
| 105 | | For a complete list of local wiki pages, see TitleIndex. |
| 106 | | }}} |
| | 54 | * [WebInterface Web interface] |
| | 55 | * [CommandLineInterface Linux shell interface (CLI)] |
| | 56 | * [EmacsInterface Emacs/XEmacs interface] |
| | 57 | * [EclipseInterface Eclipse], [VimInterface Vim plugin] |
