Daniel Kuo
8/11/11
How to upload and format board files for the MAVRK wiki
The instructions below detail how to upload and format board files for the MAVRK wiki.
Before you start
1. You will need an account on the MAVRK wiki. Visit the MAVRK homepage and click on “create
account” in the top right corner. Follow the instructions on the website to create an account. If
you already have an account, make sure to login.
http://processors.wiki.ti.com/index.php/MAVRK_Introduction
2. In order to format the files for the wiki, you will need a number of programs. You may
substitute similar programs of your liking if they have the necessary functionality.
a. “CutePDF Writer” for printing excel spreadsheets to a PDF file: http://www.cutepdf.com
b. “PDFX” for generating thumbnails of PDFs: http://www.portablefreeware.com/?id=1436
c. “IrfranView” for cropping and saving images: http://www.irfanview.com
d. “Perforce” for accessing the MAVRK database.
e. “Microsoft Excel” for opening Excel files.
3. Once you have the necessary programs installed, determine if you are uploading files for a
MAVRK module or MAVRK template (Templates are typically called XXX-TEMPLATE-MVK). If you
are working on a template, begin reading the section “Upload files for MAVRK Templates”.
Otherwise, skip to the section titled “Upload files for MAVRK Modules” on page 18. The
Daniel Kuo
8/11/11
procedure for templates and modules are very similar, but contain some slight formatting
differences.
Upload files for MAVRK Templates
1. To begin, you will need to obtain 5 files to upload to the wiki
a. Bill of Materials excel file
b. Schematic PDF
c. Board Layout and Dimensions PDF
d. Gerber files ZIP
e. Schematic and board files ZIP
Usually these files can be found in Perforce under the respective template directory. Make sure
you have the files for the latest revision.
For this guide, we will use files from the AFE-TEMPLATE-MVK as an example. However, the basic
procedure is applicable to any of the other MAVRK templates.
2. In Perforce, navigate to the directory for your template. In this example it will be:
MAVRK/Hardware/MAVRK/TEMPLATES/AFE-TEMPLATE-MVK/Rev 1.7/
Daniel Kuo
8/11/11
3. Under this directory, you will typically find a file named <XXX>-TEMPLATE-MVK_<XpX>.zip (In
this example, it is called AFE-TEMPLATE-MVK_1p7 for revision 1.7 of the AFE template). Open it
with a file decompression utility.
4. Inside you should be able to find the 5 files needed for the wiki. (If you are not editing the AFE
template, then the filenames will not be identical):
a. AFE-TEMPLATE-MVK_BOM_1p7.xls (Bill of materials spreadsheet)
b. AFE-TEMPLATE-MVK_SCH_1p7.pdf (Schematic PDF)
c. AFE-TEMPLATE-MECH_1p7.pdf (Board dimensions and layout PDF, alternatively titled
“AFE-TEMPLATE-MVK_TOP&BOT_1p7.zip”)
d. AFE-TEMPLATE-MVK_ART_1p7.zip (Gerber files ZIP, alternatively titled “AFE-TEMPLATEMVK_GERBER_1p7.zip”)
e. AFE-TEMPLATE-MVK_DB_1p7.zip (Schematic and board files ZIP)
Copy these files to your Desktop.
If you cannot find one of the needed files, check around the template directory. Sometimes
the needed files can be found there. If you still cannot find a file, it will need to be
generated from the board schematic and layout files. Ask for assistance if you don’t know
how.
Daniel Kuo
8/11/11
5. Once you have all the files on your Desktop, open the bill of materials with Excel. Hit “Crtl+P” to
print. Make sure “CutePDF Writer” is selected as the printer. Click “OK” and CutePDF Writer
should prompt you where to save the PDF. Save the PDF to your Desktop. You can delete the
bill of materials excel file once you have generated the bill of materials PDF.
6. Now we will need to generate image thumbnails for the 3 PDF files (again, the filenames may
vary depending on the template you are updating).
a. AFE-TEMPLATE-MVK_BOM_1p7.pdf
b. AFE-TEMPLATE-MVK_SCH_1p7.pdf
c. AFE-TEMPLATE-MECH_1p7.pdf
7. Open PDFXCview and drag-and-drop the three PDF files into the program window.
Daniel Kuo
8/11/11
8. Click on File->Export to Image.
Daniel Kuo
8/11/11
9. In the “Export to Image” window, set the “Destination Folder:” to your Desktop. Set the Image
Type to “PNG – Portable Network Graphic”. For “Resolution”, typically 300dpi will suffice.
However, if the output image resolution is larger than 3301x2551, you will want to reduce the
quality to 150dpi (Images that are too large will not be properly displayed on the Wiki page).
10. Repeat steps 8 and 9 to export images for the three files you have open.
Daniel Kuo
8/11/11
11. Now you should have three images of the PDFs. Open IrfanView and load the image of the
schematic. Click on “Edit->Auto crop borders” to eliminate excess whitespace around the
schematic. Save the image as a PNG to your Desktop.
Daniel Kuo
8/11/11
12. With IrfanView still open load the MECH PNG file (AFE-TEMPLATE-MECH_1p7.png in this
example). If there is excess whitespace around the drawing, click and drag a box around the
area you want to crop. Then click “Edit->Crop Selection”. Save the image as a PNG to your
Desktop.
13. Close IrfanView, we have completed the needed image post processing. Navigate to your
Desktop and rename the three image files. Append the word “Thumb” onto the end of the
filename so they look similar to the three filenames listed below.
a. AFE-TEMPLATE-MVK_BOM_1p7_Thumb.png
b. AFE-TEMPLATE-MVK_SCH_1p7_Thumb.png
c. AFE-TEMPLATE-MECH_1p7_Thumb.png
Daniel Kuo
8/11/11
14. Now we are ready to upload the files to the wiki. You should now have 8 files ready for upload.
a. AFE-TEMPLATE-MVK_BOM_1p7.pdf
(Bill of materials PDF)
b. AFE-TEMPLATE-MVK_SCH_1p7.pdf
(Schematic PDF)
c. AFE-TEMPLATE-MECH_1p7.pdf
(Board dimensions and layout PDF)
d. AFE-TEMPLATE-MVK_ART_1p7.zip
(Gerber files ZIP)
e. AFE-TEMPLATE-MVK_DB_1p7.zip
(Schematic and board files ZIP)
f. AFE-TEMPLATE-MVK_BOM_1p7_Thumb.png (Bill of materials thumbnail)
g. AFE-TEMPLATE-MVK_SCH_1p7_Thumb.png
(Schematic thumbnail)
h. AFE-TEMPLATE-MECH_1p7_Thumb.png
(Board dimensions/ layout thumbnail)
15. Open the wiki website in your web browser:
http://processors.wiki.ti.com/index.php/Main_Page.
Daniel Kuo
8/11/11
16. On the left toolbar of the Wiki page, click on “Upload file”.
Daniel Kuo
8/11/11
17. We will now need to individually upload each one of the 8 files. Click on “Choose file” and select
the first file “AFE-TEMPLATE-MVK_BOM_1p7.pdf”. Usually, it’s good practice to provide a short
description of the file uploaded. Typically, the description is formatted as follows: “MAVRK
<template name> <file contents> <file type>”. For example “MAVRK AFE-TEMPLATE-MVK bill of
materials PDF". Or “MAVRK AFE-TEMPLATE-MVK schematic thumbnail”. When you are done
typing the description, click the “Upload file” button.
Daniel Kuo
8/11/11
18. Repeat steps 16 and 17 until you have uploaded all the files. You can verify that they were all
uploaded by visiting the “list of uploaded files” page on the wiki. To get to this page, return to
the “Upload file” page. Near the top of the screen, follow the link to “list of uploaded files”.
19. Once you are at the file list page, you can see the list of files you most recently uploaded, along
with any other files that may have been uploaded to the wiki recently. Keep this page open,
since we will need to copy links from it later.
20. In another window, open the wiki page “Hardware Design Guide for MAVRK AFE Modules” and
navigate to the “Template Files” section.
http://processors.wiki.ti.com/index.php/Hardware_Design_Guide_for_MAVRK_AFE_Modules#T
emplate_Files
This will be the format we base other MAVRK templates off of.
Daniel Kuo
8/11/11
21. Click “Edit” in the “Template Files” section. If you don’t see the “Edit” button, you need to login
to the Wiki first.
Daniel Kuo
8/11/11
22. In the “edit” page, copy everything from the text editor box.
23. Now navigate to the wiki template that you will be editing. Scroll down to the “Template Files”
section and click “edit”. If the template files section does not exist, you will need to edit the
article and copy it into an appropriate location within the article.
24. Once you have the editor open for the template files section, paste everything into the text
editor. Overwrite any previous formatting that may have been present.
Daniel Kuo
8/11/11
25. Now we have the basic wiki format copied into the editor. We will need to replace the links so
that they point to the newly uploaded files. There are a total of 11 links you will need to replace:
a. 2 links to the bill of materials PDF
b. 2 links to the schematic PDF
c. 2 links to the board layout and dimensions PDF
d. 1 link to the Gerber files ZIP
e. 1 link to the schematic and board files ZIP
f. 1 link to the bill of materials thumbnail PNG
g. 1 link to the schematic thumbnail PNG
h. 1 link to the board layout and dimensions PNG
Navigate to the “list of uploaded files” page, as described in steps 18 and 19. Find the bill of
materials PDF you recently uploaded, and next to the filename there should be a “(file)” link to
the actual file download. Right click on the “(file)” link and copy the address to the link.
Daniel Kuo
8/11/11
26. Now that you have the link copied, go back to the wiki editor page. Find the two links to the bill
of materials PDF and replace them with the copied link. The image below shows the locations of
the 11 links that need to be replaced.
27. Repeat steps 25-26 for these 5 files:
a. Bill of materials PDF (Completed in previous step)
b. Schematic PDF
c. Board dimensions and layout PDF
d. Geber files ZIP
e. Schematic and board files ZIP.
28. For the three images, instead of copying the “(file)” link. Copy the filename instead. Replace
the three image links to update the thumbnails.
Daniel Kuo
8/11/11
29. Now go through the editor, and replace any instances of “AFE” in the text with the name of the
template you are editing. Using the find feature in your web browser can help you quickly find
where the text needs to be replaced.
30. Finally, click on “Show preview” to check your work.
31. When you are done with the edit, click on “Save page”. After submitting, it is good practice to
double check the template files section and makes sure all the links work. Click on all the
download links and images, and verify that the links take you to the intended file.
Daniel Kuo
8/11/11
Upload files for MAVRK Modules
1. To begin, you will need to obtain 4 files to upload to the wiki
a. Bill of Materials excel file
b. Schematic PDF
c. Board Layers PDF
d. Fabrication Drawings PDF
Usually these files can be found in Perforce under the respective module directory. Make sure
you have the files for the latest revision.
For this guide, we will use files from the AFE-BREAKOUT-MVK as an example. However, the
basic procedure is applicable to any of the other MAVRK modules.
2. In Perforce, navigate to the directory for your module. In this example it will be:
MAVRK/Hardware/MAVRK/AFE-MODULE/6517734_AFE-BREAKOUT-MVK/Rev D Data/
Daniel Kuo
8/11/11
3. Under this directory, you will typically find a ZIP file named <edge number>_<module type><module name>-MVK_<revision> (In this example, it is called 6517734_AFE-BREAKOUTMVK_D.zip). Open it with a file decompression utility.
4. Inside you should be able to find the 4 files needed for the wiki. (If you are not editing the AFEBREAKOUT-MVK, then the filenames will not be identical):
a. AFE-BREAKOUT-MVK_BOM_D.xls (Bill of materials spreadsheet)
b. AFE-BREAKOUT-MVK_SCH_D.pdf (Schematic PDF)
c. AFE-BREAKOUT-MVK_WIKI_D.pdf (Board layers PDF)
d. AFE-BREAKOUT-MVK_FAB_D.pdf (Fabrication Drawing PDF)
Copy these files to your Desktop.
If you cannot find one of the needed files, check around the module directory. Sometimes
the needed files can be found there. If you still cannot find a file, it will need to be
generated from the board schematic and layout files. Ask for assistance if you don’t know
how.
Daniel Kuo
8/11/11
5. Once you have all the files on your Desktop, open the bill of materials with Excel. Hit “Crtl+P” to
print. Make sure “CutePDF Writer” is selected as the printer. Click “OK” and CutePDF Writer
should prompt you where to save the PDF. Save the PDF to your Desktop. You can delete the
bill of materials excel file once you have generated the bill of materials PDF.
6. Now we will need to generate image thumbnails for the 4 PDF files (again, the filenames may
vary depending on the module you are updating).
a. AFE-BREAKOUT-MVK_BOM_D.pdf
b. AFE-BREAKOUT-MVK_SCH_D.pdf
c. AFE-BREAKOUT-MVK_WIKI_D.pdf
d. AFE-BREAKOUT-MVK_FAB_D.pdf
7. Open PDFXCview and drag-and-drop the four PDF files into the program window.
Daniel Kuo
8/11/11
8. Click on File->Export to Image.
Daniel Kuo
8/11/11
9. In the “Export to Image” window, set the “Destination Folder:” to your Desktop. Set the Image
Type to “PNG – Portable Network Graphic”. For “Resolution”, typically 300dpi will suffice.
However, if the output image resolution is larger than 3301x2551, you will want to reduce the
quality to 150dpi (Images that are too large will not be properly displayed on the Wiki page).
10. Repeat steps 8 and 9 to export images for the four files you have open.
Daniel Kuo
8/11/11
11. Now you should have four images of the PDFs. Open IrfanView and load the image of the board
layers. You will want to crop the image so only the board itself is showing (eliminate the title
block and orientation markers). To do so, click and drag to select a box around the board. Click
on “Edit->Crop selection” to eliminate excess whitespace around the board. Save the image as a
PNG to your Desktop.
Alternatively, you can use the “Auto crop borders” feature in IrfanView to create a cleaner
outline. First perform a rough crop around the board so that only whitespace surrounds the
board. Then use the “Edit->Auto crop borders” function to remove any remaining whitespace.
Save the image as a PNG on your Desktop
Daniel Kuo
8/11/11
12. With IrfanView still open load the schematic PNG file (AFE-BREAKOUT-MVK_SCH_D.pdf in this
example). Click on “Edit->Auto crop borders” to eliminate excess whitespace around the
schematic. Save the image as a PNG to your Desktop.
13. Repeat step 12 to generate a image for the fabrication drawing PDF.
14. Close IrfanView, we have completed the needed image post processing. Navigate to your
Desktop and rename the four image files. Append the word “Thumb” onto the end of the
filename so they look similar to the four filenames listed below.
a. AFE-BREAKOUT-MVK_BOM_D_Thumb.png
b. AFE-BREAKOUT-MVK_SCH_D_Thumb.png
c. AFE-BREAKOUT-MVK_WIKI_D_Thumb.png
d. AFE-BREAKOUT-MVK_FAB_D_Thumb.png
Daniel Kuo
8/11/11
15. Now we are ready to upload the files to the wiki. You should now have 8 files ready for upload.
a. AFE-BREAKOUT-MVK_BOM_D.pdf
(Bill of materials PDF)
b. AFE-BREAKOUT-MVK_SCH_D.pdf
(Schematic PDF)
c. AFE-BREAKOUT-MVK_WIKI_D.pdf
(Board layers PDF)
d. AFE-BREAKOUT-MVK_FAB_D.pdf
(Fabrication drawing PDF)
e. AFE-BREAKOUT-MVK_BOM_D_Thumb.png
(Bill of materials thumbnail)
f. AFE-BREAKOUT-MVK_SCH_D_Thumb.png
(Schematic thumbnail)
g. AFE-BREAKOUT-MVK_WIKI_D_Thumb.png
(Board layers thumbnail)
h. AFE-BREAKOUT-MVK_FAB_D_Thumb.png
(Fabrication drawing thumbnail)
16. Open the wiki website in your web browser:
http://processors.wiki.ti.com/index.php/Main_Page.
Daniel Kuo
8/11/11
17. On the left toolbar of the Wiki page, click on “Upload file”.
Daniel Kuo
8/11/11
18. We will now need to individually upload each one of the 8 files. Click on “Choose file” and select
the first file “AFE-BREAKOUT-MVK_BOM_D.pdf”. Usually, it’s good practice to provide a short
description of the file uploaded. Typically, the description is formatted as follows: “MAVRK
<module name> <file contents> <file type>”. For example “MAVRK AFE-BREAKOUT-MVK bill of
materials PDF". Or “MAVRK AFE-BREAKOUT-MVK schematic thumbnail”. When you are done
typing the description, click the “Upload file” button.
Daniel Kuo
8/11/11
19. Repeat steps 17 and 18 until you have uploaded all the files. You can verify that they were all
uploaded by visiting the “list of uploaded files” page on the wiki. To get to this page, return to
the “Upload file” page. Near the top of the screen, follow the link to “list of uploaded files”.
20. Once you are at the file list page, you can see the list of files you most recently uploaded, along
with any other files that may have been uploaded to the wiki recently. Keep this page open,
since we will need to copy links from it later.
21. In another window, open the wiki page “MB PRO MAVRK Module” and navigate to the “Board
Files” section.
http://processors.wiki.ti.com/index.php/MB-PRO-MVK_MAVRK_Module#Board_Files
This will be the format we base other MAVRK Modules off of.
Daniel Kuo
8/11/11
22. Click “Edit” in the “Board Files” section. If you don’t see the “Edit” button, you need to login to
the Wiki first.
Daniel Kuo
8/11/11
23. In the “edit” page, copy everything from the text editor box.
24. Now navigate to the wiki module that you will be editing. Scroll down to the “Board Files”
section and click “edit”. If the board files section does not exist, you will need to edit the article
and copy it into an appropriate location within the article.
25. Once you have the editor open for the board files section, paste everything into the text editor.
Overwrite any previous formatting that may have been present.
Daniel Kuo
8/11/11
26. Now we have the basic wiki format copied into the editor. We will need to replace the links so
that they point to the newly uploaded files. There are a total of 12 links you will need to replace:
a. 2 links to the bill of materials PDF
b. 2 links to the board layers PDF
c. 2 links to the schematic PDF
d. 2 links to the fabrication drawing
e. 1 link to the bill of materials thumbnail
f. 1 link to the board layers thumbnail
g. 1 link to the schematic thumbnail
h. 1 link to the fabrication drawing thumbnail
Navigate to the “list of uploaded files” page, as described in steps 19 and 20. Find the bill of
materials PDF you recently uploaded, and next to the filename there should be a “(file)” link to
the actual file download. Right click on the “(file)” link and copy the address to the link.
Daniel Kuo
8/11/11
27. Now that you have the link copied, go back to the wiki editor page. Find the two links to the bill
of materials PDF and replace them with the copied link. The image below shows the locations of
the 12 links that need to be replaced.
28. Repeat steps 26-27 for these 4 files:
a. Bill of materials PDF (Completed in previous step)
b. Board layers PDF
c. Schematic PDF
d. Fabrication Drawing PDF
29. For the four images, instead of copying the “(file)” link. Copy the filename instead. Replace the
four image links to update the thumbnails.
Daniel Kuo
8/11/11
30. Now go through the editor, and replace any instances of “MB-PRO-MVK” in the text with the
name of the module you are editing. Using the find feature in your web browser can help you
quickly find where the text needs to be replaced.
31. Finally, click on “Show preview” to check your work.
32. When you are done with the edit, click on “Save page”. After submitting, it is good practice to
double check the board files section and makes sure all the links work. Click on all the download
links and images, and verify that the links take you to the intended file.