Writing PowerShell About Help Topics
In my last post one of the best practices I mentioned was including about help topic documentation in your modules. What wasn’t covered there was what your “about_ModuleName.help.txt” file should contain. There doesn’t seem to be much documentation about this anywhere. Basically, this file can contain anything, but you’ll generally want it be similar to other about help topic entries. Luckily, there are quite a few included with PowerShell for us to learn from.
gci $PSHome -inc *.help.txt -rec
This command will show you all of the about help topic files included with PowerShell. By inspecting them we can come up with a few rules to follow when writing our own.
Each about help topic should include the following sections: TOPIC, SHORT DESCRIPTION, LONG DESCRIPTION and SEE ALSO. Contents of these sections should be indented by 4 characters. Subsections can be included, with their header indented by 2 characters and their contents indented by 6 characters. Lines should not exceed 80 characters in length. Paragraphs should be delimited by blank lines. The first paragraph in the main sections should not have any blank lines between it and the header, while subsections should have a single blank line between the header and the first paragraph. Main section headers should be in all capitals, while subsection headers should be title-cased.
TOPIC should contain a single line indicating the topic the user used to display this help (e.x. “about_ModuleName”).
SHORT DESCRIPTION should contain a single paragraph (and no subsections) summarizing the topic.
LONG DESCRIPTION should contain the full description of the topic and can contain subsections.
SEE ALSO should contain “links” to other information sources, one per line. Usually this will be other names that can be supplied to Get-Help, but you can also include URLs to online information or other sources.
Here’s an example format template:
TOPIC
about_TopicTitle
SHORT DESCRIPTION
One paragraph description of the topic.
LONG DESCRIPTION
Longer descrition of the topic. This can contain multiple paragrahs and
subsections. Be sure to manually wrap within 80 columns.
Some Subheading
Indent subsections by 6 characters.
SEE ALSO
http://example.com
about_SomeOtherTopic
Get-Foo
I'm sure there's other "rules" I've missed, but this is a good starting place.
6 Comments
meizitang slimming pills reviews said
As a man lives so shall he die
my website said
Where in open ended unsecured loans you'll need to test ifinterest rate is favorable you aren't my
website in case you usually do not contain the time for you to look at the reviews, it is
possible to choose leading loan providers available online.
edde dental equipment said
Important Dental Treatment Tricks And Tips
It can be very difficult for people to feel anxiety about going to the dentist.
However, in the event you learn a little bit more
on all the dental treatments options that are available, this ought not
to be too overwhelming. You could be successful
should you heed the information described in this post.
There are several great toothpastes made especially for people who
experience sensitivity to extreme temperatures.If you have sensitive teeth, then you probably have teeth that
happen to be sensitive.
Fluoride supplements can make your teeth.Fluoride can really help to strengthen your gums and
teeth stay healthier. Yellow spots show on your teeth if you are taking too much fluoride.
If you notice these spots, you ought to discontinue consumption of excess fluoride.
Adhere to the directions around the product before brushing.
Plaque build-up will be highlighted noticeably in blue or pink.
Only use these kinds of products if you've got time to take out all traces from
the traces.This isn't something that you wish to use if you are within a rush.
Flossing once daily is a very important part in proper
dental hygiene routine. Flossing your teeth make a big difference.
Carefully slide the floss down close to the gums between
teeth. Move the floss backwards and forth. Avoid forcing the
floss down beneath your gums.
Speak to your dentist before you decide to use
a commercially available product for whitening.Some products can in fact damage your teeth.
Some are safer than others however, though it's difficult to
differentiate between safe and unsafe products.
Your dentist will direct you determine the ideal teeth bleaching
solution for your personal oral health.
Do you find your teeth to ache? There could be an actual reason
for your teeth's sensitivity. It is vital that these items early.
Would you hate thinking about spending 75 dollars over a toothbrush?
Many dentists report that the electronic toothbrushes are definitely
the closest at-home experience you will get to some quality electric toothbrush regularly is almost as
great as a specialist cleaning. While they might not remove of all of the debris that may be beneath your
gum line, these brushes will still be much better
than their cheaper counterparts. Decide on a model containing many
heads as well as a good warranty.
Tend not to only brush the surfaces of your own teeth.
It is merely as essential and also hardwearing .
gums and tongue.
Dairy products are a good accessory for an eating plan if you wish healthy teeth.
Eat more cheese, drink a great deal of milk and eat cheese
more frequently. Take calcium supplement once you learn you're lactose intolerant.
You will see whiter teeth and you are less likely to produce
cavities.
Mouthwash is an important tool in dental hygiene.
Mouthwash can get to locations that your toothbrush just can't be reached by
just brushing. Rinse once every morning and then again during the night.
When you are not able to afford some needed dental
work, speak with your dentist concerning the payment plans
available. This will make it easier to afford dental work a little more
affordable plus it prevents you don't have to wait.
Regular brushing and using floss can ensure your teeth remain healthy.
Teach your children proper dental hygiene very early as possible.
The earlier you add a dental routine in your lifetime, then this better with regards
to their dental hygiene routine throughout their lives.
This may lead to better health overall in addition to lower dental bills.
Brush your teeth around three times daily for just two minutes
each and every time. Regular brushing reduces problems a result of gum disease and
periodontal afflictions. It is much cheaper to look after your teeth consistently than to handle
dental problems later on.
You could make sure your teeth remain healthy by chewing sugar free gum.
Gum chewing helps produce more saliva inside your mouth.
This increase could keep plaque inside your mouth. It can help by neutralizing the acid inside your mouth that can erode your teeth as time
passes.
Proper dental care is a subject that should be essential to everyone.
Through taking time and energy to research and locate the ideal dental hygiene provider, you can do this quickly.
Bookmark this informative article and get back to it when you
have questions about dental care.
edde dental equipment said
Unique Dental Care Tips That Can Enhance Your
Smile
Everybody wants to have longer and stay healthy forever.Dental
hygiene is a big role in doing this for ourselves.
Along with the fact that a proper smile looks great, they could
also offer you signs regarding the state of your respective body's health.
You may want to look around to find an affordable dentist.Unless you have insurance,
you could find that attending a dental school is incredibly affordable.
Do not neglect regular dental hygiene and make
sure to attend your dentist once every half a year.
In case you are scared of an upcoming dental procedure, let your dentist know
you require a hand signal you can utilize if you would like those to stop.
You could possibly choose a hand signal because of it.
You probably won't need to use it, however it could
help you relax.
You might be aware brushing your teeth twice a day is the right way to maintain your teeth
clean and healthy, but sometimes even that is insufficient.
Use dental cleaner that really works on your teeth hence they
remain healthy. A couple of interdental cleaners available include: Oral-B's Interdental Brush and the Reach Stim-U-Dent.
Peroxide has been proven to help whiten your teeth.
Brush gently and steer clear of connection with your gums.
Follow this by brushing together with your regular toothpaste.
Brush your teeth no less than two times every day in order to
avoid cavities. If brushing isn't possible, chew a bit of sugar-free
chewing gum to aid clean your teeth and fresh your breath.
You ought to brush and floss daily. Enough time you would spend on this is
a thing that can repay within your smile. Brushing and flossing are the most effective preventative maintenance.
Engage with your dentist before starting any whitening regimen.
Several of the chemicals utilized in these kinds of products could possibly damage
your teeth. Some are safe, it's tough to differentiate involving the
safe and unsafe products.Your dentist will be able to enable you to the most
effective product for the oral health.
Be sure that you're brushing your tongue is brushed. Lots of people don't brush their tongues, but keeping it clean is just as crucial as it is to completely clean one's
teeth.Your tongue is home to many bacteria.
Dental hygiene is crucial, even if you do not possess any natural teeth.
Brush dentures just like you brush your teeth.
Flossing and brushing are things you should do regularly.
You have to notice a dentist if you have a lot of bleeding while brushing your teeth.
Regular brushing and flossing will assist your teeth remain healthy.
Before meeting with a new dentist the first time, confirm that he or she accepts your dental insurance.
In case the insurance is a match, speak with your provider
to see what types of things are covered. This will keep you from any unfortunate surprises along the bill.
Remember to take care of your teeth as an easy way of ensuring your state of health.
The content you've just read has given you great tips about improving the healthiness of your teeth.
Since these the situation is crucial that you being healthy
overall, keep this advice in your mind constantly.
Gerald said
Admiring the time and energy you put into your blog and in
depth information you present. It's awesome to come across a blog every once in
a while that isn't the same outdated rehashed information.
Excellent read! I've saved your site and I'm including your RSS feeds
to my Google account.
wendy wi said
My developer is trying to convince me to move to .net from PHP.
I have always disliked the idea because of the costs.
But he's tryiong none the less. I've been using WordPress on numerous websites for about a year and am anxious about
switching to another platform. I have heard great
things about blogengine.net. Is there a way I can transfer all my
wordpress content into it? Any kind of help would be greatly appreciated!