]> git.donarmstrong.com Git - neurodebian.git/blobdiff - sphinx/index.rst
Make FAQ foldable again.
[neurodebian.git] / sphinx / index.rst
index 424e135a9beb986b5ffb2b18be6a6901ae69f44f..55494d264a6cfbf0458c238ede447ef9497454af 100644 (file)
@@ -7,7 +7,7 @@
 NeuroDebian provides a large collection of popular neuroscience research
 software for the Debian_ operating system as well as Ubuntu_ and other
 derivatives. Popular packages include FSL, Freesurfer, AFNI, PyMVPA and
-:ref:`many others <pkglists>`. While we do strive to maintain a high level of
+:ref:`many others <pkg_tocs>`. While we do strive to maintain a high level of
 quality, we make no guarantee that a given package works as expected, so use
 them at your own risk. If you do encounter problems or would just like to thank
 us, simply `send us an email <#contacts>`_.
@@ -43,17 +43,40 @@ Learn more about NeuroDebian, the goals of this project, and help us |spread|!
 Get NeuroDebian
 ===============
 
-Choose on which operating system you want to run NeuroDebian, and select a
+First select what kind of operating system you are using, and then choose a
 download server close to you:
 
 .. include:: sources_lists
 
 .. raw:: html
 
-  <div id="reposetup" style="display:none">
-
-To enable NeuroDebian on your system, simply copy and paste the following
-commands into a terminal window:
+  <div class="nojavascriptinstructions">
+  This form requires javascript. If disabled, incomplete instructions are
+  displayed below</div>
+  <div id="repoconfig">
+  <div class="nojavascriptinstructions">
+  Instructions for Debian-derived systems
+  </div>
+  <p>Select desired components:<br />
+  <table><tr>
+  <td><input type="radio" name="components" value="libre"></td>
+  <td><strong>only</strong> software with guaranteed freedoms<br />
+    <span style=font-size:75%>all packages are
+    <a href="http://www.debian.org/social_contract#guidelines">DSFG</a>-compliant,
+    with permission to use, modify, re-distribute under any condition</span></td></tr>
+  <tr><td><input type="radio" name="components" value="full"></td>
+  <td>all software<br />
+    <span style=font-size:75%>
+    individual packages may have restrictive licenses and you are required to
+    check license-compliance manually
+    </span></td></tr>
+  </table>
+  <div id="reposetup">
+
+You can enable NeuroDebian on your system by simply copying and pasting the
+following two commands into a terminal window. This will add the NeuroDebian
+repository to your native package management system, and you will be able to
+install neuroscience software the same way as any other package.
 
 .. raw:: html
 
@@ -61,13 +84,15 @@ commands into a terminal window:
   After selecting a release the setup code will be shown here.
   </pre>
 
-Once this is done, you have to update the package index and you are ready to
-install packages. Use your favorite package manager, e.g. synaptic, adept. In
-the terminal you can use :command:`apt-get`::
+Now you can update the package index and you are ready to install packages.
+Of course you can use your favorite package manager (e.g. synaptic, adept)
+for this. In the terminal you can use :command:`apt-get`::
 
   sudo apt-get update
   sudo apt-get install mricron
 
+You are ready to go -- enjoy NeuroDebian!
+
 .. note::
 
   Not every package is available for all distributions/releases. For information
@@ -77,16 +102,21 @@ the terminal you can use :command:`apt-get`::
 .. raw:: html
 
   </div> <!-- end reposetup -->
+  </div> <!-- end repoconfig -->
 
-  <div id="vmsetup" style="display:none">
+  <div id="vmsetup">
+  <div class="nojavascriptinstructions">
+  Instructions for non-Debian systems
+  </div>
 
-For all non-Debian operating systems the recommended way to deploy NeuroDebian
-is a `virtual appliance`_. On all modern hardware (built within the last 3-4
-years) a virtual appliance is a convenient solution to run NeuroDebian
-simultaneously with the primary operating system -- without noticable
-performance loss.
+For all non-Debian operating systems we recommend to deploy NeuroDebian as a
+`virtual appliance`_ (virtual machine) -- this will only take a few minutes.
+On all modern hardware (built within
+the last 3-4 years) a virtual appliance is a convenient solution to run
+NeuroDebian simultaneously with the primary operating system -- without
+noticeable performance loss. To start using NeuroDebian:
 
-1. Install NeuroDebian by first downloading this image file:
+1. Download this image file:
 
 .. raw:: html
 
@@ -94,14 +124,19 @@ performance loss.
   <a href="http://neuro.debian.net/debian/vm/">NeuroDebian images</a>
   </div>
 
