Difference between revisions of "Documentation/Nightly/Developers/Tutorials"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
 
(21 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
<!-- ---------------------------------------------------- -->
+
{{:Documentation/{{documentation/version}}/Developers/Tutorials/MigrationGuide}}
<includeonly>[[Documentation/{{documentation/version}}/Developers/Tutorials|Source code How-tos]]</includeonly>
+
{{:Documentation/{{documentation/version}}/Developers/Tutorials/Source}}
<noinclude><span style="color: #555555; font-size: 18px; font-weight: bold;">Source code How-tos</span>
+
{{:Documentation/{{documentation/version}}/Developers/Tutorials/Module}}
----
+
{{:Documentation/{{documentation/version}}/Developers/Tutorials/Testing}}
 +
{{:Documentation/{{documentation/version}}/Developers/Tutorials/Documentation}}
 +
{{:Documentation/{{documentation/version}}/Developers/Tutorials/Extension}}
 +
{{:Documentation/{{documentation/version}}/Developers/Tutorials/Misc}}
  
: [[Documentation/{{documentation/version}}/Developers/Build_Instructions#CHECKOUT_slicer_source_files|Checkout Slicer source]]
+
Debugging instructions: https://slicer.readthedocs.io/en/latest/developer_guide/debugging/index.html
: [[Documentation/{{documentation/version}}/Developers/DevelopmentWithGit|Setup for Git development]] {{new}}
 
: [[Slicer:git-svn#Committing_back_to_svn|Commit change sets]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/ContributePatch|Contribute a patch]]
 
: [[Slicer:git-svn#Integrating_topic_from_external_contributor|Integrate topic from external contributor]]
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Module How-tos</span>
 
<!--
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/CreateExtension|Create an extension]]
 
-->
 
: [[Documentation/{{documentation/version}}/Developers/Modules#Command_Line_Interface_.28CLI.29|Create a  CLI module or extension]]
 
: [[Documentation/{{documentation/version}}/Developers/Modules#Loadable_Modules|Create a Loadable module or extension]]
 
: [[Documentation/{{documentation/version}}/Developers/Modules#Scripted_Modules|Create a Scripted module or extension]]
 
: [[Documentation/{{documentation/version}}/Developers/EditorExtension|Create an Editor effect]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension|Bundle module(s) into a Slicer extension]]
 
: [[Documentation/{{documentation/version}}/Developers/Build_Module|Build module outside of Slicer source tree]]
 
: [[Documentation/{{documentation/version}}/Developers/Build_system/Remote_Module|Add or Update a Remote module]] {{new}}
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Testing How-tos</span>
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/SelfTestModule|Write a Self Test Module]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/CxxTests|Write Cxx tests for your C++ loadable module]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/UploadTestData|Upload test data on Midas]]
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Documentation How-tos</span>
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/DocumentModule|Document a module]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/DocumentExtension|Document an extension]]
 
: [[Documentation/{{documentation/version}}/WikiCheatSheet|Wiki Cheat sheet: Useful templates]] {{new}}
 
: [[Special:Userlogin|Create wiki account]] {{new}}
 
: Web pages update [https://www.slicer.org/slicerWikiWeb/ here]
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Extension How-tos</span>
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/ObtainExtensionServerApiKey|Obtain an API key to submit on the extension server]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/Contribute_Extension_Description_File_using_Extension_Wizard|Contribute an extension description file using the wizard]] {{new}}
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/Contribute_Extension_Description_File|Manually contributing an extension description file]]
 
: [[Documentation/{{documentation/version}}/Developers/FAQ#How_to_build_an_extension_.3F|Build an extension]]
 
: [[Documentation/{{documentation/version}}/Developers/FAQ#How_to_package_an_extension_.3F|Package an extension]]
 
: [[Documentation/{{documentation/version}}/Developers/FAQ#How_to_upload_an_extension_.3F|Upload an extension]]
 
: [[Documentation/{{documentation/version}}/Developers/Build_ExtensionsIndex|Build an ExtensionsIndex]] {{wip}}
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Porting How-tos</span>
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/PortingCLIToITKv4|Port a CLI to ITKv4]]
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Dev How-tos</span>
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/QtCreator|Setup QtCreator to develop Slicer application or modules]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/DashboardSetup|Setup a dashboard]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/WidgetWriting|Write a widget for Slicer and Qt Designer]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/QtDesigner|Use custom widgets in Qt Designer]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/PythonAndUIFile|Load UI file from python]]
 
</noinclude>
 
<!-- ---------------------------------------------------- -->
 
<includeonly></includeonly><noinclude><hr>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Debugging How-tos</span>
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/Debug Instructions|Use debugger with Slicer application]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/Troubleshooting|Troubleshoot issues such as crash, or memory leaks]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/MemoryManagement|Prevent memory leaks - VTK, Python and reference counting]]
 
: [[Documentation/{{documentation/version}}/Developers/Tutorials/Debugging_Python_in_Visual_Studio|Debugging Python in Visual Studio]]
 
</noinclude>
 

Latest revision as of 20:08, 4 February 2022

Home < Documentation < Nightly < Developers < Tutorials


For the latest Slicer documentation, visit the read-the-docs.


Migration Guide

How to update Slicer extension code following breaking changes in Slicer or dependent toolkits (VTK, ITK, Qt, ...)

Source code How-tos

How to checkout the source and contribute patches

Module How-tos

How to create or build modules, how to add or update remote modules

Testing How-tos

How to write tests and manage testing data

Documentation How-tos

How to document module or extension

Extension How-tos

How to contribute, build or package extensions

Misc How-tos

How to setup QtCreator, setup dashboard, work with QtDesigner, port modules


Debugging instructions: https://slicer.readthedocs.io/en/latest/developer_guide/debugging/index.html