file：修订位置

Natsu-Akatsuki · Jul 25, 2023 · 2ea34cc · 2ea34cc
1 parent ef0c236
commit 2ea34cc
Show file tree

Hide file tree

Showing 29 changed files with 73 additions and 67 deletions.
diff --git a/docs/Build Tool.md → docs/Beginner/Build Tool.md b/docs/Build Tool.md → docs/Beginner/Build Tool.md
diff --git a/docs/CMake and Package.md → docs/Beginner/CMake and Package.md b/docs/CMake and Package.md → docs/Beginner/CMake and Package.md
diff --git a/docs/Command-Line Interface.md → docs/Beginner/Command-Line Interface.md b/docs/Command-Line Interface.md → docs/Beginner/Command-Line Interface.md
diff --git a/docs/Exectuor and Callback.md → docs/Beginner/Exectuor and Callback.md b/docs/Exectuor and Callback.md → docs/Beginner/Exectuor and Callback.md
diff --git a/docs/Header and Module.md → docs/Beginner/Header and Module.md b/docs/Header and Module.md → docs/Beginner/Header and Module.md
diff --git a/docs/Install.md → docs/Beginner/Install.md b/docs/Install.md → docs/Beginner/Install.md
diff --git a/docs/Interface.md → docs/Beginner/Interface.md b/docs/Interface.md → docs/Beginner/Interface.md
diff --git a/docs/Launch.md → docs/Beginner/Launch.md b/docs/Launch.md → docs/Beginner/Launch.md
diff --git a/docs/Logger.md → docs/Beginner/Logger.md b/docs/Logger.md → docs/Beginner/Logger.md
diff --git a/docs/Network.md → docs/Beginner/Network.md b/docs/Network.md → docs/Beginner/Network.md
diff --git a/docs/Node and Component.md → docs/Beginner/Node and Component.md b/docs/Node and Component.md → docs/Beginner/Node and Component.md
diff --git a/docs/Paramter Server.md → docs/Beginner/Paramter Server.md b/docs/Paramter Server.md → docs/Beginner/Paramter Server.md
diff --git a/docs/Publisher and Subscriber.md → docs/Beginner/Publisher and Subscriber.md b/docs/Publisher and Subscriber.md → docs/Beginner/Publisher and Subscriber.md
diff --git a/docs/Service.md → docs/Beginner/Service.md b/docs/Service.md → docs/Beginner/Service.md
@@ -38,8 +38,13 @@ service = rospy.ServiceProxy('服务名', 服务类型)
 
 # 服务端
 rospy.Service('服务名', 服务类型, 回调函数)
-def self.onCallback(self, req):
-    # TODO
+
+
+def self.
+
+
+    onCallback(self, req):
+# TODO
 ```
 
 ### ROS2
@@ -120,11 +125,11 @@ while not self.cli.wait_for_service(timeout_sec=1.0):
 
 ## Callback
 
-|   —    |                             ROS1                             |                             ROS2                             |
-| :----: | :----------------------------------------------------------: | :----------------------------------------------------------: |
-| 返回值 |                            `bool`                            |                            `void`                            |
-|  形参  |                   引用（无 const，无指针）                    |                       const + 智能指针                       |
-|  示例  | bool on_clear_route(<br/>      ClearRoute::Service::Request &req,<br/>      ClearRoute::Service::Response &res); | void on_clear_route(<br/>    const ClearRoute::Service::Request::SharedPtr req,<br/>    const ClearRoute::Service::Response::SharedPtr res); |
+|  —  |                                                       ROS1                                                       |                                                                     ROS2                                                                     |
+|:---:|:----------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------:|
+| 返回值 |                                                      `bool`                                                      |                                                                    `void`                                                                    |
+| 形参  |                                                 引用（无 const，无指针）                                                  |                                                                 const + 智能指针                                                                 |
+| 示例  | bool on_clear_route(<br/>      ClearRoute::Service::Request &req,<br/>      ClearRoute::Service::Response &res); | void on_clear_route(<br/>    const ClearRoute::Service::Request::SharedPtr req,<br/>    const ClearRoute::Service::Response::SharedPtr res); |
 
 ### ROS1
 
@@ -154,9 +159,10 @@ rclcpp::Service<包名::srv::服务类型>::SharedPtr service =
 - Python
 
 ```python
-self.srv = self.create_service(<服务类型>, <服务名>, self.callback)
+self.srv = self.create_service( < 服务类型 >, < 服务名 >, self.callback)
+
 def callback(self, request, response):
