How To Edit the Wireshark wiki

You can edit any page by pressing the Edit link at the top of the page, or the EditText link at the bottom of the page. Capitalized words joined together form a WikiName, which hyperlinks to another page. The highlighted title searches for all pages that link to the current page. Pages which do not yet exist are linked with a question mark: just follow the link and you can add a definition. There are some templates defined for typical new pages, like a ProtocolTemplate page.

To learn more about what a WikiWikiWeb is, read about WhyWikiWorks and the WikiNature. Also, consult the WikiWikiWebFaq.

Before posting, please read the License page. If you don't agree with the license, then don't post here.

Wiki editing

How To Add a Protocol

It's often the case, that a protocol is known under different names or abbreviations, e.g. HTTP or HyperTextTransferProtocol, or ...

To prevent duplicated content, redirections are used, so one master page exists with maybe one or even more redirection pages pointing to it. When the wiki user clicks on this redirected term, he/she will see the master page, with a small comment at the top of the page about the redirection.

The master page should be named the way it's often used in the text on other pages (most of the time this will be the abbreviated protocol name). This results in not showing the redirection note most of the time. For example: to reduce typing, I would typically use HTTP in my texts, instead of the much longer HyperTextTransferProtocol, although this might be useful at some places.

When creating the master page, it's a good idea to use the Protocol Template page, which will give you a skeleton to fill in common protocol data.

The redirection page(s) can then simply be created using the Redirect Template page, while creating the page content of the redirection page.

So to create a new protocol page:

Attachments

If you have an example capture file for a specific protocol, it is appreciated to put it into the SampleCaptures page and add a link to that file in the protocols page.

If you want to add a screenshot, it's a good idea to use the .png or .gif file format. The .jpg format isn't the best choice here, as it's producing larger sized files with lower image quality.

Wiki Names

For several reasons it is not recommended to fill in spaces for the page names, as this makes it hard to find the right spelling while typing in the content of another page. So "HyperTextTransferProtocol" should be used instead of "HyperTextTransfer Protocol" or "HyperText Transfer Protocol".

If you want to see spaces between the words of the page name, use the corresponding setting in your wiki preferences.


Discussion

CategoryHowTo

HowToEdit (last edited 2016-12-13 15:24:20 by GeraldCombs)