Beefy Boxes and Bandwidth Generously Provided by pair Networks
laziness, impatience, and hubris
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
Some people like comments. I, for one, find them interesting. Others may be interested in how PerlMonks has the HTML structured, and they don't feel like running it though a beautifier every time.

Have you looked at the comments in a PM page? Here are all the comments from the landing page:

<!-- Took this out for IE6ites "http://www.w3.org/TR/REC-html40/loose. +dtd" --> <!-- Theme : Web safe blue PerlMonks Theme --> <!-- No CSS Link in User Settings --> <!-- No CSS Data in User Settings --> <!-- monktainer --> <!-- monkbar2001 --> <!-- /monkbar2001 --> <!-- Begin title bar --> <!-- superdoc title chooser(1) --> <!-- /superdoc title chooser(1) --> <!-- monktitlebar --> <!-- /monktitlebar --> <!-- superdoc title chooser(2) --> <!-- superdoc title chooser(2) --> <!-- End title bar --> <!-- Begin main (monktainer) --> <!--contained stuff--> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- Node text goes above. Div tags should contain sig only --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- Node text goes above. Div tags should contain sig only --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!-- Begin Post --> <!-- embed node with vote container --> <!-- TITLE --> <!-- REPLIES --> <!-- AUTHOR --> <!-- DATE --> <!-- End Post --> <!--/contained stuff--> <!--nodelet handling code (monktainer)--> <!-- Begin nodelets --> <!-- Nodelet Break --> <!-- Nodelet Break --> <!-- Nodelet Break --> <!-- Nodelet Break --> <!-- Nodelet Break --> <!-- Nodelet Break --> <!-- Nodelet Break --> <!--<li>[http://planet.perl.org/|Planet Perl]</li>--> <!-- Nodelet Break --> <!-- End nodelets --> <!--/nodelet handling code (monktainer)--> <!-- End main (monktainer)--> <!-- /monktainer -->
That is 168 lines, 3,932 bytes of data sent per page load, less for pages with less content.

What does that tell us? There is:
  • Commented out code for IE
  • The name of the CSS theme which is already listed at the top of the CSS file.
  • No CSS Link in shows us 2 external sources were not configured. Why does a normal end user need to know this?
  • Information about different parts of the header and title bar
  • Start a Post with TITLE, REPLIES, AUTHOR, DATE fields
  • The post comments repeat with slight variations.
  • Nodelets have breaks!
  • A commented out link
  • Containers are closing

That reads like a list of debug statements. It is not a good practice to emit debug statements in production software. Commented out code should never stay around, we have version control for tracking changes. In addition, these comments provide no direct value to the general users of PM. Users are here to ask/answer/learn about Perl not focus on the markup for the content that was delivered to them. There are sites specifically designed for that purpose like CSS Zen Garden.

Sure, it would save bandwidth. I don't know how much the server costs for PM, but if it's one of those "unlimited" plans, then it would be rather useless. Again, we seem to have gotten along just fine with how it is now, so there is no real reason for change.

So saving bandwidth is good but we should not do it because PM does not need to change. Right. Delivering a smaller HTML page and CSS files makes the PM experience better. Faster page loads always make users happy and slower pages make users look for alternatives.

I understand that some users have bandwidth restrictions on their end, so perhaps it could be enabled as a setting. That would probably be the best idea.

This suggestion is not the "best" idea. It would require changes to the server software for processing each page on a per user basis. A simpler solution is just to take snapshots of a few pages, do a writeup and include those pages with the writeup on PM itself which is much easier work then editing the server software to add new features. Users can still study how PM works without sending data that is meaningless to most to all users.

And then there is this statement: After all, we want to encourage learning, and not push away those who are curious, right?

A flippant statement to prop up a strawman argument. Making statements like this just makes you look bad, point of fact.


In reply to Re^2: PM CSS and markup optimizations by kimmel
in thread PM CSS and markup optimizations by kimmel

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • Outside of code tags, you may need to use entities for some characters:
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others drinking their drinks and smoking their pipes about the Monastery: (3)
    As of 2014-08-21 05:05 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      The best computer themed movie is:











      Results (127 votes), past polls