How to Add an Example Flowgraph to a Block Doc

Why?

Part of the value of our Block Doc pages is having an Example Flowgraph to show how that block can be used. In a recent review of our 555 current blocks, 214 of them do not have an Example Flowgraph!

To which pages?

Look at Pages with no Example Flowgraph and Documentation Stubs for the lists of pages in need of Example Flowgraphs.

This document describes the process to add an Example Flowgraph to an existing Block Doc; you'll find all of them in the Category Block Docs.

How?

Sign in or work as guest

If you have a Wiki account, sign in, but if you don't, you still can edit the Wiki. Your changes will be placed in a queue to be reviewed before acceptance.

Step-by-Step

The following steps use Complex_To_Float as a specific example.

1. Find or create a flowgraph containing the subject block.
2. Load and execute the flowgraph to test that it works!
3. In GRC, select File -> Screen Capture
4. Change the filename to "<your file>_fg.png" (e.g. SSB_rcv_weaver_fg.png)
5. Change the folder to '~/Pictures/Screenshots'
6. Save
7. Go to https://wiki.gnuradio.org/index.php?title=Special:Upload, Choose File, and open it.
8. Save the file name and pixel dimensions in your notes.
   e.g. File:SSB_rcv_weaver_fg.png 1,552 × 623 pixels
9. Open the subject block doc and select the 'Edit' tab next to the 'Read' tab.
10. Below the == Example Flowgraph == line, if there is any placeholder text, delete it and enter the flowgraph file information in the following format: [[File:SSB_rcv_weaver_fg.png|800px]]
    where File:SSB_rcv_weaver_fg.png is your screenshot, and the 800px is the width to display.
    Note: if the original pixel width dimension is less than 800, use that value instead of the 800 in the example.
11. Find the line which contains [[Category:Pages with no Example Flowgraph]] and delete it.
12. In the Summary entry box, enter "add Example Flowgraph"
13. Click "Show preview" to examine what you have done.
14. In addition to checking the Example Flowgraph, scroll to the bottem of the page and check that the only Category shown is "Block Docs".
15. Make any corrections needed and then click "Save page".