Manual

From WinMerge

Jump to: navigation, search

The user manual is generated from Docbook/XML files in /Doc/Users/Manual.

See readme-manual.html in Docs/Developers directory in Subversion repository.

Contents

[edit] File contents

Rules:

  • Use UTF-8. No exceptions here. The XML has UTF-8 defined as encoding, so if the file is not UTF-8 then our tools fail to build documentation.
  • Prefer to limit the line length to 80 chars.

Especially when creating a patch, be careful that it is UTF-8 encoded. Otherwise we have a problem with our tools. One way to check the patch is open it to editor that can show file encoding. One such and good editor is Notepad++.

[edit] Markup

Remember that markup does not define the look of the generated document. The markup defines the content. Instead of trying to make filename look different, mark it with 
<filename>
-tag. Stylesheet and CSS then take care of formatting filename in the documentation.

Rules:

  • Use 
    <section>
    -tag to mark sections instead of old 
    <sect1>,<sect2>...
    tags.

[edit] Style

Some style rules:

  • Use Sentence case in headings: 
Shell integration 
Using the Compare Files window

[edit] Screenshots

Use screenshots to illustrate GUI elements and behavior.

Some rules about screenshots:

  • All screenshots must be PNG files. Do not use JPG or GIF.
  • Crop screenshots. Do not add 1600x1200 screenshot about one menu item.

[edit] Todo

  • Match similar lines -feature/option is not documented (as reported in Open discussion forum topic Match similar lines)
  • Also not documented options:
    • General: Ask when closing multiple windows
    • Compare: Filter Comments
    • System: Temporary files folder

[edit] Using WinMerge with other tools

We could have own topic for using WinMerge with other tools. Some tools already mention WinMerge in their documentation, but still users have to figure out this for too many tools. And since command line parameters vary per tool, it is not always easy to find correct parameters and correct order.

Tools to list:

  • TortoiseSVN (mentions in docs)
  • TortoiseCVS
  • Perforce
  • Mercurial
  • Bazaar

[edit] References

Retrieved from "http://winmerge.org/Wiki/Manual"
Personal tools
Ads: