Changes between Version 27 and Version 28 of TutorialsTNG


Ignore:
Timestamp:
Apr 10, 2017 8:41:55 AM (5 years ago)
Author:
smk78
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TutorialsTNG

    v27 v28  
    6868''Recommendation: We should use Libre Office Writer to generate Tutorial documents saved in .fodt format'' 
    6969 
    70 == Tutorial Template == 
    71 Click [http://www.sasview.org/tutorials/sasview_tutorial_template.fodt here] to download a Tutorial template for Libre Office Writer. Don't forget you will need to install Libre Office as well! :-) 
    72  
    73 == Contributing a NEW Tutorial == 
    74 Here are some simple steps to contributing a ''new'' Tutorial: 
    75  
    76 * Download the Tutorial template above 
    77  
    78 * Rename the template to something descriptive of the Tutorial you are about to write (but keep the filename manageable!) 
    79  * filenames must be lowercase 
    80  * separate words in filenames by underscores, nothing else please 
    81  * keep the file extension as .fodt 
    82  
    83 * Open your Tutorial file 
    84  * on Page 1: give your Tutorial a title 
    85  * on Page 2: add your name and email address to the list of contributors 
    86  * on Page 3: state the Objective of the Tutorial 
    87  
    88 * Write your Tutorial! 
    89  
    90 * Save your Tutorial 
    91  
    92 What you do next depends on whether you think you will need to edit your Tutorial (or any other Tutorials) in the future: 
    93  
    94 * I do ''not'' want to edit Tutorials: 
    95  * simply email the Tutorial to tutorials@sasview.org - if it is a rather large file it might be an idea to zip it first!  
    96  
    97 * I do want to edit Tutorials: 
    98  * if you do not already have one, create yourself a [https://github.com/join?source=header-home GitHub] account 
    99  * login to !GitHub 
    100  * in the search box at the top of the window type '!SasView/tutorials' (without the quotes!) and press return 
    101   * you should now be looking at the Tutorials repository; there will be a file called README.md and a green button above it which says 'Clone or download' 
    102  * click on the button marked 'Upload files' to the left of the green button 
    103  * drag-over or choose the Tutorial file you want to upload 
    104  * in the narrow box under the heading 'Commit changes' add a ''short'' title for your upload; eg, 'Added tutorial on X' 
    105  * ''(optional) if you want you can add a more detailed description of what you are uploading in the bigger box'' 
    106  * click the green button marked 'Commit changes' to add your Tutorial file to the repository 
    107  
    108 == Editing an EXISTING Tutorial == 
    109 IMPORTANT! Once a Tutorial file is in the repository it is available for anyone to work on and make changes. Provided all authors ''pull'' a copy of a file from the repository, make their changes, and then ''push'' the changed file back to the repository, Git will ensure that one authors changes are not compromised by another authors changes. 
    110  
    111 * To ''pull'' a Tutorial file from the repository: 
    112  * login to !GitHub 
    113  * navigate to the '!SasView/tutorials' repository 
    114  * click on the Tutorial file you wish to edit 
    115   * the document contents will be displayed; in the case of a Tutorial file this will be a lot of XML! 
    116  * click the button on the right marked 'Raw' 
    117  * right-click anywhere on the page and choose 'Save as...' 
    118  * save the Tutorial file (as type '!OpenDocument Text') 
    119  
    120 ''Warning: Unless you really are a steely-eyed missile man/woman we do not advise that you edit the XML directly''!!! 
    121  
    122 * Edit the Tutorial! 
    123  
    124 * Save the Tutorial! 
    125  
    126 * To ''push'' the Tutorial file back to the repository: 
    127  * login to !GitHub 
    128  * navigate to the '!SasView/tutorials' repository 
    129  * click on the button marked 'Upload files' to the left of the green button 
    130  * drag-over or choose the Tutorial file you want to upload 
    131  * in the narrow box under the heading 'Commit changes' add a ''short'' title for your upload; eg, 'Changed/added X to the tutorial on Y' 
    132  * ''(optional) if you want you can add a more detailed description of what you have changed in the bigger box'' 
    133  * click the green button marked 'Commit changes' to add your Tutorial file to the repository 
    134  
    135 == Tutorials & Authors == 
    136 The following table lists required and requested tutorials, their authors, and production status: 
    137  
    138 ||'''Tutorial'''||'''Type'''||'''Author'''||'''Status'''||'''Comment'''|| 
    139 ||Getting Started||required||Steve|| || || 
    140 ||Simple 1D Fitting||required|| || || || 
    141 ||Simultaneous 1D Fitting||required|| || || || 
    142 ||Batch & Chain 1D Fitting||required|| || ||Should include Combined Batch Fitting|| 
    143 ||Using Constraints||required|| || || || 
    144 ||Working with Polydispersity Functions||required|| || || || 
    145 ||2D Fitting||required|| || || || 
    146 ||Fitting Magnetic SANS||required|| || || || 
    147 ||P(R) Analysis||required|| || || || 
    148 ||Invariant Analysis||required|| || || || 
    149 ||Correlation Function Analysis||required||Steve|| || || 
    150 ||Writing a Plugin-Model||required|| || || || 
    151 ||Working with Image Data||required|| || ||Using the Image Viewer Tool|| 
    152 ||Simulating 2D SANS Data||required|| || ||Using the Generic Scattering Calculator Tool|| 
    153 ||Understanding Orientation Angles||required|| || || || 
    154 ||etc|| || || || || 
    155  
     70== Getting Started == 
     71Click [http://trac.sasview.org/wiki/TutorialsTNGForAuthors here] for the current list of Tutorials and instructions on how to write and contribute them.