doc/Screenshots.txt

   1 Grabbing Screenshots for TortoiseSVN Docs\r
   2 =========================================\r
   3 This file is a guide to grabbing screenshots for the user manual.\r
   4 Although there are not many hard and fast rules, some screenshots need\r
   5 care to set up as they are demonstrating a range of features.\r
   6 \r
   7 To help with consistency, some of these instructions are presented\r
   8 as a TortoiseProc.exe command line. These assume that the TSVN\r
   9 bin directory is in the PATH and that you have a doc folder checked\r
  10 out at C:\TortoiseSVN\Doc. Adjust the path according to your location.\r
  11 \r
  12 If you do not already have a screen capture/image viewer program,\r
  13 download a free copy of IrfanView from www.irfanview.com\r
  14 \r
  15 You will also need to ensure that the screenshots are at the correct\r
  16 DPI setting and size to fit the page. Fortunately this is easy as you\r
  17 can use the AdjustImages.bat script which does the conversion for you.\r
  18 This script requires NConvert.exe which you can download from\r
  19 http://www.xnview.com\r
  20 \r
  21 From the images directory you can simply run adjustimages to check all\r
  22 images in all languages - it could take a long time. You can check\r
  23 specific languages or images using a single parameter, eg.\r
  24 adjustimages en\*.png\r
  25 adjustimages en\Rev*.png\r
  26 \r
  27 \r
  28 General rules for all screenshots\r
  29 =================================\r
  30 Use PNG format\r
  31 8 bit colour depth (256 colours)\r
  32 Windows XP style preferred\r
  33 \r
  34 Test Repository\r
  35 ===============\r
  36 We now have a batch file to create a repository and some working copies\r
  37 in various states of modification and conflict. In the test folder,\r
  38 create a file called DocPath.txt which contains the path to your doc\r
  39 folder, but with forward slashes and URI escaping of spaces and other\r
  40 funny characters. Now simply run MakeTest.bat to create the test folders\r
  41 in the 'temp' subfolder.\r
  42 \r
  43 Instructions for each screenshot\r
  44 ================================\r
  45 Authenticate.png\r
  46         You will have to clear authentication to make this one appear.\r
  47         Do this temporarily for the TSVN repo by renaming\r
  48         [Application Data]\Git\auth\svn.simple\f55fc06b366775f8c026407285be8070\r
  49 \r
  50 BlameDialog.png\r
  51         Blame any file\r
  52 \r
  53 ch02dia1-7.png\r
  54         These are 'borrowed' from the Git Book\r
  55 \r
  56 Changelist.png\r
  57         Use the 'doc' test WC.\r
  58         Open the commit dialog and add dug_blame.xml to a new changelist 'Blame doc update'.\r
  59         Screenshot shows context menu for the changelist.\r
  60         Remove dug_blame.xml from the changelist.\r
  61 \r
  62 Checkout.png\r
  63         Just pretend to checkout the TSVN doc folder:\r
  64         TortoiseProc.exe /command:checkout /path:"C:\TortoiseSVN\Doc" /url:"http://tortoisesvn.tigris.org/svn/tortoisesvn/trunk/doc"\r
  65 \r
  66 Commit.png\r
  67         Use the 'doc' test WC.\r
  68         Modify server.xml in the 'ext' folder\r
  69         Open the commit dialog for the 'doc' folder\r
  70         Type a message with spelling problem, eg.\r
  71                 Update documentation to explain new Frobnicate checkbox.\r
  72         Right click on dug_blame and include context menu in screenshot.\r
  73         This setup is also used for CommitSpellCheck.png and CreatePatch.png\r
  74 \r
  75 CommitSpellcheck.png\r
  76         As above, but right click on the mis-spelled word to get the context menu.\r
  77 \r
  78 CommitProgress.png\r
  79         Capture the progress dialog at the end of any commit.\r
  80 \r
  81 ContextMenuDirControl.png\r
  82         In explorer, right click on a versioned folder (eg. TSVN doc folder) and\r
  83         capture the main context menu and the large TSVN sub menu.\r
  84         You will probably have to capture the entire explorer window and\r
  85         then edit out everything except the context menus. Ideally, also edit\r
  86         out all non-TSVN items from the main context menu.\r
  87         Because of the manual editing, this item (and the next 3) is a bit of\r
  88         a pain and generally best left until just before a new release in case\r
  89         something else changes.\r
  90 \r
  91 ContextMenuDirNoControl.png\r
  92         As above, but capture for an unversioned folder.\r
  93 \r
  94 ContextMenuFileControl.png\r
  95         As above, but capture for a single versioned file.\r
  96 \r
  97 ContextMenuFileNoControl.png\r
  98         As above, but capture for a single unversioned file.\r
  99         Expand the 'add to ignore list' entry.\r
 100 \r
 101 Copy.png\r
 102         Open the branch/tag dialog for the TSVN doc folder and enter a\r
 103         fictitious URL for the target. It is easiest to copy and paste the\r
 104         source URL and edit /trunk/ to /branches_1.4.x/ or something like that.\r
 105 \r
 106 CreatePatch.png\r
 107         Set up as for the commit dialog, but create a patch instead.\r
 108         The dialog shows the files selected for the patch.\r
 109 \r
 110 ExplorerFileMenu.png\r
 111         Use the 'doc' test WC.\r
 112         In explorer, right click on showlog.xml and 'Create shortcut'\r
 113         Select the newly created shortcut.\r
 114         Click on the explorer file menu and capture the menu which opens.\r
 115         There should be 3 TSVN entries (shortcut, shortcut-target and folder).\r
 116         Delete the shortcut when you're done.\r
 117 \r
 118 ExportURL.png\r
 119         Right click on the TSVN doc folder and Export\r
 120         Enter a folder name in the Export directory box\r
 121 \r
 122 GetLock.png\r
 123         Make sure you have the 'Show lock dialog before locking files' option\r
 124         checked in Settings->Dialogs 2\r
 125         Select a bunch of versioned files and use TSVN->GetLock\r
 126 \r
 127 Import.png\r
 128         Right click on any unversioned folder and TSVN->import\r
 129         Make up a URL like http://svn.example.com/svn/paint/trunk\r
 130         Add a suitable message like 'Initial import of paint files'.\r
 131 \r
 132 IssueTrackerQuery.png\r
 133         Install the example CS issue tracker plugin.\r
 134         Set up the plugin to work on your test docs folder.\r
 135         Open the commit dialog and click on the 'Choose Issue' button.\r
 136         Centre the plugin dialog over the commit dialog so that you can still\r
 137         see the 'choose issue' button.\r
 138         You will need a whole screen capture, then trim down to just the\r
 139         commit dialog area.\r
 140 \r
 141 LogContextMenu1.png\r
 142         Right click on any versioned file or folder and TSVN->show log\r
 143         Select 2 revisions in the top pane\r
 144         Right click on the selected revisions (top pane) and capture the context menu\r
 145 \r
 146 LogContextMenu2.png\r
 147         Right click on any versioned file or folder and TSVN->show log\r
 148         Select 1 revision in the top panel\r
 149         Right click on a file in the bottom pane and capture the context menu\r
 150 \r
 151 LogContextMenu.png\r
 152         Right click on any versioned file (not folder) and TSVN->show log\r
 153         Select 1 revision in the top panel\r
 154         Right click on the selected revisions (top pane) and capture the context menu\r
 155 \r
 156 LogMessages.png\r
 157         Show the log dialog for the TSVN src directory (use the repo browser if you\r
 158         do not have this in a working copy\r
 159         Use 'Show range' to get revisions 5000 to 5100\r
 160         Centre r5050 in the top pane\r
 161         Position the mouse over the hyperlink for issue #198\r
 162 \r
 163 LogMergeTrack.png\r
 164         [TEMPORARY - FixMe after 1.5 release]\r
 165         Download the SVN 1.5 Beta client and merge tracking dump file.\r
 166         Load the dump file into a test repo and checkout a WC.\r
 167         ShowLog for the WC and select 'Include merged revisions'\r
 168         Move the slider to show a useful range of real and merged revisions.\r
 169 \r
 170 MergeWizardRange.png\r
 171         Start the merge dialog from the TSVN doc folder.\r
 172         Select the 'revision range' option and hit Next.\r
 173         Put some fictitious numbers in the revision range box.\r
 174 \r
 175 MergeWizardTree.png\r
 176         Start the merge dialog from the TSVN trunk or doc folder.\r
 177         Select the 'merge two trees' option and hit Next.\r
 178         Copy the URL to the End URL box and edit it to reflect a branch,\r
 179         eg the LogCaching branch.\r
 180         Enter the same revision number in both boxes.\r
 181 \r
 182 MergeWizardOptions.png\r
 183         Last page of the wizard, with default options.\r
 184 \r
 185 MergeConflictCallback.png\r
 186         Use a fresh 'doc' test WC\r
 187         Showlog for dug_ignore.xml\r
 188         Select r6 and 'revert changes from this revision.\r
 189         This should generate a conflict and bring up the callback.\r
 190 \r
 191 mergeprinciple.png\r
 192         Borrowed from the Git docs\r
 193 \r
 194 Properties.png\r
 195         Right click on the TSVN doc folder and open Explorer properties\r
 196           (not TSVN properties).\r
 197         Capture the Git tab\r
 198 \r
 199 PropertyAdd.png\r
 200         For any versioned folder, TSVN->Properties\r
 201         In the list, click Add\r
 202         Capture the add properties dialog with the combo expanded\r
 203 \r
 204 PropertyList.png\r
 205         For the TSVN doc folder, TSVN->properties\r
 206 \r
 207 Relocate.png\r
 208         For the TSVN doc folder, TSVN->relocate\r
 209         Edit the To URL to show a different hostname\r
 210           eg. http://repos.tortoisesvn.net\r
 211         Do NOT click OK ;)\r
 212 \r
 213 Repobrowser.png\r
 214         Open the repo browser to show the contents of TSVN trunk in the left pane\r
 215         In the right pane, right click on the TortoiseBlame folder to show context menu\r
 216 \r
 217 RepoStatus.png\r
 218         Use the 'doc' test WC\r
 219         TSVN->Check for Modifications\r
 220         Click the 'check repository' button\r
 221         Show context menu for locally modified file (dug_add.xml)\r
 222         Make sure context menu is not obscuring useful columns -\r
 223           position the mouse at the left edge of remote property status\r
 224 \r
 225 Revert.png\r
 226         Use the 'doc' test WC\r
 227         TSVN->Revert\r
 228 \r
 229 RevisionGraph.png\r
 230         Show revision graph for the TSVN doc folder\r
 231           (this may take a couple of minutes if the log cache is empty)\r
 232         Make sure these settings are used on the toolbar:\r
 233         Show-all-revisions              OFF\r
 234         Group-branches together ON\r
 235         Oldest-at-top                   OFF\r
 236         Show HEAD                               ON\r
 237         Show overview                   ON\r
 238         Set the zoom such that there are about 10-15 nodes showing\r
 239         Select 2 revisions and show the context menu\r
 240 \r
 241 RightDragMenu.png\r
 242         Right-drag a versioned item to a versioned folder\r
 243 \r
 244 SettingsHooks.png\r
 245         TortoiseSVN->Settings->Hooks scripts\r
 246         If you do have any hooks, create 2 (see below) eg. start commit and post update\r
 247         Capture the settings dialog with the 2 hooks displayed\r
 248 \r
 249 SettingsHookEdit.png\r
 250         Add a new client hook\r
 251         Type eg. Start commit hook\r
 252         Working copy path - your doc folder\r
 253         Command line - some fictitious path + start-commit.bat\r
 254         (the hook does not have to exist)\r
 255 \r
 256 SettingsLogCache.png\r
 257         Just a screenshot, but if you want to hide your personal cached URLs,\r
 258         go to %APPDATA%\TortoiseSVN\logcache and temporarily move any cache directory\r
 259         to the level above. You will have to close and reopen the settings dialog.\r
 260         The cache size gives you a clue which GUID corresponds to which URL.\r
 261 \r
 262 SettingsMain.png\r
 263         Include an ignore pattern. If you don't have one, use "*.tmp *.~*"\r
 264 \r
 265 SettingsColors.png\r
 266 SettingsContext.png\r
 267 SettingsDialog.png\r
 268 SettingsDialog2.png\r
 269 SettingsOverlay.png\r
 270 SettingsOverlayChooser.png\r
 271 SettingsProgs.png\r
 272 SettingsProgsAdv.png\r
 273 SettingsProxy.png\r
 274 SettingsSavedData.png\r
 275 SettingsLogStats.png\r
 276         All other settings dialogs, just get a screenshot of the appropriate page.\r
 277 \r
 278 StatsByAuthor.png\r
 279         Use TortoiseSVN/doc/po\r
 280         TSVN->Showlog\r
 281         Show 'Commits by author' in bar graph view\r
 282         Make sure there are several authors - 7 or 8 is good\r
 283 \r
 284 StatsByAuthPie.png\r
 285         As above but view as pie chart\r
 286 \r
 287 StatsByDate.png\r
 288         Use TortoiseSVN/doc/po\r
 289         TSVN->Showlog\r
 290         Show 'Commits by date' in line graph view\r
 291         Adjust the slider so that there are about 4 traces shown\r
 292 \r
 293 Switch.png\r
 294         TortoiseSVN->switch for TSVN doc folder\r
 295 \r
 296 TMerge_OnePane.png\r
 297         Select doc/test/subwcrev2.txt and doc/test/subwcrev3.txt\r
 298         Right click on subwcrev3.txt and TSVN->Diff\r
 299         Use 1-pane view\r
 300         Make sure the 3 areas with changes are showing\r
 301 \r
 302 TMerge_Open.png\r
 303         Start TortoiseMerge from the start menu\r
 304 \r
 305 TMerge_PatchWindow.png\r
 306         Use the 'doc' test WC\r
 307         TSVN->Apply Patch\r
 308         Select doc/test/temp/docs.patch\r
 309         In the patch list, right click on one of the files to show the\r
 310           context menu, making sure it is within the patch window\r
 311         Capture just the patch list window\r
 312 \r
 313 TMerge_SettingsColors.png\r
 314 TMerge_SettingsGeneral.png\r
 315         Simple snapshots of the settings\r
 316 \r
 317 TMerge_ThreePane.png\r
 318         Use the 'docs' test WC\r
 319         TSVN->Update (after fresh repo/WC creation)\r
 320         TSVN->Edit conflicts for subwcrev.txt\r
 321         Jump to first conflict\r
 322 \r
 323 TMerge_TwoPane.png\r
 324         As for MergeOnePane, but use 2-pane view.\r
 325 \r
 326 TortoiseBlame.png\r
 327         TortoiseSVN->Blame for tsvn_app_automation.xml\r
 328         Enable age-colouring of lines.\r
 329         Display a range of revisions with several authors,\r
 330           eg lines 342-368.\r
 331         Hover the mouse over a revision that appears a few times,\r
 332           and has a reasonable comment attached, eg. r7408.\r
 333         Capture with the log message tooltip showing.\r
 334 \r
 335 TortoiseIDiff.png\r
 336         Ideally diff one of the screenshots you have updated.\r
 337 \r
 338 UpdateFinished.png\r
 339         Use a freshly created 'docs' test WC\r
 340         TSVN->update\r
 341         Capture the progress dialog when update is finished\r
 342         \r
 343 upgradecheck.png\r
 344         Downgrade to an older version of TSVN or capture this as the opportunity arises\r
 345         TSVN->About\r
 346         Click on 'Check for updates'\r
 347         Hover the mouse over the URL of the TSVN site\r