MexConnect

Styleguide

Writing for Mexconnect

Articles written for publication on Mexconnect (impart wisdom here...)

  • Translation

    Some notes on translation go here...
    Some notes on readership with regards English and Spanish go here...
    Some notes on using Spanish words and terms...

  • Subject Matter

    Some notes on subject matter go here...

  • Using Regions

    Some notes on regions go here... how they are used for navigation, how they are nested, when they are not, when to use two, when to use one.

  • Using Tags

    Some notes on using tags go here... how they are used for navigation, examples of meaningful tags, when and why not to create a tag, about the existing list, why it is kind of fixed, why is is kind of not.

  • Columns

    Some notes on columns go here... how to stick within a theme, how to stay away from other themes, etc.

  • Recipes & Ingredients

    Some notes on Recipes go here... what separates them from articles, formatting options, how to display ingredients, directions. All about ingredients, how to choose from the fixed list. How navigation works to find a recipe. How plain text search works to find a recipe. All about inline photos within a recipe type. All about galleries for recipe types.

  • Book Reviews

    Some notes on how to correctly write a book review here. Link to citation and quote formatting. What separates them from articles, formatting options, and how book review circulate within the current navigation.

Images — inline

General information about how images work within articles. What is the default display (float:left?) and how to take that into consideration when placing them within an article. How do captions work? When to just create a gallery and associate this gallery instead of using inline images.

  • Image size

    • Horizontally focused images (preferred) should be between 220px x 280px – 150px x 180px
    • Vertically focused images should be between 150px x 180px – 220px x 280px
    • Square images should ideally be between 170px – 200px
  • Image format

    • GIF (typical usage), and JPEG (typical usage) are acceptable image formats.
    • If using GIF format, please choose the Perceptual, Selective, or Adaptive color spaces, No Dither, and No Transparency; matte against #FFFFFF (white).
    • High-resolution images are acceptable; we will compress them when appropriate.
  • Alt-attribute text

    • Accompany each image with alt-attribute text that concisely describes the image for those who cannot see it.
    • Alt-attribute text uses sentence-casing.

Images — gallery

General information about how galleries are created and associated... process for sizing and submission. How these differ from inline images. How to submit galleries for publication. About writing good captions and titles and how to choose an image to be the "Display" photo. About tagging photos... please refer to About tags. About rotation, display, and navigating to new and old galleries.

  • Gallery image size

    • 850px or less in width
    • 550px or less in height
    • Should not contain borders of any kind
    • Should not contain text within the image itself
  • Gallery titles

    • Are required
    • Resemble article titles
    • Do not take terminal punctuation end of the title (e.g. periods, exclamation marks, etc.)
    • Are less than 10 words
    • Should not contain any html/links
  • Gallery image captions

    • Are required on all photos within each gallery
    • May take terminal punctuation (e.g. periods, exclamation marks, etc.)
    • Are 15 words or less
    • May contain links (please follow the same link format found: here)

Author biographical info

General info about what you expect from a author bio and photo. Consistency is important here... Let them know when, where and why author credit is given and how the contact an author function works. What is the difference betwen

  • Author bio

    • Should be between x and y many words in length
    • Should not mention the name of the author in the body text
    • May contain links when referring to x
    • May not contain links when referring to x
    • See the Image guidelines for placing and sizing images
  • Author photo

    • Should be x by y pixels exactly
    • Should not contain a border
    • Should not contain any text within the image
    • May contain a caption under 10 words

Article style

