Planet PDF Style Guide

Below is a summary of the key elements you’ll need to format Web pages. Each one contains explanatory text, then after that is an indented area that shows a sample of the style in use and then under that is sample HTML code you can copy and paste off the page.



Headings

Articles should use <H4> and <H5> tags.

    Heading 1

    Heading 2


    <h4>Heading 1</h4>
    <h5>Heading 2</h5>


Emphasising – Bold, Italics

Don’t use <b> or <i> tags anymore. We now use <strong> and <em>.

Don’t use ascii characters like asterisks to add emphasis. You should replace them with the appropriate tag, either <strong> or <em> emphasis.


    <strong> </strong> INSTEAD OF <b> </b>
    <em> </em> INSTEAD OF <i> </i>
    <em>emphasis</em> INSTEAD OF *emphasis*


Images

Images may be included in articles using any of three possible constructs,
depending on whether the image in question is to be:

  • left-aligned
  • right-aligned
  • center-aligned

The constructs should be used as-is, and should not be used
within blockquotes or any other constructs (lists, source code blocks, etc).
To be correct, the construct needs to reference the correct values for:

  1. the image filename and path, which must give the full path, and begin with a ‘/’ character. E.g. /images/screenshot.gif
  2. the image width in pixels
  3. the image height in pixels
  4. the alternate display (alt) text.

Photographic images and screenshots tend to require a 1-pixel-wideborder — border=’1′ — to keep from looking untidy. Diagrams on the other hand probably should not feature borders. Images should not include hspace or vspace info — this is covered in the stylesheet.

    This is alt textMagnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat. Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat. Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat.

    This is alt textMagnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat. Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat. Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat.

    src=’http://www.planetpdf.com/planetpdf/images/sample_image_small.jpg&#8217; width=’140′ height=’174′
    alt=’This is alt text’>


    <p class='left_aligned_image'> <img src='sample_image_small.jpg'
    width='140' height='174' alt='This is alt text' align='left'>
    Magnibh eliquip ectem quisim ... </p>

    <p class='right_aligned_image'> <img src='sample_image_small.jpg'
    width='140' height='174' alt='This is alt text' align='right'>
    Magnibh eliquip ectem quisim ... </p>

    <p class='center_aligned_image' align='center'><img
    src='sample_image_small.jpg' width='140' height='174'
    alt='This is alt text'></p>


Image Captions

Images can also include captions below them.

    Figure X. Additional text here


    <p class='center_aligned_image' align='center'>
    <br>
    <dfn><cite> Figure X.</cite> Additional text here
    </dfn>
    </p>


More Information

At the end of an article, it is permissible to list links to other
information considered related to the article at hand. This is simply a list
of resources. These are presented as a level four heading followed by an
unordered list with a special class set on it. These two elements must
appear together, and cannot be placed within other elements (eg paragraphs,
blockquotes, tables).

DON’T include links to the forum, store or ARTS PDF. The More Information section should be kept to just article specific related links.

    More Info



    <h4>More Info</h4>
    <ul class='more_information'>
    <li><a href='http://www.123.com'>Ut wissis dolupta</a> -
    dolorero doloboreet ea autpat at. </li>
    <li><a href='http://www.345.com'>www.345.com</a> -
    company Web site</li>
    </ul>


Editor’s Note / Note

Used when editor’s notes or general notes are included in articles.

    Editor’s Note: Niat at acipsustio dolorero doloboreet ea autpat at. Olenis am veliquam venim ver se feugiamcons aut ut wissis dolupta tionsed tie dolutpat, velisi.

    Note: Niat at acipsustio dolorero doloboreet ea autpat at. Olenis am veliquam venim ver se feugiamcons aut ut wissis dolupta tionsed tie dolutpat, velisi.


    <p class='editors_note'><cite>Editor's Note: </cite>
    Niat at acipsustio dolorero doloboreet ea autpat at. </p>

    <p class='editors_note'><cite>Note: </cite>
    Niat at acipsustio dolorero doloboreet ea autpat at. </p>


