From 75764f93a8a554a005e45ed88cd524aca12dc36e Mon Sep 17 00:00:00 2001 From: jpfeuffer Date: Tue, 23 Aug 2022 09:50:23 +0000 Subject: [PATCH] Show how to correctly use figures --- .gitpod.yml | 16 ++++++++++++++++ .../openms-user-tutorial.md | 12 +++++++----- 2 files changed, 23 insertions(+), 5 deletions(-) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..81401308 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,16 @@ +# This configuration file was automatically generated by Gitpod. +# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file) +# and commit this file to your remote git repository to share the goodness with others. + +tasks: + - name: Install dependencies + init: pip3 install -r requirements.txt + command: make html + - name: Start web server + init: python -m http.server 8000 + +ports: + - port: 8000 + onOpen: open-preview + + diff --git a/docs/tutorials-and-quickstart-guides/openms-user-tutorial.md b/docs/tutorials-and-quickstart-guides/openms-user-tutorial.md index 6d634d4b..1c53c341 100644 --- a/docs/tutorials-and-quickstart-guides/openms-user-tutorial.md +++ b/docs/tutorials-and-quickstart-guides/openms-user-tutorial.md @@ -81,10 +81,12 @@ usually the most convenient option. To convert raw data to mzML using `ProteoWizard` you can either use MSConvertGUI (a graphical user interface) or `msconvert` (a simple command line tool). -(Figure_1)= -|![msconvertgui](../images/openms-user-tutorial/introduction/proteowizard.png)| -|:--:| -|Figure 1: `MSConvertGUI` (part of `ProteoWizard`), allows converting raw files to mzML. Select the raw files you want to convert by clicking on the browse button and then on Add. Default parameters can usually be kept as-is. To reduce the initial data size, make sure that the `peakPicking` filter (converts profile data to centroided data (see Fig. 2)) is listed, enabled (true) and applied to all MS levels (parameter ”1-”). Start the conversion process by clicking on the Start button.| + +```{figure} ../images/openms-user-tutorial/introduction/proteowizard.png +:name: pwiz + +`MSConvertGUI` (part of `ProteoWizard`), allows converting raw files to mzML. Select the raw files you want to convert by clicking on the browse button and then on Add. Default parameters can usually be kept as-is. To reduce the initial data size, make sure that the `peakPicking` filter (converts profile data to centroided data (see Fig. 2)) is listed, enabled (true) and applied to all MS levels (parameter ”1-”). Start the conversion process by clicking on the Start button. +``` Both tools are available in: {{ '{path}'+'`C:,Program Files,OpenMS-{0},share,OpenMS,THIRDPARTY,pwiz-bin`'.format(version) }}. @@ -92,7 +94,7 @@ You can find a small RAW file on the USB stick {path}`C:,Example_Data,Introducti #### MSConvertGUI -`MSConvertGUI` (see Fig. 1) exposes the main parameters for data conversion in a convenient graphical user interface. +`MSConvertGUI` (see {numref}`pwiz`) exposes the main parameters for data conversion in a convenient graphical user interface. #### msconvert