-	return response
+    return response
 ```
 
 ## Call
@@ -181,6 +187,7 @@ else {
 ```ad-attention
 `call`函数只能接受左值
 ```
+
 ### ROS2
 
 C++中`ROS1`的服务是同步的，而`ROS2`的则为异步

diff --git a/docs/TF.md → docs/Beginner/TF.md b/docs/TF.md → docs/Beginner/TF.md
diff --git a/docs/Time.md → docs/Beginner/Time.md b/docs/Time.md → docs/Beginner/Time.md
diff --git a/docs/rosbag.md → docs/Beginner/rosbag.md b/docs/rosbag.md → docs/Beginner/rosbag.md
diff --git a/docs/Assertion and Exception.md → docs/Intermediate/Assertion and Exception.md b/docs/Assertion and Exception.md → docs/Intermediate/Assertion and Exception.md
diff --git a/docs/DDS.md → docs/Intermediate/DDS.md b/docs/DDS.md → docs/Intermediate/DDS.md
@@ -66,11 +66,11 @@ $ export ROS_LOCALHOST_ONLY=1
         ROS2 下现已支持的 DDS
     </summary>
 
-|                         Product name                         |           License           | RMW implementation   |                            Status                            |
-| :----------------------------------------------------------: | :-------------------------: | -------------------- | :----------------------------------------------------------: |
-|  [eProsima Fast DDS](https://github.com/ros2/rmw_fastrtps)   |          Apache 2           | `rmw_fastrtps_cpp`   |  Full support. Default RMW. Packaged with binary releases.   |
-| [Eclipse Cyclone DDS](https://github.com/ros2/rmw_cyclonedds) | Eclipse Public License v2.0 | `rmw_cyclonedds_cpp` |         Full support. Packaged with binary releases.         |
-|  [RTI Connext DDS](https://github.com/ros2/rmw_connextdds)   |    commercial, research     | `rmw_connextdds`     | Full support. Support included in binaries, but Connext installed separately. |
+|                          Product name                           |           License           | RMW implementation   |                                         Status                                          |
+|:---------------------------------------------------------------:|:---------------------------:|----------------------|:---------------------------------------------------------------------------------------:|
+|    [eProsima Fast DDS](https://github.com/ros2/rmw_fastrtps)    |          Apache 2           | `rmw_fastrtps_cpp`   |                Full support. Default RMW. Packaged with binary releases.                |
+|  [Eclipse Cyclone DDS](https://github.com/ros2/rmw_cyclonedds)  | Eclipse Public License v2.0 | `rmw_cyclonedds_cpp` |                      Full support. Packaged with binary releases.                       |
+|    [RTI Connext DDS](https://github.com/ros2/rmw_connextdds)    |    commercial, research     | `rmw_connextdds`     |      Full support. Support included in binaries, but Connext installed separately.      |
 | [GurumNetworks Gurum DDS](https://github.com/ros2/rmw_gurumdds) |         commercial          | `rmw_gurumdds_cpp`   | Community support. Support included in binaries, but Gurum**DDS** installed separately. |
 
 </details>

diff --git a/docs/Deployment.md → docs/Intermediate/Deployment.md b/docs/Deployment.md → docs/Intermediate/Deployment.md
diff --git a/docs/Plugins.md → docs/Intermediate/Plugins.md b/docs/Plugins.md → docs/Intermediate/Plugins.md
diff --git a/docs/Code Style.md → docs/Others/Code Style.md b/docs/Code Style.md → docs/Others/Code Style.md
diff --git a/docs/README.md b/docs/README.md
@@ -8,42 +8,39 @@
 
 ### Beginner
 
-- [Build Tool](Build%20Tool.md)
-- [CMake and Package](CMake%20and%20Package.md)
-- [Exectuor and Callback](Exectuor%20and%20Callback.md)
-- [Header and Module](Header%20and%20Module.md)
-- [Install](Install.md)
-- [Interface](Interface.md)
-- [Launch](Launch.md)
-- [Logger](Logger.md)
-- [Network](Network.md)
-- [Node and Component](Node%20and%20Component.md)
-- [Paramter Server](Paramter%20Server.md)
-- [Plugins](Plugins.md)
-- [Publisher and Subscriber](Publisher%20and%20Subscriber.md)
-- [Rosbag](Rosbag.md)
-- [RosCLI](RosCLI.md)
-- [Service](Service.md)
-- [TF](TF.md)
-- [Time](Time.md)
+- [Build Tool](Beginner/Build%20Tool.md)
+- [CMake and Package](Beginner/CMake%20and%20Package.md)
+- [Exectuor and Callback](Beginner/Exectuor%20and%20Callback.md)
+- [Header and Module](Beginner/Header%20and%20Module.md)
+- [Install](Beginner/Install.md)
+- [Interface](Beginner/Interface.md)
+- [Launch](Beginner/Launch.md)
+- [Logger](Beginner/Logger.md)
+- [Network](Beginner/Network.md)
+- [Node and Component](Beginner/Node%20and%20Component.md)
+- [Paramter Server](Beginner/Paramter%20Server.md)
+- [Publisher and Subscriber](Beginner/Publisher%20and%20Subscriber.md)
+- [rosbag](Beginner/rosbag.md)
+- [Service](Beginner/Service.md)
+- [TF](Beginner/TF.md)
+- [Time](Beginner/Time.md)
 
 ### Intermediate
 
-- [DDS](DDS.md)
-- [Deployment](Deployment.md)
+- [DDS](Intermediate/DDS.md)
+- [Deployment](Intermediate/Deployment.md)
 - [Assertion and Exception](Assertion%20and%20Exception.md)
-- [Plugins](Plugins.md)
+- [Plugins](Intermediate/Plugins.md)
 
 ### Software and Tools
 
-- [Gazebo](Gazebo.md)
-- [RViz](RViz.md)
-- [Tool](Tool.md)
+- [Gazebo](Software%20and%20Tools/Gazebo.md)
+- [RViz](Software%20and%20Tools/RViz.md)
+- [Tool](Software%20and%20Tools/Tool.md)
 
-**Others**
+### Others
 
-- [Code Style](Code%20Style.md)
-- [Deployment](Deployment.md)
+- [Code Style](Others/Code%20Style.md)
 
 ## FAQ
 

diff --git a/docs/Gazebo.md → docs/Software and Tools/Gazebo.md b/docs/Gazebo.md → docs/Software and Tools/Gazebo.md
diff --git a/docs/RViz.md → docs/Software and Tools/RViz.md b/docs/RViz.md → docs/Software and Tools/RViz.md
diff --git a/docs/Tool.md → docs/Software and Tools/Tool.md b/docs/Tool.md → docs/Software and Tools/Tool.md
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -1,4 +1,5 @@
 - [Home](README.md)
 - :octocat: [GitHub](https://github.com/Natsu-Akatsuki/ros_cookbook)
 - :link: Others
-    - [AMBook](https://natsu-akatsuki.github.io/ambook/#/ '工具文档')
+    - [AMBook](https://natsu-akatsuki.github.io/ambook/#/ '工具文档')
+    - [ROS2](https://docs.ros.org/en/iron/index.html)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,32 +1,33 @@
 - [Home](/)
 
 - Beginner
-    - [Build Tool](Build%20Tool.md)
-    - [CMake and Package](CMake%20and%20Package.md)
-    - [Exectuor and Callback](Exectuor%20and%20Callback.md)
-    - [Header and Module](Header%20and%20Module.md)
-    - [Install](Install.md)
-    - [Interface](Interface.md)
-    - [Launch](Launch.md)
-    - [Logger](Logger.md)
-    - [Network](Network.md)
-    - [Node and Component](Node%20and%20Component.md)
-    - [Paramter Server](Paramter%20Server.md)
-    - [Plugins](Plugins.md)
-    - [Publisher and Subscriber](Publisher%20and%20Subscriber.md)
-    - [Rosbag](Rosbag.md)
-    - [RosCLI](RosCLI.md)
-    - [Service](Service.md)
-    - [TF](TF.md)
-    - [Time](Time.md)
+    - [Build Tool](Beginner/Build%20Tool.md)
+    - [CMake and Package](Beginner/CMake%20and%20Package.md)
+    - [Exectuor and Callback](Beginner/Exectuor%20and%20Callback.md)
+    - [Header and Module](Beginner/Header%20and%20Module.md)
+    - [Install](Beginner/Install.md)
+    - [Interface](Beginner/Interface.md)
+    - [Launch](Beginner/Launch.md)
+    - [Logger](Beginner/Logger.md)
+    - [Network](Beginner/Network.md)
+    - [Node and Component](Beginner/Node%20and%20Component.md)
+    - [Paramter Server](Beginner/Paramter%20Server.md)
+    - [Publisher and Subscriber](Beginner/Publisher%20and%20Subscriber.md)
+    - [rosbag](Beginner/rosbag.md)
+    - [Service](Beginner/Service.md)
+    - [TF](Beginner/TF.md)
+    - [Time](Beginner/Time.md)
 
 - Intermediate
-    - [DDS](DDS.md)
-    - [Deployment](Deployment.md)
     - [Assertion and Exception](Assertion%20and%20Exception.md)
-    - [Plugins](Plugins.md)
+    - [DDS](Intermediate/DDS.md)
+    - [Deployment](Intermediate/Deployment.md)
+    - [Plugins](Intermediate/Plugins.md)
 
 - Software and Tools
-    - [Gazebo](Gazebo.md)
-    - [RViz](RViz.md)
-    - [Tool](Tool.md)
+    - [Gazebo](Software%20and%20Tools/Gazebo.md)
+    - [RViz](Software%20and%20Tools/RViz.md)
+    - [Tool](Software%20and%20Tools/Tool.md)
+
+- Others
+    - [Code Style](Others/Code%20Style.md)
diff --git a/docs/index.html b/docs/index.html
@@ -76,7 +76,7 @@
             crossChapterText: true,
         },
         plugins: [
-            EditOnGithubPlugin.create("https://github.com/Natsu-Akatsuki/ros_cookbook/tree/main/docs", "", "Edit on GitHub")
+            EditOnGithubPlugin.create("https://github.com/Natsu-Akatsuki/ros_cookbook/tree/main/docs/", "", "Edit on GitHub")
         ],
     }