Simplify, Modify. What is a Text Part?
Not everyone may be familiar with Text Parts, though they've been a function of certain ASP.NET blogging applications for years. Text Parts are BBCode-like, bracketed text strings with specific properties that when displayed on a page are converted into something else. Text Parts are traditionally used with blog posts, which is the extent of their initial functionality in Sueetie, though in the future we plan to introduce Text Parts in other applications as well.
First, here's what a text part looks like.
[sueetie:myTextPart]"sueetie" denotes that the bracketed content is a Sueetie Text Part and "myTextPart" is the specific Text Part to be displayed on the page.
A Text Part Example
Here is a working example of a text part. There is a series on our
Business of Community blog titled "In the Enterprise." Because Sueetie is moving into the Enterprise Software space, we were excited to create this series. With each blog post we wanted to add a statement about Sueetie's Enterprise Network capabilities. Here is what that statement looks like at the time of this writing.
The issue is that we wanted the statement to reflect the current version and status of Sueetie as it related to the Enterprise. If someone were to read an "In the Enterprise" post in, say, 6 months from now, we wanted that statement to describe features in Sueetie 4.1 or 4.2, not the upcoming version 4.0. By using a textpart we have full control over the statement's display for posts regardless of the date they were published.
What the Example Text Part Looks Like
As we mentioned earlier, a text part is bracketed text which begins with "[sueetie:" and contains a text part name. The text part name of our "In the Enterprise" callout statement is "EnterpriseCallout," so our text part looks like this.
That's all we have to do to generate the boxed HTML content shown on our "In the Enterprise" posts. And as we discussed, the content will change based on the current Sueetie Version.
Parameters!
Sueetie Text Parts support parameters. For instance, you may need to modify the content based on the post. Here's what a text part with parameters looks like.
Parameters are delimited with commas and a separated from the Text Part Name by a colon.
Managing Text Parts
Text Parts are managed in the Sueetie Administration Addon Pack area. Here is what the administration form of the text part with parameters looks like. Notice when you are using parameters, you'll use {#} to bookmark them in the Content Html.
Finally, here's what the parametized text part looks like when displayed on the page.
Where Text Parts are Displayed and Not Displayed¶
The tricky thing about using Text Parts is to display them only where and when you want them. For instance, you will probably not want your text part expanding on a blog post list where the abbreviated post is displayed. You also probably don't want the text part expanded in an RSS Feed or, say, in search results.
Text Parts are expanded on single Blog Posts and Blog Pages only. They are not displayed on Post List pages or on Sueetie Blog Post List Views. Text Parts are removed from blog posts before indexed by Sueetie Global Search. Text Parts are also removed from RSS Feeds.
As we mentioned, Text Parts are only used on blog posts for the Sueetie v4.0 release. In future releases we plan on supporting Text Parts on other applications as well.
Top