General notes about articles, grammar styles, which style manual or dictionary we refer to...

  • Titles, headlines, and subheads

    • Article titles use "Title case". Each major word is uppercase. Uses the ampersand in place of "and." Does not take terminal punctuation unless a question mark is required.
      Mexico is Vast & Diverse
    • All other headings and sub-headings use "Sentence case". Only the initial word is uppercase. Does not use the ampersand in place of "and." Does not take terminal punctuation unless a question mark is required.
      Mexico is vast and diverse
  • Inline references, citations, and quotations

    • When referencing...
    • When citing another text...
    • When using quotations...
  • Lists

    • If any item in a list (ordered or not) forms a complete sentence, all items must begin with a capital letter and end with a terminal punctuation mark.
    • If no items in an unordered list form a complete sentence, skip the capitalization and terminal punctuation.
    • If the items in the list complete an unfinished introductory sentence, end all but the last item with a semicolon, add an "and" before the final item, and finish off with terminal punctuation.
  • Linking

    • Choose link text that concisely summarizes the linked document.
    • Do not link terminal punctuation.
    • Try to make the link as short as possible.
    • Only link to well-established websites when possible to decrease link rot.
    • With single word links, avoid using a verb.
  • Punctuation details

    • Citations: Use the cite element when citing titles of books and other major works as well as the titles of magazines and newspapers. The titles of articles and other short works should be enclosed in quotation marks.
    • Acronyms and abbreviations: Use the acronym element to include the full meaning of any acronym (an abbreviation that is pronounced as a word) and use the abbr element for abbreviations that are not pronounced as words. When in doubt, use abbr.
    • Ampersand: Avoid the use of the ampersand except in article titles.
    • Commas: Use the serial comma (the comma preceding the "and" before the last element in a list) except in subheads.
    • Company and publication names: Capitalize the names of companies according to each company's preference unless they begin a sentence, in which case they must be capitalized. Do not capitalize or otherwise emphasize the definite article before the name of a publication as with "the New York Times".
    • Em dashes: The em dash (—) is used to indicate a sudden break in thought (I was thinking about writing a—what time did you say the movie started?), a parenthetical statement that deserves more attention than parentheses indicate, or instead of a colon or semicolon to link clauses. It is also used to indicate an open range, such as from a given date with no end yet (Peter Sheerin [1969—] authored this document), or vague dates (as a stand-in for the last two digits of a four-digit year). Do not leave a space on either side of the em dash.
    • En dashes: The en dash (–) is used to indicate a range of just about anything with numbers, including dates, numbers, game scores, and pages in any sort of document. It is also used instead of the word "to" or a hyphen to indicate a connection between things, including geographic references (like the Mason–Dixon Line) and routes (such as the New York–Boston commuter train). It is used to hyphenate compounds of compounds, where at least one pair is already hyphenated (Netscape 6.1 is an Open–Source—based browser). The Chicago Manual of style also states that it should be used "Where one of the components of a compound adjective contains more than one word," instead of a hyphen. Both of these rules are for clarity in indicating exactly what is being modified by the compound. Other sources also specify the use of an en dash when referring to joint authors, as in the "Bose–Einstein" paper.
    • Adjacent em dashes: Two adjacent em dashes (a 2-em dash) are used to indicate missing letters in a word (I don't give a sh––t).
    • Quotations: Position punctuation according to Chicago rules (periods go on the inside, etc.). Use block quotes instead for more substantial quotations. Single quotation marks are not used except to demarcate quotations within quotations.
    • Hyphens: Hyphenate compound noun phrases used as adjectives ("a man-eating shark" is a shark that eats humans). Do not hyphenate compound adjectival phrases whose first element is an adverb ("quickly moving vehicle").
  • Capitalization details

    • The words "internet," "net," "web," and "website" should not be capitalized when they're found in sentence-cased text. E-mail and e-commerce take the hyphen, but not a capital "e."
    • When using title case, capitalize the first, last, and all other major words. Lowercase "and," "but," "for," "or," and "nor" unless they are emphasized in a particular heading.
    • Examples:
    • When a headline-style heading includes a hyphenated phase, always capitalize the first element. Capitalize the second element unless it is an article, preposition, or any of the coordinating conjunctions noted above. Exception: if the first element is a prefix like pre-, post-, or anti-, or if the phrase is a written-out number, do not capitalize the second element.
    • When using sentence case, capitalize only the first word and proper names.

All Tags