{"id":118,"date":"2018-02-28T15:35:46","date_gmt":"2018-02-28T19:35:46","guid":{"rendered":"https:\/\/benjaminray.com\/codebase\/?p=118"},"modified":"2024-04-08T02:36:28","modified_gmt":"2024-04-08T05:36:28","slug":"post-guidelines-outdated","status":"publish","type":"post","link":"https:\/\/benjaminray.com\/codebase\/post-guidelines-outdated\/","title":{"rendered":"Post Guidelines – Outdated (Google Prettify)"},"content":{"rendered":"

Background<\/h2>\n

This site uses Markdown<\/a> for simplified input and Google Prettify<\/a> for syntax highlighting.<\/p>\n

Adding Code to a Post<\/h2>\n

There are two ways to add code to a post using Markdown. Either indent the code with 4 spaces or a tab, or wrap the code block with three back-ticks (```).<\/p>\n

Example of the indented option:<\/h3>\n
\n
\nInput:<\/p>\n
\n    var s = 'some test';\n    console.log(s);<\/pre>\n<\/p><\/div>\n
\nOutput:
\n<\/p>\n
var s = 'some test';\nconsole.log(s);<\/code><\/pre>\n<\/p><\/div>\n<\/div>\n
Example of using back-ticks:<\/h3>\n
\n
\nInput:<\/p>\n
\n```\nvar s = 'some test';\nconsole.log(s);\n```\n<\/pre>\n<\/p><\/div>\n
\nOutput:<\/p>\n
<\/p>\n
var s = 'new test';\nalert('test');\n<\/code><\/pre>\n<\/p><\/div>\n<\/div>\n
One advantage to using the back-ticks method is that you can add a language hint, which may be require if PrettyPrint is incorrectly guessing the language, or the language is VB:<\/p>\n
\n```vb\nDim str as String\n' Some comment\nstr = New String("test")\n```\n<\/pre>\n
Inline Code<\/h2>\n
To add inline code, wrap it in single backticks `like this` and it will be wrapped in a code tag and look like this<\/code>. (Note: I have not enabled highlighting for code tags, and if I do enable it, there's no way to specify the language, so it wouldn't properly highlight VB.)<\/p>\n
To include a backtick in regular text (not in inline code), escape it with a backslash: \`<\/p>\n
To include a backtick inside a piece of inline code like ` this<\/code>, open and close the code tag with a different number of backticks than appear in the inline code. E.g. If you want to display 1 backtick in the inline code, open\/close with two or more. To include two in a row in the code tag, open\/close with 1 or 3 or more. ``this`works`` becomes this`works<\/code>, `this``works` becomes this``works<\/code>, etc.
\nMore info here: https:\/\/meta.stackexchange.com\/a\/70679\/286764<\/a><\/p>\n
<PRE> Tag Without Syntax Highlighting<\/h2>\n
To include a <pre> tag without syntax highlighting, simply add the class noprettyprint<\/code> to it. E.g.:<\/p>\n
\n
\n    Input:<\/p>\n
\n<pre class="noprettyprint">\n    Some stuff inside a PRE tag\n<\/pre>\n<\/pre>\n<\/p><\/div>\n
\nOutput:<\/p>\n
\nSome stuff inside a PRE tag\n<\/pre>\n<\/p><\/div>\n<\/div>\n
VB.Net<\/h2>\n
VB is not automatically detected by PrettyPrint, and it requires a language hint. Otherwise, single quote would be interpreted as the start of a string, not a comment. To add a language hint in Markdown, you must open and close the code block with ```, with the language hint on the opening quotes: ```vb.  (No indenting required when opening and closing a code block this way.)<\/p>\n
Input:<\/p>\n
\n```vb\nProtected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load\n    If Not Page.IsPostBack Then\n        ' Populate email modal with some defaults\n        ucModalEmail.DefaultSubject = \"Daily Work Schedule | 2017-11-23 (Tue)\"\n        ucModalEmail.Subject = ucModalEmail.DefaultSubject\n    End If\nEnd Sub\n```\n<\/pre>\n
Output:<\/p>\n
Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load\n    If Not Page.IsPostBack Then\n        ' Populate email modal with some defaults\n        ucModalEmail.DefaultSubject = \"Daily Work Schedule | 2017-11-23 (Tue)\"\n        ucModalEmail.Subject = ucModalEmail.DefaultSubject\n    End If\nEnd Sub\n<\/code><\/pre>\n
Note: You can always manually create the <pre><code>...<\/code><\/pre> tags with the language specified.<\/p>\n
Input:<\/p>\n
\n<pre>\n<code class="language-vb">\nProtected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load\n    If Not Page.IsPostBack Then\n        ' Populate email modal with some defaults\n        ucModalEmail.DefaultSubject = "Daily Work Schedule | 2017-11-23 (Tue)"\n        ucModalEmail.Subject = ucModalEmail.DefaultSubject\n    End If\nEnd Sub\n<\/code>\n<\/pre>\n<\/pre>\n
Output:<\/p>\n
\nProtected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load\n    If Not Page.IsPostBack Then\n        ' Populate email modal with some defaults\n        ucModalEmail.DefaultSubject = \"Daily Work Schedule | 2017-11-23 (Tue)\"\n        ucModalEmail.Subject = ucModalEmail.DefaultSubject\n    End If\nEnd Sub<\/code>\n<\/pre>\n
ASP.Net<\/h2>\n
No need to include a language hint, and there is no language hint for ASP or ASP.Net anyway.<\/p>\n
Input:<\/p>\n
\n```\n<asp:Label ID=\"lblTestLabel\" runat=\"server\">This is a label<\/asp:Label>\n<asp:PlaceHolder ID=\"pnlTitle_NewPermit\" runat=\"server\">  \n    <asp:Literal ID=\"liNewType\" runat=\"server\"><\/asp:Literal>\n    Some Content Here\n<\/asp:PlaceHolder>\n```\n<\/pre>\n
Output:<\/p>\n
<asp:Label ID=\"lblTestLabel\" runat=\"server\">This is a label<\/asp:Label>\n<asp:PlaceHolder ID=\"pnlTitle_NewPermit\" runat=\"server\">\n    <asp:Literal ID=\"liNewType\" runat=\"server\"><\/asp:Literal>\n    Some Content Here\n<\/asp:PlaceHolder>\n<\/code><\/pre>\n
Notes: When using ASP.Net markup with ASP tags inside a property, the tag will not be properly highlighted, as seen here:<\/p>\n
<asp:UpdatePanel ID=\"UpdatePanel1\" runat=\"server\">\n  <ContentTemplate>\n    <asp:Literal ID=\"liNewType\" runat=\"server\"><\/asp:Literal>\n    <asp:Button ID=\"SubmitButton\" \n        runat=\"server\" \n        Text=\"partial postback\"\n        CommandArgument=\"<%#Eval('id')%>\" \/>\n  <\/ContentTemplate>\n<\/asp:UpdatePanel>\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Background This site uses Markdown for simplified input and Google Prettify for syntax highlighting. Adding Code to a Post There are two ways to add code to a post using  […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[1],"tags":[],"class_list":["post-118","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"acf":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p9GNjN-1U","jetpack_likes_enabled":false,"_links":{"self":[{"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/posts\/118","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/comments?post=118"}],"version-history":[{"count":150,"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/posts\/118\/revisions"}],"predecessor-version":[{"id":1521,"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/posts\/118\/revisions\/1521"}],"wp:attachment":[{"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/media?parent=118"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/categories?post=118"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/benjaminray.com\/codebase\/wp-json\/wp\/v2\/tags?post=118"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}