Changeset 332a9399dd in tspsg for help


Ignore:
Timestamp:
Jun 7, 2011, 1:13:12 AM (13 years ago)
Author:
Oleksii Serdiuk
Branches:
appveyor, imgbot, master, readme
Children:
445e1edd56
Parents:
b2be4c19a1
git-author:
Oleksii Serdiuk <contacts@…> (06/07/11 01:13:12)
git-committer:
Oleksii Serdiuk <contacts@…> (06/29/12 19:46:00)
Message:

Working on help:

  • Added TSPSG screenshots.
  • Fixed a typo in style.css file.
Location:
help/html
Files:
7 added
3 edited

Legend:

Unmodified
Added
Removed

  • help/html/en/mainwindow.html

    rb2be4c19a1 r332a9399dd  
    2020        <h1>Main Window</h1>
    2121        <p>This is the main application windows. It consists of <a href="#menu" class="place">Main Menu</a>, <a href="#task" class="place">Task Tab</a>, <a href="#solution" class="place">Solution Tab</a> and <a href="#status" class="place">Status Bar</a>.</p>
    22         <p class="info tip">Get context tip in the Status Bar while hovering your mouse over different elements (Desktop platforms only).</p>
     22        <p class="screenshot"><img src="images/mainwindow.png" alt="Main Window" /></p>
     23        <p class="tip">Get context tip in the Status Bar while hovering your mouse over different elements (Desktop platforms only).</p>
    2324        <h2><a id="menu">Main Menu</a></h2>
    2425        <p class="inprogress"></p>
    2526        <h2><a id="task">Task Tab</a></h2>
    2627        <p>Task Tab is pretty simple. It has the following elements:</p>
     28        <p class="screenshot"><img src="images/mainwindow.task.png" alt="Task Tab" /></p>
    2729        <ol class="params">
    2830                <li><span class="name">Variant</span> <span class="type">[integral number from 1 to 99]</span> - it doesn't affect anything, except it is printed in the solution header.</li>
    2931                <li><span class="name">Cities</span> <span class="type">[integral number from 3 to 50]</span> - the number of cities in the task. <div class="note">The higher the number of cities, the longer it takes to solve the task.</div></li>
    30                 <li><span class="name">Task Table</span> <span class="type">[any floating point number or "---" for infinity]</span> - this table contains the task itself. Each cell represents a travel price from the city, indicated in the row, to the city, indicated in the column. <div class="info tip">Also, you can enter infinity by entering any non-numeric value (e.g., any random character).</div></li>
    31                 <li><span class="name">Random</span> <span class="type">[button]</span> - if you press this button the table will be filled with random values, according to the settings in the <span class="place">Settings</span> -> <a href="preferences.html" class="place">Preferences...</a> -> <a href="preferences.html#task" class="place">Task Section</a>.
    32                         <div class="warning">Any unsaved changes in the table will be overwritten without prompt.</div></li>
     32                <li><span class="name">Task Table</span> <span class="type">[any floating point number or "---" for infinity]</span> - this table contains the task itself. Each cell represents a travel price from the city, indicated in the row, to the city, indicated in the column. <div class="tip">Also, you can enter infinity by entering any non-numeric value (e.g., any random character).</div></li>
     33                <li><span class="name">Random</span> <span class="type">[button]</span> - if you press this button the table will be filled with random values, according to the settings in the <span class="place">Settings</span> -> <a href="preferences.html" class="place">Preferences...</a> -> <a href="preferences.html#task" class="place">Task Section</a>. <div class="warning">Any unsaved changes in the table will be overwritten without prompt.</div></li>
    3334                <li><span class="name">Solve</span> <span class="type">[button]</span> -  this button starts the solution process. The progress will be shown and the <a href="#solution" class="place">Solution Tab</a> will be activated on success.</li>
    3435        </ol>
    3536        <h2><a id="solution">Solution Tab</a></h2>
    3637        <p>Solution tab contains the solution text area and two buttons:</p>
     38        <p class="screenshot"><img src="images/mainwindow.solution.png" alt="Solution Tab" /></p>
    3739        <ol class="params">
    3840                <li><span class="name">Solution text</span> <span class="type">[rich text]</span> - after the successful solution it contains its steps and graph. The output can be customized in the <span class="place">Settings</span> -> <a href="preferences.html" class="place">Preferences...</a> -> <a href="preferences.html#output" class="place">Output Section</a>.</li>

  • help/html/en/preferences.html

    rb2be4c19a1 r332a9399dd  
    2020        <h1>Preferences</h1>
    2121        <p class="inprogress">This dialog provides a way to set different user preferences. The parameters are grouped into three sections: <a href="#general" class="place">General</a>, <a href="#task" class="place">Task</a> and <a href="#output" class="place">Output</a>. Also, consult the <a href="#hidden" class="place">&quot;Hidden&quot; Settings</a> section that contains info about some additional settings. They might become available in this dialog in future.</p>
     22        <p class="screenshot"><img src="images/preferences.png" alt="Preferences" /></p>
     23        <p class="tip">Hover your mouse over a dialog element to get its short description at its bottom (Desktop platforms only).</p>
    2224        <p class="inprogress">Write where the settings are stored.</p>
    23         <p class="info">You can reset your settings by holding <em>Shift</em> and clicking <strong>OK</strong> button. You will be presented with the confirmation dialog. If you press <strong>Restore Defaults</strong>, all settings will be reset to their defaults.</p>
    24         <p class="tip">TIP: Hover your mouse over parameter to get its short description at the bottom of the dialog (Desktop platforms only).</p>
    25 <h2><a id="general">General</a></h2>
     25        <p class="note">You can reset your settings by holding <em>Shift</em> and clicking <strong>OK</strong> button. You will be presented with the confirmation dialog. If you press <strong>Restore Defaults</strong>, all settings will be reset to their default values.</p>
     26        <h2><a id="general">General</a></h2>
    2627    <p>This section contains general application settings.</p>
     28        <p class="screenshot"><img src="images/preferences.general.png" alt="General Section" /></p>
    2729        <ol class="params inprogress">
     30                <li><span class="name"></span> <span class="type"></span> - </li>
     31                <li><span class="name"></span> <span class="type"></span> - </li>
     32                <li><span class="name"></span> <span class="type"></span> - </li>
     33                <li><span class="name"></span> <span class="type"></span> - </li>
    2834                <li><span class="name"></span> <span class="type"></span> - </li>
    2935        </ol>
    3036    <h2><a id="task">Task</a></h2>
    3137    <p>This section contains task related settings.</p>
     38        <p class="screenshot"><img src="images/preferences.task.png" alt="Task Section" /></p>
    3239        <ol class="params inprogress">
     40                <li><span class="name"></span> <span class="type"></span> - </li>
     41                <li><span class="name"></span> <span class="type"></span> - </li>
     42                <li><span class="name"></span> <span class="type"></span> - </li>
    3343                <li><span class="name"></span> <span class="type"></span> - </li>
    3444        </ol>
    3545    <h2><a id="output">Output</a></h2>
    3646    <p>This section conatins solution output related settings.</p>
     47        <p class="screenshot"><img src="images/preferences.output.png" alt="Output Section" /></p>
    3748        <ol class="params inprogress">
     49                <li><span class="name"></span> <span class="type"></span> - </li>
     50                <li><span class="name"></span> <span class="type"></span> - </li>
     51                <li><span class="name"></span> <span class="type"></span> - </li>
     52                <li><span class="name"></span> <span class="type"></span> - </li>
     53                <li><span class="name"></span> <span class="type"></span> - </li>
     54                <li><span class="name"></span> <span class="type"></span> - </li>
     55                <li><span class="name"></span> <span class="type"></span> - </li>
     56                <li><span class="name"></span> <span class="type"></span> - </li>
    3857                <li><span class="name"></span> <span class="type"></span> - </li>
    3958        </ol>

  • help/html/style.css

    rb2be4c19a1 r332a9399dd  
    3030}
    3131
    32 h1, h2, h3 {
    33 }
    34 
    35 .info {
     32.screenshot {
     33        text-align: left;
    3634}
    3735
    … …  
    4139
    4240.note:before {
    43         content: "NOTE: "
     41        content: "NOTE: ";
    4442        font-weight: bold;
    4543}
Note: See TracChangeset for help on using the changeset viewer.