Publication/Copyright Notice

Content from certain authors or other publications require a notice at the end of them. Copy the HTML immediately below the notice you wish to use and paste it into the ‘Publication Notice’ field when adding the article. DO NOT USE

tags at the start and end.

    Copyright Dave Wraight & Planet PDF. No unauthorised reproduction, distribution or publication permitted.


    <a href='http://www.acrotips.com'><img
    src='http://www.planetpdf.com/planetpdf/images/authors_acrotips_logo.gif' align='right'
    border='0'></a>Copyright Dave Wraight & Planet PDF.
    No unauthorised reproduction, distribution or publication permitted.

    Originally posted on CreativePro.com. Copyright 2003 creativepro.com.


    <a href='http://www.creativepro.com/' target='_NEW'><img
    src='http://www.planetpdf.com/planetpdf/images/creativepro_173x40.gif' width='173'
    height='40' border='0' align='right'></a>Originally
    posted on CreativePro.com. Copyright 2003 <a
    href='http://www.creativepro.com'
    target='_NEW'>creativepro.com</a>.

    This tip is excerpted with permission from ‘Adobe Acrobat 6 Tips and Tricks: The 100 Best‘ by Donna Baker, published by Peachpit Press/Adobe Press, Copyright 2004 Peachpit Press.


    <img src='http://www.planetpdf.com/planetpdf/images/tips_tricks_publication_notice.gif'
    width='50' height='64' border='0' align='right'>This tip is
    excerpted with permission from '<A
    HREF='http://www.peachpit.com/isapi/st~%7B1B16003E-693C-4604-8612-C1A55347D12A%7D/session_id~%7BED4B3996-AA03-4E3F-BFBA-A7BFB168F284%7D/product_id~%7B3144824A-B70C-43BE-9756-78D499FA9975%7D/books/product.asp'>Adobe
    Acrobat 6 Tips and Tricks: The 100 Best</A>' by Donna
    Baker, published by <a href='http://www.peachpit.com/'
    target='_NEW'>Peachpit Press/Adobe Press</A>, Copyright
    2004 Peachpit Press.

    This tip is reprinted with permission from Adobe.com.


    This tip is reprinted with permission from <a
    href='http://www.adobe.com'>Adobe.com</a>.

    Seybold ReportsRepublished with permission from The Seybold Report.


    <a href='http://www.seyboldreports.com/'
    TARGET='_NEW'><img src='http://www.planetpdf.com/planetpdf/images/seyrptlogo_small.gif'
    align=right border=0 alt='Seybold Reports'></A>Republished
    with permission from <a href='http://www.seyboldreports.com/'
    TARGET='_NEW'>The Seybold Report</A>.


Blockquotes / Quotations

Quoted material is contained within blockquotes. The blockquote tags that
denote a quotation may contain many of the usual elements used to format
normal article content: specifically, paragraphs, markup related to
interviews.

    Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem quipit lut autatue dit lut ipit ad magnis et, conse dolor sumsan vel et, corem eum niam, consed tet, quam, verosto commy nullan utat. Riure tinci blandit ipsum velit, quat, verci blaore feugait veliquisi.

    Niat at acipsustio dolorero doloboreet ea autpat at. Olenis am veliquam venim ver se feugiamcons aut ut wissis dolupta tionsed tie dolutpat, velisi.


    <blockquote>
    <p>
    Magnibh eliquip ectem quisim nim zzriustie facipisim ...
    </p>
    <p>Niat at acipsustio dolorero doloboreet ea autpat at ...
    </p>
    </blockquote>


Callout

