{"id":1387,"date":"2022-03-30T08:24:42","date_gmt":"2022-03-30T07:24:42","guid":{"rendered":"http:\/\/computree.onf.fr\/?page_id=689"},"modified":"2022-11-21T14:59:15","modified_gmt":"2022-11-21T13:59:15","slug":"documentation-steps","status":"publish","type":"page","link":"https:\/\/computree.onf.fr\/?page_id=1387","title":{"rendered":"Step documentation"},"content":{"rendered":"<p>Each processing step proposed by a Computree plugin has an associated documentation. This documentation is the responsibility of the plugin developers, and is therefore more or less detailed depending on the case.<\/p>\n<p>It is accessible directly in the Computree GUI, and is generated in HTML format the first time you use the software (in the active language). It is offered in English, and optionally in French depending on the plugins.<\/p>\n<h2>How to access documentation of the steps?<\/h2>\n<h3>In the add steps menu<\/h3>\n<p>Right-clicking on a step opens the contextual menu.<br \/>\nFrom this menu, click <em>Step Documentation<\/em>.<br \/>\nThis provides access to the documentation page for the selected step.<\/p>\n<p><a href=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-922 size-full\" src=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png\" alt=\"\" width=\"489\" height=\"418\" \/><\/a><\/p>\n<h3>Directly in the processing chain<\/h3>\n<p>Right-clicking on an added step opens the contextual menu.<br \/>\nFrom this menu, click <em>Step Documentation<\/em>.<br \/>\nThis provides access to the documentation page for the selected step.<\/p>\n<p><a href=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_script_EN.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-920 size-full\" src=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_script_EN.png\" alt=\"\" width=\"564\" height=\"325\" \/><\/a><\/p>\n<h3>In the help menu<\/h3>\n<p>On the <em>Help<\/em> menu, click <em>Documentation of the steps<\/em>.<br \/>\nThis provides access to the documentation index of the steps.<\/p>\n<p><a href=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_doc_EN.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-921 size-full\" src=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_doc_EN.png\" alt=\"\" width=\"539\" height=\"102\" \/><\/a><\/p>\n<h3>External opening of the HTML index file<\/h3>\n<p>It is also possible to open the generated documentation files directly.<br \/>\nTo do this, open the <em>Computree\/doc_en<\/em> folder or <em>Computree\/doc_fr<\/em> .<br \/>\nThen open the <em>index.html<\/em> file in a web browser.<\/p>\n<h2>Organization of documentation<\/h2>\n<p>On the left side, an index of the steps organized in the same way as the steps menu allows you to navigate through the documentation of the steps.<\/p>\n<p>Documentation for a step includes the following sections:<\/p>\n<ul>\n<li><strong>Page Title<\/strong> : Name of the step, as displayed in the steps menu<\/li>\n<li><strong>Plugin<\/strong> : name of the plugin offering this step, with a link to the plugin&rsquo;s web page<\/li>\n<li><strong>Class Name<\/strong> : The name of the class (source code) corresponding to the step.<\/li>\n<li><strong>Description<\/strong> : Description of the general operation of the stage<\/li>\n<li><strong>Settings<\/strong> : Step settings that can be changed by the user when adding the step<\/li>\n<li><strong>Input data<\/strong> : data required as input for the step<\/li>\n<li><strong>Output data<\/strong> : data produced as the output of the step<\/li>\n<li><strong>Details<\/strong> : Additional information on the detailed operation of the step or use cases. This section is not always present, depending on the complexity of the step, and the level of documentation proposed by the plugin developer.<\/li>\n<\/ul>\n<h2>Re-generate documentation<\/h2>\n<p>In case of problems it is possible to re-create the entire documentation.<br \/>\nTo do this, on the <em>Help<\/em> menu, click <em>Recreate Documentation of the steps<\/em>.<\/p>\n<p><a href=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_recreer_EN.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-923 size-full\" src=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_recreer_EN.png\" alt=\"\" width=\"536\" height=\"98\" \/><\/a><\/p>\n<p>This generation is done automatically when Computree is first launched, in the active language.<br \/>\nIf the active language is changed, the documentation in the corresponding language will be created the next time Computree starts.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Each processing step proposed by a Computree plugin has an associated documentation. This documentation is the responsibility of the plugin developers, and is therefore more or less detailed depending on the case. It is accessible directly in the Computree GUI, and is generated in HTML format the first time you use the software (in the [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ocean_post_layout":"","ocean_both_sidebars_style":"","ocean_both_sidebars_content_width":0,"ocean_both_sidebars_sidebars_width":0,"ocean_sidebar":"0","ocean_second_sidebar":"0","ocean_disable_margins":"enable","ocean_add_body_class":"","ocean_shortcode_before_top_bar":"","ocean_shortcode_after_top_bar":"","ocean_shortcode_before_header":"","ocean_shortcode_after_header":"","ocean_has_shortcode":"","ocean_shortcode_after_title":"","ocean_shortcode_before_footer_widgets":"","ocean_shortcode_after_footer_widgets":"","ocean_shortcode_before_footer_bottom":"","ocean_shortcode_after_footer_bottom":"","ocean_display_top_bar":"default","ocean_display_header":"default","ocean_header_style":"","ocean_center_header_left_menu":"0","ocean_custom_header_template":"0","ocean_custom_logo":0,"ocean_custom_retina_logo":0,"ocean_custom_logo_max_width":0,"ocean_custom_logo_tablet_max_width":0,"ocean_custom_logo_mobile_max_width":0,"ocean_custom_logo_max_height":0,"ocean_custom_logo_tablet_max_height":0,"ocean_custom_logo_mobile_max_height":0,"ocean_header_custom_menu":"0","ocean_menu_typo_font_family":"0","ocean_menu_typo_font_subset":"","ocean_menu_typo_font_size":0,"ocean_menu_typo_font_size_tablet":0,"ocean_menu_typo_font_size_mobile":0,"ocean_menu_typo_font_size_unit":"px","ocean_menu_typo_font_weight":"","ocean_menu_typo_font_weight_tablet":"","ocean_menu_typo_font_weight_mobile":"","ocean_menu_typo_transform":"","ocean_menu_typo_transform_tablet":"","ocean_menu_typo_transform_mobile":"","ocean_menu_typo_line_height":0,"ocean_menu_typo_line_height_tablet":0,"ocean_menu_typo_line_height_mobile":0,"ocean_menu_typo_line_height_unit":"","ocean_menu_typo_spacing":0,"ocean_menu_typo_spacing_tablet":0,"ocean_menu_typo_spacing_mobile":0,"ocean_menu_typo_spacing_unit":"","ocean_menu_link_color":"","ocean_menu_link_color_hover":"","ocean_menu_link_color_active":"","ocean_menu_link_background":"","ocean_menu_link_hover_background":"","ocean_menu_link_active_background":"","ocean_menu_social_links_bg":"","ocean_menu_social_hover_links_bg":"","ocean_menu_social_links_color":"","ocean_menu_social_hover_links_color":"","ocean_disable_title":"default","ocean_disable_heading":"default","ocean_post_title":"","ocean_post_subheading":"","ocean_post_title_style":"","ocean_post_title_background_color":"","ocean_post_title_background":0,"ocean_post_title_bg_image_position":"","ocean_post_title_bg_image_attachment":"","ocean_post_title_bg_image_repeat":"","ocean_post_title_bg_image_size":"","ocean_post_title_height":0,"ocean_post_title_bg_overlay":0.5,"ocean_post_title_bg_overlay_color":"","ocean_disable_breadcrumbs":"default","ocean_breadcrumbs_color":"","ocean_breadcrumbs_separator_color":"","ocean_breadcrumbs_links_color":"","ocean_breadcrumbs_links_hover_color":"","ocean_display_footer_widgets":"default","ocean_display_footer_bottom":"default","ocean_custom_footer_template":"0","footnotes":""},"folder":[137],"class_list":["post-1387","page","type-page","status-publish","hentry","entry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v22.6 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Step documentation - Computree<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/computree.onf.fr\/?page_id=1387\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Step documentation - Computree\" \/>\n<meta property=\"og:description\" content=\"Each processing step proposed by a Computree plugin has an associated documentation. This documentation is the responsibility of the plugin developers, and is therefore more or less detailed depending on the case. It is accessible directly in the Computree GUI, and is generated in HTML format the first time you use the software (in the [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/computree.onf.fr\/?page_id=1387\" \/>\n<meta property=\"og:site_name\" content=\"Computree\" \/>\n<meta property=\"article:modified_time\" content=\"2022-11-21T13:59:15+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/computree.onf.fr\/?page_id=1387\",\"url\":\"https:\/\/computree.onf.fr\/?page_id=1387\",\"name\":\"Step documentation - Computree\",\"isPartOf\":{\"@id\":\"https:\/\/computree.onf.fr\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/computree.onf.fr\/?page_id=1387#primaryimage\"},\"image\":{\"@id\":\"https:\/\/computree.onf.fr\/?page_id=1387#primaryimage\"},\"thumbnailUrl\":\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png\",\"datePublished\":\"2022-03-30T07:24:42+00:00\",\"dateModified\":\"2022-11-21T13:59:15+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/computree.onf.fr\/?page_id=1387#breadcrumb\"},\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/computree.onf.fr\/?page_id=1387\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/computree.onf.fr\/?page_id=1387#primaryimage\",\"url\":\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png\",\"contentUrl\":\"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png\",\"width\":501,\"height\":416},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/computree.onf.fr\/?page_id=1387#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\/\/computree.onf.fr\/?page_id=497\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Step documentation\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/computree.onf.fr\/#website\",\"url\":\"https:\/\/computree.onf.fr\/\",\"name\":\"Computree\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/computree.onf.fr\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"fr-FR\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Step documentation - Computree","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/computree.onf.fr\/?page_id=1387","og_locale":"fr_FR","og_type":"article","og_title":"Step documentation - Computree","og_description":"Each processing step proposed by a Computree plugin has an associated documentation. This documentation is the responsibility of the plugin developers, and is therefore more or less detailed depending on the case. It is accessible directly in the Computree GUI, and is generated in HTML format the first time you use the software (in the [&hellip;]","og_url":"https:\/\/computree.onf.fr\/?page_id=1387","og_site_name":"Computree","article_modified_time":"2022-11-21T13:59:15+00:00","og_image":[{"url":"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Dur\u00e9e de lecture estim\u00e9e":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/computree.onf.fr\/?page_id=1387","url":"https:\/\/computree.onf.fr\/?page_id=1387","name":"Step documentation - Computree","isPartOf":{"@id":"https:\/\/computree.onf.fr\/#website"},"primaryImageOfPage":{"@id":"https:\/\/computree.onf.fr\/?page_id=1387#primaryimage"},"image":{"@id":"https:\/\/computree.onf.fr\/?page_id=1387#primaryimage"},"thumbnailUrl":"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png","datePublished":"2022-03-30T07:24:42+00:00","dateModified":"2022-11-21T13:59:15+00:00","breadcrumb":{"@id":"https:\/\/computree.onf.fr\/?page_id=1387#breadcrumb"},"inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/computree.onf.fr\/?page_id=1387"]}]},{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/computree.onf.fr\/?page_id=1387#primaryimage","url":"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png","contentUrl":"https:\/\/computree.onf.fr\/wp-content\/uploads\/2022\/11\/aide_menu_etapes_EN.png","width":501,"height":416},{"@type":"BreadcrumbList","@id":"https:\/\/computree.onf.fr\/?page_id=1387#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/computree.onf.fr\/?page_id=497"},{"@type":"ListItem","position":2,"name":"Step documentation"}]},{"@type":"WebSite","@id":"https:\/\/computree.onf.fr\/#website","url":"https:\/\/computree.onf.fr\/","name":"Computree","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/computree.onf.fr\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"fr-FR"}]}},"_links":{"self":[{"href":"https:\/\/computree.onf.fr\/index.php?rest_route=\/wp\/v2\/pages\/1387","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/computree.onf.fr\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/computree.onf.fr\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/computree.onf.fr\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/computree.onf.fr\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1387"}],"version-history":[{"count":7,"href":"https:\/\/computree.onf.fr\/index.php?rest_route=\/wp\/v2\/pages\/1387\/revisions"}],"predecessor-version":[{"id":1707,"href":"https:\/\/computree.onf.fr\/index.php?rest_route=\/wp\/v2\/pages\/1387\/revisions\/1707"}],"wp:attachment":[{"href":"https:\/\/computree.onf.fr\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1387"}],"wp:term":[{"taxonomy":"folder","embeddable":true,"href":"https:\/\/computree.onf.fr\/index.php?rest_route=%2Fwp%2Fv2%2Ffolder&post=1387"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}