hongshaorou/openrocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some bugs in the documentation

Browse Source
This commit is contained in:
SiboVG 2024-10-08 23:42:17 +02:00
parent 2cb8297326
commit c7540868a3
4 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/user_guide/advanced_flight_simulation.rst
View File

@ -17,10 +17,10 @@ can export your data for analysis and charting in other packages.
Plotting your rocket's flight
=============================
To begin learning about OpenRocket's plotting features, first, click the **Plot / Export** button on the **Flight simulations** window.
To begin learning about OpenRocket's plotting features, first, click the :guilabel:`Plot / Export` button on the :guilabel:`Flight simulations` window.
.. figure:: /img/user_guide/advanced_flight_simulation/PlotExportButton.png
:width: 800 px
:width: 400 px
:align: center
:figclass: or-image-border
:alt: The Plot / export Button.
@ -30,7 +30,7 @@ On the **Edit simulation** panel, you'll see tabs marked **Plot data** and **Exp
Plotting data
-------------
The **Plot data** tab opens first. Here you can define many parameters that will determine what values are plotted, and
The :guilabel:`Plot data` tab opens first. Here you can define many parameters that will determine what values are plotted, and
what events are marked on the plot.
.. figure:: /img/user_guide/advanced_flight_simulation/PlotExportWindow.png
@ -137,8 +137,8 @@ margin for error.
Launch Conditions and Simulation Options
========================================
From the **Plot data** window, you can click the **<< Edit** button to configure **Launch conditions**, and
**Simulation options** before you plot.
From the :guilabel:`Plot data` window, you can click the :guilabel:`<< Edit:guilabel:` button to configure :guilabel:`Launch conditions`, and
:guilabel:`Simulation options` before you plot.
Launch conditions
-----------------
@ -162,7 +162,7 @@ simulation *passes or fails*, when it's evaluated for minimum speed off the rod.
Simulation options
------------------
In the **Simulation options** tab, the **Simulator options** let you choose the shape of the simulated Earth in your
In the :guilabel:`Simulation options` tab, the :guilabel:`Simulator options` let you choose the shape of the simulated Earth in your
calculations (*doing so* **does not** *affect the Earth background in Photo Studio*), and you can choose the time-resolution
of the simulation. This is also the place where you add and set up **Simulation extensions**, which are beyond this
guide's purpose.
@ -180,7 +180,7 @@ guide's purpose.
Exporting Data
==============
Located on the **Plot / export panel**, the **Export Data tab** (shown below) helps you set up a Comma-Separated Value (.csv)
Located on the :guilabel:`Plot / export panel`, the :guilabel:`Export Data tab` (shown below) helps you set up a Comma-Separated Value (.csv)
formatted file to export data from your simulations. You can export any or all of over 50 values (generally speaking,
the list of parameters above, plus **Coriolis acceleration**). Optional **Comments** sections list any flight events
(**Apogee**, for example) you selected for your simulation, as well as description and field descriptions.

14
docs/source/user_guide/advanced_rocket_design.rst
View File

@ -425,7 +425,7 @@ Complex rockets fall into two basic categories, a rocket that is propelled by a
simultaneously ignited or multi-staged (massively-staged), propelled by a series of motors that successively ignite the
next in line when the prior motor burns out.
.. figure:: /img/user_guide/advanced_rocket_design/xkcd_whatif_24_model_suborbital.png
.. figure:: /img/user_guide/advanced_rocket_design/Xkcd_whatif_24_model_suborbital.png
:width: 392 px
:align: center
:figclass: or-image-border
@ -456,23 +456,23 @@ Designing a Rocket with Clustered Motors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
OpenRocket makes it easy to design motor clusters. To begin with, add an **Inner Tube** to your aft-most **Body Tube**.
On the **Motor** tab, check the "This component is a motor mount" box. Set its inner diameter to one of the standard
motor sizes, unless you have a unique need: 13, 18, 24, 29, 38, 54, 75 or 98mm. Next, click on the **Cluster** tab.
On the :guilabel:`Motor` tab, check the "This component is a motor mount" box. Set its inner diameter to one of the standard
motor sizes, unless you have a unique need: 13, 18, 24, 29, 38, 54, 75 or 98mm. Next, click on the :guilabel:`Cluster` tab.
.. figure:: /img/user_guide/advanced_rocket_design/ClusterTab.png
:width: 800 px
:align: center
:figclass: or-image-border
:alt: OpenRocket's **Cluster** tab
:alt: OpenRocket's Cluster tab
The **Cluster** tab lets you choose a common cluster configuration, and adjust it in your model. When you make an
The :guilabel:`Cluster` tab lets you choose a common cluster configuration, and adjust it in your model. When you make an
**Inner Tube** a cluster, you treat every tube in the cluster identically with each addition. If you add an
**Engine block** or a **Mass component**, all of the tubes in the cluster will receive one.
First, pick a cluster configuration from the image tiles on the left side of the tab. Realize that depending upon the
sizes of your motor tube and body tube, not every cluster that you can make will fit.
Next, adjust the **Tube separation**. This value controls how close the clustered motors are to each other. A value of
Next, adjust the :guilabel:`Tube separation`. This value controls how close the clustered motors are to each other. A value of
1 places the tubes in contact with each other. You can enter decimals like "1.25" in the separation field. In addition
to potentially affecting your rocket's stability, the **Tube separation** you choose may influence the difficulty of
wiring your clustered motors for ignition, and your ability to place adhesive and parts around tightly-packed tubes
@ -484,7 +484,7 @@ during construction.
:figclass: or-image-border
:alt: Clustered motor mounts, viewed from aft.
The **Rotation** setting rotates your cluster around the major axis of your rocket (the Up <--> Down one). It's used to
The :guilabel:`Rotation` setting rotates your cluster around the major axis of your rocket (the Up <--> Down one). It's used to
line up the motors with other decorative and structural components of your rocket. This alignment may be critical if
you're creating a design that ducts eject gasses from one part of the rocket to another.

2
docs/source/user_guide/basic_rocket_design.rst
View File

@ -300,7 +300,7 @@ You have now had a brief run through the various components available for use in
In this section we will look at the components used in the *A simple model rocket* example design. To get started, start
OpenRocket and navigate to the main window. As a reminder it looks like this:
.. figure:: /img/user_guide/basic_rocket_design/Main_window.png
.. figure:: /img/user_guide/basic_rocket_design/main_window.png
:width: 95%
:align: center
:figclass: or-image-border

4
docs/source/user_guide/custom_expressions.rst
View File

@ -19,7 +19,7 @@ Overview
Custom expressions are added to your rocket document from the 'Analyze' menu under custom expressions. This will open a
window showing all your custom expressions.
.. figure:: /img/user_guide/custom_expressions/custom_expressions.png
.. figure:: /img/user_guide/custom_expressions/Custom_expressions.png
:align: center
:width: 55%
:figclass: or-image-border
@ -35,7 +35,7 @@ lower right. This opens the expression builder window. You can also import expre
Building expressions
====================
.. figure:: /img/user_guide/custom_expressions/expression_builder.png
.. figure:: /img/user_guide/custom_expressions/Expression_builder.png
:align: center
:width: 45%
:figclass: or-image-border