doc: tutorial refactor

2026-07-29 23:33:05 +04:00 · 2020-12-05 01:46:00 +03:00
parent 6fdb7aee84
commit 461e26b60b
263 changed files with 623 additions and 878 deletions
@@ -1,6 +1,9 @@
 OpenCV configuration options reference {#tutorial_config_reference}
 ======================================

+@prev_tutorial{tutorial_general_install}
+@next_tutorial{tutorial_linux_install}
+
@tableofcontents

 # Introduction {#tutorial_config_reference_intro}
@@ -1,7 +1,7 @@
 Cross compilation for ARM based Linux systems {#tutorial_arm_crosscompile_with_cmake}
 =============================================

-@prev_tutorial{tutorial_ios_install}
+@prev_tutorial{tutorial_macos_install}
@next_tutorial{tutorial_building_tegra_cuda}

 |    |    |
@@ -667,20 +667,9 @@ Write the tutorial {#tutorial_documentation_steps_tutorial}
 6.  Add newly created tutorial to the corresponding table of contents. Just find
    <em>"table_of_content_*.markdown"</em> file with the needed table and place new record in it
    similar to existing ones.
-    @verbatim
-   @subpage tutorial_windows_visual_studio_image_watch

-    _Languages:_ C++, Java, Python
-
-    _Compatibility:_ \>= OpenCV 2.4
-
-    _Author:_ Wolf Kienzle
-
-    You will learn how to visualize OpenCV matrices and images within Visual Studio 2012.
-    @endverbatim
-    As you can see it is just a list item with special _subpage_ command which marks your page as a
-    child and places it into the existing pages hierarchy. Add compatibility information,
-    authors list and short description. Also note the list item indent, empty lines between
+    It is simply a list item with special _subpage_ command which marks your page as a
+    child and places it into the existing pages hierarchy. Also note the list item indent, empty lines between
    paragraphs and special _italic_ markers.

 7.  Generate doxygen documentation and verify results.
@@ -1,6 +1,8 @@
 OpenCV installation overview {#tutorial_general_install}
 ============================

+@next_tutorial{tutorial_config_reference}
+
@tableofcontents

 There are two ways of installing OpenCV on your machine: download prebuilt version for your platform or compile from sources.
@@ -1,78 +0,0 @@
-Installation in iOS {#tutorial_ios_install}
-===================
-
-@prev_tutorial{tutorial_macos_install}
-@next_tutorial{tutorial_arm_crosscompile_with_cmake}
-
-|    |    |
-| -: | :- |
-| Original author | Artem Myagkov, Eduard Feicho, Steve Nicholson |
-| Compatibility | OpenCV >= 3.0 |
-
-@warning
-This tutorial can contain obsolete information.
-
-Required Packages
-----------------
-
-   CMake 2.8.8 or higher
-   Xcode 4.2 or higher
-
-### Getting the Cutting-edge OpenCV from Git Repository
-
-Launch Git client and clone OpenCV repository from [GitHub](http://github.com/opencv/opencv).
-
-In MacOS it can be done using the following command in Terminal:
-
-@code{.bash}
-cd ~/<my_working _directory>
-git clone https://github.com/opencv/opencv.git
-@endcode
-
-If you want to install OpenCV’s extra modules, clone the opencv_contrib repository as well:
-
-@code{.bash}
-cd ~/<my_working _directory>
-git clone https://github.com/opencv/opencv_contrib.git
-@endcode
-
-
-Building OpenCV from Source, using CMake and Command Line
---------------------------------------------------------
-
-1.  Make sure the xcode command line tools are installed:
-    @code{.bash}
-    xcode-select --install
-    @endcode
-
-2.  Build OpenCV framework:
-    @code{.bash}
-    cd ~/<my_working_directory>
-    python opencv/platforms/ios/build_framework.py ios
-    @endcode
-
-3.  To install OpenCV’s extra modules, append `--contrib opencv_contrib` to the python command above. **Note:** the extra modules are not included in the iOS Pack download at [OpenCV Releases](https://opencv.org/releases/). If you want to use the extra modules (e.g. aruco), you must build OpenCV yourself and include this option:
-    @code{.bash}
-    cd ~/<my_working_directory>
-    python opencv/platforms/ios/build_framework.py ios --contrib opencv_contrib
-    @endcode
-
-4.  To exclude a specific module, append `--without <module_name>`. For example, to exclude the "optflow" module from opencv_contrib:
-    @code{.bash}
-    cd ~/<my_working_directory>
-    python opencv/platforms/ios/build_framework.py ios --contrib opencv_contrib --without optflow
-    @endcode
-
-5.  The build process can take a significant amount of time. Currently (OpenCV 3.4 and 4.1), five separate architectures are built: armv7, armv7s, and arm64 for iOS plus i386 and x86_64 for the iPhone simulator. If you want to specify the architectures to include in the framework, use the `--iphoneos_archs` and/or `--iphonesimulator_archs` options. For example, to only build arm64 for iOS and x86_64 for the simulator:
-    @code{.bash}
-    cd ~/<my_working_directory>
-    python opencv/platforms/ios/build_framework.py ios --contrib opencv_contrib --iphoneos_archs arm64 --iphonesimulator_archs x86_64
-    @endcode
-
-If everything’s fine, the build process will create
-`~/<my_working_directory>/ios/opencv2.framework`. You can add this framework to your Xcode projects.
-
-Further Reading
---------------
-
-You can find several OpenCV+iOS tutorials here @ref tutorial_table_of_content_ios.
@@ -2,7 +2,7 @@ Installation in MacOS {#tutorial_macos_install}
 =====================

@prev_tutorial{tutorial_android_ocl_intro}
-@next_tutorial{tutorial_ios_install}
+@next_tutorial{tutorial_arm_crosscompile_with_cmake}

 |    |    |
 | -: | :- |
@@ -25,9 +25,9 @@ Introduction to OpenCV {#tutorial_table_of_content_introduction}

 ##### Other platforms
 -   @subpage tutorial_macos_install
-   @subpage tutorial_ios_install
 -   @subpage tutorial_arm_crosscompile_with_cmake
 -   @subpage tutorial_building_tegra_cuda
+-   @ref tutorial_ios_install

 ##### Usage basics
 -   @subpage tutorial_display_image - We will learn how to load an image from file and display it using OpenCV