Changed trials-in-common page to use a single database query to get analyses. Changed...
[sgn.git] / docs / r_markdown_docs / using_label_designer.Rmd
blob940331d35d98acf5c0331f577e190ef894146437
1 # Using the Label Designer
3 Breedbase provides an interactive design tool for creating custom labels. To access the Label Desginer, click on “Label Designer” in the “Manage” menu. The following sections explain your many options as you advance through each step of the design workflow.
5 ### First Select a Datasource
7 The first step is to select a data source. Since the label designer can generate labels for different data types, you can optionally filter the source selection by the data type you're interested in.  Then, select a field, genotyping, or crossing trial to populate your labels with the trial design information. Or select a list to populate your label with the list contents.
8 For data sources with multiple levels of information you will also be asked to pick a level (plot, plant, etc.) before proceeding. To generate plot-level labels for more than one trial at once, select a list of trials as the source and plot as the level.
10 ```{r echo=FALSE, out.width='95%', fig.align='center'}
11 if (knitr:::is_latex_output()) {
12   knitr::include_graphics('assets/gifs/gif1.png')
13 } else {
14   knitr::include_graphics('assets/gifs/gif1.gif')
16 ```
19 ### Set Page and Label Size
21 Now choose whether to create a new design or load a saved design. If you choose new, you will be prompted to select a page size and label size.
22 If you do not see your page or label size as an option, then select Custom and enter your desired dimensions in pixels, or 1/72nds of an inch.
23 If you choose saved, you will be prompted to select a saved design then will be taken directly to the design step with the saved design elements preloaded.
26 ```{r echo=FALSE, out.width='95%', fig.align='center'}
27 if (knitr:::is_latex_output()) {
28   knitr::include_graphics('assets/gifs/gif2.png')
29 } else {
30   knitr::include_graphics('assets/gifs/gif2.gif')
32 ```
35 ### Design Your Label
37 Below is a draw area where you can begin adding elements to your label. First select a type, then field, size, and font, then click 'Add'
38 You can add text to an exisiting field or create a completely custom field by clicking 'Create Custom Field'
39 Once added, you can drag and drop elements, or delete them by clicking on the red box in their upper left corners.
40 Barcodes can also be resized by dragging on the green box in their lower right corners.
41 If you are creating labels for a trial it is highly recommended to include a barcode encoding your plot, plant, or tissue sample names.
42 These are your unique identifiers that will need to included with any phenotypic or genotypic measurements loaded into the database.
43 When you are satisfied with your design, click next!
45 ```{r echo=FALSE, out.width='95%', fig.align='center'}
46 if (knitr:::is_latex_output()) {
47   knitr::include_graphics('assets/gifs/gif3.png')
48 } else {
49   knitr::include_graphics('assets/gifs/gif3.gif')
51 ```
53 ### Adjust Formatting, Save, and Download
55 Last step! Here you can tweak your formatting and page layout, save your design, or download your labels.
56 The additional settings dialog will allow you to fine tune the print margins and margins between labels. The units are pixels or 1/72nds of an inch. It's not recommended to change these until you've already done a test print.
57 You can also set the # of copies per label, filter by rep, or download just the first page for test purposes.
58 To save you're design just type a unique name and hit save. This will save your design to your list manager where you can set it to public to share it with others.
59 Finally if you are ready just hit download to generate and download your labels!
60 ```{r echo=FALSE, out.width='95%', fig.align='center'}
61 if (knitr:::is_latex_output()) {
62   knitr::include_graphics('assets/gifs/gif4.png')
63 } else {
64   knitr::include_graphics('assets/gifs/gif4.gif')
66 ```