Callouts appear in the source as div tags of the class ‘callout’. They do
not appear within anything. If the callout has an associated attribution,
the attribution is marked up as a cite element, with the name of the person
quoted marked up as a strong element.

    "Olenis am veliquam venim ver se feugiamcons aut ut wissis dolupta tionsed tie dolutpat, velisi."

    Author Name, Title, Company Name


    <div class='callout'>
    "Olenis am veliquam venim ver se feugiamcons aut ut wissis... "
    <br>
    <cite><strong>Author Name</strong>, Title, Company Name</cite>
    </div>


Interviews

Interview content is broken down into questions and answers which are
marked up as div elements with classes ‘question’ and ‘answer’ as
appropriate. These div tags may contain p elements. The name of the person
quoted should be marked up as a cite element.

    KURT FOSS, Planet PDF Editor: Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem?

    BRUCE CHIZEN, CEO, Adobe: Riure tinci blandit ipsum velit, quat, verci blaore feugait veliquisi.
    Niat at acipsustio dolorero doloboreet ea autpat at. Olenis am veliquam venim ver se feugiamcons aut ut wissis dolupta tionsed tie dolutpat, velisi.

    FOSS: Magnibh eliquip ectem quisim nim zzriustie facipisim verit dolor sit dolobore conulputem?

    CHIZEN: Riure tinci blandit ipsum velit, quat, verci blaore feugait veliquisi.
    Niat at acipsustio dolorero doloboreet ea autpat at. Olenis am veliquam venim ver se feugiamcons aut ut wissis dolupta tionsed tie dolutpat, velisi.


    <div class='question'>
    <p>
    <cite>KURT FOSS, Planet PDF Editor: </cite>Magnibh eliquip ectem quisim nim zzriustie ...
    </p>
    </div>

    <div class='answer'>
    <p>
    <cite>BRUCE CHIZEN, CEO, Adobe: </cite>Riure tinci blandit ipsum velit ...
    </p>
    </div>

    <div class='question'>
    <p>
    <cite>FOSS: </cite>Magnibh eliquip ectem quisim nim zzriustie ...
    </p>
    </div>

    <div class='answer'>
    <p>
    <cite>CHIZEN: </cite>Riure tinci blandit ipsum velit, quat, verci ...
    </p>
    </div>


Code samples

Code samples appearing in the body of an article should be presented within
PRE tags. The only formatting allowed within the PRE tags are EM tags, which
are used to indicate comments. In particular no BR or P tags are allowed.

Code formatting conventions: Code indenting should be done using five space
characters per indent level. Additionally, no line of code may be longer
than 74 characters; lines of code should be broken appropriately to fit
within this limit. If you’re not sure how to do this without breaking the
code itself, ask someone who knows how to program to help you. Otherwise,
code should appear as it would in the originating development environment.
As mentioned previously, all comments should be marked up with EM tags.


    // Create an Array Popup menu items
    var popupArray = new Array();

    {
    for (j = pageLoop; j < pageLoop + 20; j++)
    {
    popupArray[arrayIndex] += '','' + j;
    }

    popupArray[arrayIndex] += ''],';
    arrayIndex = arrayIndex + 1;
    }


    <pre>
    <em>// Create an Array Popup menu items</em>
    var popupArray = new Array();

    {
    for (j = pageLoop; j < pageLoop + 20; j++)
    {
    popupArray[arrayIndex] += '','' + j;
    }

    popupArray[arrayIndex] += ''],';
    arrayIndex = arrayIndex + 1;
    }
    </pre>


Footnotes

Footnotes can be included on each page of an article. If footnotes are
included on a given page, they should appear in the last paragraph of the
page. The paragraph has a special class set, and the characters used to
refer to the text above (*, #, ^ etc) should be marked up with STRONG tags.

    * Lies, all lies. This is nothing but the most scandalous
    fabrication.


    <p class='footnotes'>
    <strong>*</strong> Lies, all lies. This is nothing but the most scandalous
    fabrication.
    </p>

You May Also Like

About the Author: Planet PDF Team

Leave a Reply