Compendium Editing: A How-To Guide

Editing a page in the Compendium

Editing the Main Body of the Page

  • This space includes things like the mission, procedures and services, etc. 
  • You may upload PDFs directly into the section (users will be able to click on them and read through. A small preview will be visible once you publish the page)
  • You may also insert hyperlinks
  • You should put a title in bold above each PDF  
  • You should put a space between each document so things are readable  
  • If a PDF requires an explanation, you should put a description (not bolded) beneath the title in normal 12 pt. Font 

Editing the Additional Resources Box (On the Right-Hand Side of the Page)

  •  On the right-hand side of the page (legal references, design standards, etc.) if you need a PDF, given the formatting, you will need to have the librarian upload any PDF to EOS, our catalog, and you can use the created link
  • Outside website links may be put in normally  
  • Once the librarian has created the PDF link in the catalog, you can request it be sent to you, or the librarian can put it in (you may email the librarian at kathleen.crabb@dc.gov)

Labels/Tags 

Existing Labels

  • Please put the appropriate labels (they're the same as tags, just a different name!) on each page (this makes it easier to search) 
  • Refer to the “label list" under the "About" page to find the correct terminology for each subject area
  • You may add labels to your page by clicking on the icon when you are in editing mode  (the icon is located at the top of the page next to the title. See the screenshot below!) 

Adding New Labels

  • If you do not see a label that you need (the current list is not exhaustive by any means!) please contact the librarian at kathleen.crabb@dc.gov, who will add it to the list (we want consistency, so try and refrain from using labels you do not see on the list without letting the librarian know)  

Example pages For Formatting Help

  • Pages with multiple PDFs (Trucks) 
  • Pages with a lot of text (Sidewalks)  

Miscellaneous Tips

  • Check any links to the Design and Engineering Manual (DEM), or standards and specification documents to make sure the most recent version is linked (many currently in the Compendium are older versions that have since been changed) 
  • Check all links to the DDOT website to make sure they are correct and up-to-date