-2. Once downloaded, import this image into your VirtualBox_ installation. If you
-   do not have VirtualBox_ installed yet, visit the `VirtualBox download page
-   <http://www.virtualbox.org/wiki/Downloads>`_ that provides installers for
-   Windows, Linux, Mac and Solaris.
+2. Import this image into VirtualBox_. If you do not have VirtualBox_
+   installed yet, visit the `VirtualBox download page
+   <http://www.virtualbox.org/wiki/Downloads>`_ and get an installer for your
+   system (installers for Windows, Linux, Mac and Solaris are available).
+
+3. Finish the configuration by following :ref:`the instructions on setting up
+   the virtual appliance <chap_vm>`. `[Virtual machine
+   setup video tutorial] <http://www.youtube.com/watch?v=eqfjKV5XaTE>`_
+
 
-3. Please read :ref:`the detailed instructions on setting up the virtual
-   appliance <chap_vm>` to complete the configuration of your NeuroDebian
-   environment.
+
+
+You are ready to go -- enjoy NeuroDebian!
 
 .. note::
 
@@ -139,6 +174,9 @@ News
                                     limit: 10,
                                     rate: 300000});
  </script>
+ <div class="nojavascriptinstructions">
+ The news widget requires javascript
+ </div>
 
 .. _identi.ca: http://identi.ca/neurodebian
 .. _twitter: http://twitter.com/NeuroDebian
@@ -161,8 +199,8 @@ News
 .. start a new list
 
 * **Services**
-* :ref:`Software <pkglists>`
-* :ref:`Data <pkgs-by_purpose-neuroscience_datasets>`
+* :ref:`Software <pkg_tocs>`
+* :ref:`Data <toc_pkgs_for_suite_data>`
 * :ref:`Appliance <chap_vm>`
 
 .. start a new list
@@ -204,18 +242,30 @@ News
    projects
    testimonials
    testimonials-topics
+   vm_welcome
+   derivatives
+
+.. are these supposed to be visible?
+.. toctree::
+   :hidden:
+
+   machines
+   todo
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   pkgs/*
+   pkglists/*
 
 .. probably should be purged altogether
 .. toctree::
    :hidden:
 
-   booth_sfn2010
-   datasets
    livecd
    quotes-nihr01
    quotes-nitrc
-   sources_lists
-   vm_welcome
    dump
 
 .. include:: link_names.txt
@@ -277,52 +327,51 @@ News
 
   };
 
-  function createrepourl(rel, mir) {
-    if(rel in rel2name && mir in mirrors) {
-
-        var retrepo = "wget -O- http://neuro.debian.net/lists/" + rel2name[rel] + "."
-         + mir + " | sudo tee /etc/apt/sources.list.d/neurodebian.sources.list\n"
+  function createrepourl(rel, mir, comp) {
+    if(mir in mirrors) {
+        var retrepo = "wget -O- http://neuro.debian.net/lists/" + rel + "."
+         + mir + "." + comp + " | sudo tee /etc/apt/sources.list.d/neurodebian.sources.list\n"
          + "sudo apt-key adv --recv-keys --keyserver pgp.mit.edu 2649A5A9\n";
         return retrepo;
     }
 
   };
-  function updateout(rel, mir) {
+
+  function update_by_form() {
+     var rel = $("#release").val();
+     var mir = $("#mirror").val();
+     var comp = $('input[name="components"]:checked').val();
      if (rel != '' && mir != '') {
         if (rel in {'win32':'', 'win64':'', 'mac':''}) {
             $('#vmimagedownload').html(createvmdownload(rel, mir));
             $('#vmsetup').slideDown();
-            $('#reposetup').slideUp();
+            $('#repoconfig').slideUp();
         } else {
-            $('#code').text(createrepourl(rel, mir));
-            $('#reposetup').slideDown();
             $('#vmsetup').slideUp();
+            $('#repoconfig').slideDown();
+            if (comp == undefined) {
+              $('#reposetup').slideUp();
+            } else {
+              $('#code').text(createrepourl(rel, mir, comp));
+              $('#reposetup').slideDown();
+            }
         };
      }
      else
      {
-        $('#reposetup').slideUp();
+        $('#repoconfig').slideUp();
         $('#vmsetup').slideUp();
      };
   };
-   $('#release').change(function() {
-     var singleValues = $("#release").val();
-     var mirrorVal = $("#mirror").val();
-     updateout(singleValues, mirrorVal);
-   });
-   $('#mirror').change(function() {
-     var singleValues = $("#release").val();
-     var mirrorVal = $("#mirror").val();
-     updateout(singleValues, mirrorVal);
-   });
 
   $(document).ready(function($) {
-     updateout($("#release").val(), $("#mirror").val());
+     update_by_form();
+     $('#repoconfig').hide()
+     $('#reposetup').hide();
+     $('#vmsetup').hide()
+     $('#release').change(update_by_form);
+     $('#mirror').change(update_by_form);
+     $('input[name=components]:radio').change(update_by_form);
   });
 
-  foldbuttontoggle('morepublications');
-
-
   </script>
-
-