Scheduled service maintenance on November 22


On Friday, November 22, 2024, between 06:00 CET and 18:00 CET, GIN services will undergo planned maintenance. Extended service interruptions should be expected. We will try to keep downtimes to a minimum, but recommend that users avoid critical tasks, large data uploads, or DOI requests during this time.

We apologize for any inconvenience.

web-interface.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  1. <!DOCTYPE html>
  2. <html lang="" xml:lang="">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  6. <title>3 Web interface | dealing with gin</title>
  7. <meta name="description" content="3 Web interface | dealing with gin" />
  8. <meta name="generator" content="bookdown 0.17 and GitBook 2.6.7" />
  9. <meta property="og:title" content="3 Web interface | dealing with gin" />
  10. <meta property="og:type" content="book" />
  11. <meta name="twitter:card" content="summary" />
  12. <meta name="twitter:title" content="3 Web interface | dealing with gin" />
  13. <meta name="viewport" content="width=device-width, initial-scale=1" />
  14. <meta name="apple-mobile-web-app-capable" content="yes" />
  15. <meta name="apple-mobile-web-app-status-bar-style" content="black" />
  16. <link rel="prev" href="intro.html"/>
  17. <link rel="next" href="using-application-made-for-git.html"/>
  18. <script src="libs/jquery-2.2.3/jquery.min.js"></script>
  19. <link href="libs/gitbook-2.6.7/css/style.css" rel="stylesheet" />
  20. <link href="libs/gitbook-2.6.7/css/plugin-table.css" rel="stylesheet" />
  21. <link href="libs/gitbook-2.6.7/css/plugin-bookdown.css" rel="stylesheet" />
  22. <link href="libs/gitbook-2.6.7/css/plugin-highlight.css" rel="stylesheet" />
  23. <link href="libs/gitbook-2.6.7/css/plugin-search.css" rel="stylesheet" />
  24. <link href="libs/gitbook-2.6.7/css/plugin-fontsettings.css" rel="stylesheet" />
  25. <link href="libs/gitbook-2.6.7/css/plugin-clipboard.css" rel="stylesheet" />
  26. </head>
  27. <body>
  28. <div class="book without-animation with-summary font-size-2 font-family-1" data-basepath=".">
  29. <div class="book-summary">
  30. <nav role="navigation">
  31. <ul class="summary">
  32. <li class="chapter" data-level="1" data-path="index.html"><a href="index.html"><i class="fa fa-check"></i><b>1</b> Dealing with Gin</a></li>
  33. <li class="chapter" data-level="2" data-path="intro.html"><a href="intro.html"><i class="fa fa-check"></i><b>2</b> Intro</a><ul>
  34. <li class="chapter" data-level="2.1" data-path="intro.html"><a href="intro.html#play-with-sandbox"><i class="fa fa-check"></i><b>2.1</b> Play with Sandbox</a></li>
  35. </ul></li>
  36. <li class="chapter" data-level="3" data-path="web-interface.html"><a href="web-interface.html"><i class="fa fa-check"></i><b>3</b> Web interface</a><ul>
  37. <li class="chapter" data-level="3.1" data-path="web-interface.html"><a href="web-interface.html#cannot-see-a-repository"><i class="fa fa-check"></i><b>3.1</b> Cannot see a repository?</a><ul>
  38. <li class="chapter" data-level="3.1.1" data-path="web-interface.html"><a href="web-interface.html#sign-in-to-gin"><i class="fa fa-check"></i><b>3.1.1</b> Sign in to Gin</a></li>
  39. <li class="chapter" data-level="3.1.2" data-path="web-interface.html"><a href="web-interface.html#check-that-the-repository-exists"><i class="fa fa-check"></i><b>3.1.2</b> Check that the repository exists</a></li>
  40. <li class="chapter" data-level="3.1.3" data-path="web-interface.html"><a href="web-interface.html#make-sure-you-have-access-to-the-repository"><i class="fa fa-check"></i><b>3.1.3</b> Make sure you have access to the repository</a></li>
  41. </ul></li>
  42. <li class="chapter" data-level="3.2" data-path="web-interface.html"><a href="web-interface.html#dashboard-how-to-use"><i class="fa fa-check"></i><b>3.2</b> Dashboard: how to use</a><ul>
  43. <li class="chapter" data-level="3.2.1" data-path="web-interface.html"><a href="web-interface.html#activity"><i class="fa fa-check"></i><b>3.2.1</b> Activity</a></li>
  44. <li class="chapter" data-level="3.2.2" data-path="web-interface.html"><a href="web-interface.html#collaborative-repositories"><i class="fa fa-check"></i><b>3.2.2</b> Collaborative repositories</a></li>
  45. <li class="chapter" data-level="3.2.3" data-path="web-interface.html"><a href="web-interface.html#private-repositories"><i class="fa fa-check"></i><b>3.2.3</b> Private repositories</a></li>
  46. </ul></li>
  47. <li class="chapter" data-level="3.3" data-path="web-interface.html"><a href="web-interface.html#browsing-a-repository"><i class="fa fa-check"></i><b>3.3</b> Browsing a repository</a><ul>
  48. <li class="chapter" data-level="3.3.1" data-path="web-interface.html"><a href="web-interface.html#overview-of-the-repository"><i class="fa fa-check"></i><b>3.3.1</b> Overview of the repository</a></li>
  49. <li class="chapter" data-level="3.3.2" data-path="web-interface.html"><a href="web-interface.html#browsing-files"><i class="fa fa-check"></i><b>3.3.2</b> Browsing files</a></li>
  50. </ul></li>
  51. <li class="chapter" data-level="3.4" data-path="web-interface.html"><a href="web-interface.html#downloading-files"><i class="fa fa-check"></i><b>3.4</b> Downloading files</a><ul>
  52. <li class="chapter" data-level="3.4.1" data-path="web-interface.html"><a href="web-interface.html#download-button"><i class="fa fa-check"></i><b>3.4.1</b> Download button</a></li>
  53. </ul></li>
  54. <li class="chapter" data-level="3.5" data-path="web-interface.html"><a href="web-interface.html#uploading-files"><i class="fa fa-check"></i><b>3.5</b> Uploading files</a><ul>
  55. <li class="chapter" data-level="3.5.1" data-path="web-interface.html"><a href="web-interface.html#location-of-the-buttons"><i class="fa fa-check"></i><b>3.5.1</b> Location of the buttons</a></li>
  56. <li class="chapter" data-level="3.5.2" data-path="web-interface.html"><a href="web-interface.html#common-features-for-file-upload"><i class="fa fa-check"></i><b>3.5.2</b> Common features for file-upload</a></li>
  57. <li class="chapter" data-level="3.5.3" data-path="web-interface.html"><a href="web-interface.html#uploading-a-set-of-files"><i class="fa fa-check"></i><b>3.5.3</b> Uploading a set of files</a></li>
  58. <li class="chapter" data-level="3.5.4" data-path="web-interface.html"><a href="web-interface.html#create-a-new-text-file"><i class="fa fa-check"></i><b>3.5.4</b> Create a new (text) file</a></li>
  59. <li class="chapter" data-level="3.5.5" data-path="web-interface.html"><a href="web-interface.html#edit-a-text-file"><i class="fa fa-check"></i><b>3.5.5</b> Edit a (text) file</a></li>
  60. </ul></li>
  61. </ul></li>
  62. <li class="chapter" data-level="4" data-path="using-application-made-for-git.html"><a href="using-application-made-for-git.html"><i class="fa fa-check"></i><b>4</b> Using application made for git</a><ul>
  63. <li class="chapter" data-level="4.1" data-path="using-application-made-for-git.html"><a href="using-application-made-for-git.html#generalities"><i class="fa fa-check"></i><b>4.1</b> generalities</a></li>
  64. <li class="chapter" data-level="4.2" data-path="using-application-made-for-git.html"><a href="using-application-made-for-git.html#git-gui"><i class="fa fa-check"></i><b>4.2</b> Git GUI</a></li>
  65. <li class="chapter" data-level="4.3" data-path="using-application-made-for-git.html"><a href="using-application-made-for-git.html#using-rstudio-with-gin"><i class="fa fa-check"></i><b>4.3</b> Using Rstudio with GIN</a></li>
  66. </ul></li>
  67. </ul>
  68. </nav>
  69. </div>
  70. <div class="book-body">
  71. <div class="body-inner">
  72. <div class="book-header" role="navigation">
  73. <h1>
  74. <i class="fa fa-circle-o-notch fa-spin"></i><a href="./">dealing with gin</a>
  75. </h1>
  76. </div>
  77. <div class="page-wrapper" tabindex="-1" role="main">
  78. <div class="page-inner">
  79. <section class="normal" id="section-">
  80. <div id="web-interface" class="section level1">
  81. <h1><span class="header-section-number">3</span> Web interface</h1>
  82. <div id="cannot-see-a-repository" class="section level2">
  83. <h2><span class="header-section-number">3.1</span> Cannot see a repository?</h2>
  84. <p>So often, you try to visit a repository, and find something like below:</p>
  85. <div class="figure">
  86. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/norepository.png" alt="404 page" />
  87. <p class="caption">404 page</p>
  88. </div>
  89. <p>The solutions are:</p>
  90. <ol style="list-style-type: decimal">
  91. <li>Sign in to Gin</li>
  92. <li>Check that the repository exists</li>
  93. <li>Make sure you have access to the repository</li>
  94. </ol>
  95. <div id="sign-in-to-gin" class="section level3">
  96. <h3><span class="header-section-number">3.1.1</span> Sign in to Gin</h3>
  97. <p>It happens when you are not signed in to Gin.</p>
  98. <p>Click on the “Sign in” button at the top-right corner of the page:</p>
  99. <div class="figure">
  100. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/signin.png" alt="Sign-in button" />
  101. <p class="caption">Sign-in button</p>
  102. </div>
  103. <p>(If you have not yet got registered to Gin, then do it first from the “Register” button on the right.</p>
  104. </div>
  105. <div id="check-that-the-repository-exists" class="section level3">
  106. <h3><span class="header-section-number">3.1.2</span> Check that the repository exists</h3>
  107. <p>If the situation persists, go visit your <a href="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/Dashboard.md">dashboard</a>,
  108. and find the name of the repository from the list.
  109. If you click on it, the repository page should show up.</p>
  110. </div>
  111. <div id="make-sure-you-have-access-to-the-repository" class="section level3">
  112. <h3><span class="header-section-number">3.1.3</span> Make sure you have access to the repository</h3>
  113. <p>If you don’t find the repository in your dashboard, then
  114. it is possible that you don’t have access to the repository at all.</p>
  115. <p>Ask somebody who has access rights to the repository <a href="collaboration.md">for adding you as a Collaborator</a>.</p>
  116. </div>
  117. </div>
  118. <div id="dashboard-how-to-use" class="section level2">
  119. <h2><span class="header-section-number">3.2</span> Dashboard: how to use</h2>
  120. <p>When you simply sign in to Gin, without selecting any specific repository,
  121. you fill find a page like below (note that this is just an example):</p>
  122. <div class="figure">
  123. <img src="images/dashboard.png" alt="Dashboard overview" />
  124. <p class="caption">Dashboard overview</p>
  125. </div>
  126. <p>This is called the “dashboard”, and here you can see most of your activity on Gin.</p>
  127. <p>The dashboard may be divided into several areas:</p>
  128. <ol style="list-style-type: decimal">
  129. <li><a href="web-interface.html#activity"><strong>Activity</strong></a> area: shows what you did with your repositories</li>
  130. <li><a href="web-interface.html#collaborative-repositories"><strong>Collaborative repository</strong></a> area: lists up the shared repositories you have access to</li>
  131. <li><a href="web-interface.html#private-repositories"><strong>Private repository</strong></a> area: lists up your <em>own</em> repositories</li>
  132. </ol>
  133. <div id="activity" class="section level3">
  134. <h3><span class="header-section-number">3.2.1</span> Activity</h3>
  135. <div class="figure">
  136. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/activity-area.png" alt="Activity area" />
  137. <p class="caption">Activity area</p>
  138. </div>
  139. <p>This shows your recent activity on Gin, e.g.</p>
  140. <ul>
  141. <li>your recent commits to your repositories</li>
  142. <li>issues and comments reported to your repositories</li>
  143. </ul>
  144. </div>
  145. <div id="collaborative-repositories" class="section level3">
  146. <h3><span class="header-section-number">3.2.2</span> Collaborative repositories</h3>
  147. <div class="figure">
  148. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/collaboration-area.png" alt="Collaborative repository area" />
  149. <p class="caption">Collaborative repository area</p>
  150. </div>
  151. <p>This area lists up the repositories <strong>owned by others</strong> and those you have access to.</p>
  152. <p>Normally, most of your repositories will show up here, as they are owned and managed by <span class="citation">@larkumlab</span>.</p>
  153. </div>
  154. <div id="private-repositories" class="section level3">
  155. <h3><span class="header-section-number">3.2.3</span> Private repositories</h3>
  156. <div class="figure">
  157. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/private-repositories.png" alt="Private repository area" />
  158. <p class="caption">Private repository area</p>
  159. </div>
  160. <p>This area lists up the repositories owned by yourself.</p>
  161. <p>In many cases, these are visible only to you unless you add a <a href="collaboration.md">Collaborator</a> to one of them.</p>
  162. </div>
  163. </div>
  164. <div id="browsing-a-repository" class="section level2">
  165. <h2><span class="header-section-number">3.3</span> Browsing a repository</h2>
  166. <p>If you visit the repository page, it looks like below:</p>
  167. <div class="figure">
  168. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/repository-top.png" alt="A typical repository page" />
  169. <p class="caption">A typical repository page</p>
  170. </div>
  171. <p>From here, you can browse what is in the repository including:</p>
  172. <ol style="list-style-type: decimal">
  173. <li><a href="web-interface.html#overview-of-the-repository">overview of the repository</a></li>
  174. <li><a href="web-interface.html#browsing-files">file contents</a></li>
  175. </ol>
  176. <div id="overview-of-the-repository" class="section level3">
  177. <h3><span class="header-section-number">3.3.1</span> Overview of the repository</h3>
  178. <p>On top of the page, you will find the header consisting of <code>&lt;owner name&gt;/&lt;repository name&gt;</code>:</p>
  179. <div class="figure">
  180. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/repository-title.png" alt="Repository name" />
  181. <p class="caption">Repository name</p>
  182. </div>
  183. <p>This represents the <em>identifier</em> of the repository so that
  184. you can specify a single repository inside <code>https://gin.g-node.org</code>.</p>
  185. <p>Down to the bottom, you may find some document:</p>
  186. <div class="figure">
  187. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/readme.png" alt="README file" />
  188. <p class="caption">README file</p>
  189. </div>
  190. <p>This represents the (hopefully) detailed description of the repository about what it is
  191. or what it contains.</p>
  192. <blockquote>
  193. <p>In fact, this description comes from the <code>README.md</code> file in the root directory of the repository.
  194. The name of the file comes from a tradition of programmers community to contain the “read-me-first”
  195. file in the top directory of any code.</p>
  196. <p>You can add or edit it by adding / editing the <code>README.md</code> file.</p>
  197. <p>Even inside the sub-directories of the repositories, the description will automatically show up
  198. if you add and edit a <code>README.md</code> file in it.</p>
  199. </blockquote>
  200. </div>
  201. <div id="browsing-files" class="section level3">
  202. <h3><span class="header-section-number">3.3.2</span> Browsing files</h3>
  203. <p>In the middle, you can find a list of files and directories in the repository:</p>
  204. <div class="figure">
  205. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/files.png" alt="File list" />
  206. <p class="caption">File list</p>
  207. </div>
  208. <p>By clicking on individual file/directory entry, you can browse its contents.</p>
  209. <p>For example, you can see the contents of a sub-directory by clicking on it:</p>
  210. <div class="figure">
  211. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/directory-view.png" alt="Directory view" />
  212. <p class="caption">Directory view</p>
  213. </div>
  214. <p>Contents of normal files may be visible, as long as your browser supports it.</p>
  215. <ul>
  216. <li><p>For example, you can browse to <a href="images/dashboard.png">web-interface/images/dashboard.png</a>,
  217. and you can have a glimpse of the original image file:
  218. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/image-view.png" alt="Image-file view" /></p></li>
  219. <li><p>If you write the documents in the <a href="https://www.markdownguide.org/getting-started">Markdown</a> format
  220. (and I recommend to do so whenever possible), you can see the formatted-view of the document:
  221. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/markdown-view.png" alt="Markdown view" /></p></li>
  222. <li>Other text-based files (CSV, TSV etc.) may be seen in its raw format.</li>
  223. <li><p>Binary files (Excel, Word, Spike2 etc.) will not be visible, so you must <a href="downloading.md">download it</a> to see the contents.</p></li>
  224. </ul>
  225. <div id="a-small-side-note" class="section level4">
  226. <h4><span class="header-section-number">3.3.2.1</span> A small side note</h4>
  227. <p>On the left columns of the files list, you can see some information like below:</p>
  228. <div class="figure">
  229. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/commit-description.png" alt="Commit description" />
  230. <p class="caption">Commit description</p>
  231. </div>
  232. <p>Sadly <strong>it is <em>not</em> about the description to the file itself</strong> but describes the commit
  233. that updated this file most recently.</p>
  234. <p>In the case of the image above, the directory “web-interface” was updated by the commit
  235. with the commit ID being <code>b42b7633f7</code>, and with the commit message <code>update dashboard.md</code>.</p>
  236. </div>
  237. </div>
  238. </div>
  239. <div id="downloading-files" class="section level2">
  240. <h2><span class="header-section-number">3.4</span> Downloading files</h2>
  241. <p>Although the files may be browsable on the web interface, you might want to interact with them on your desktop, using one of your favorite programs.</p>
  242. <p>It is possible to download files individually from the web interface.</p>
  243. <blockquote>
  244. <p>Note that this “individual download” feature differs from what Git-people call “cloning of the repository”. Git-clone involves downloading of the whole repository, whereas this individual download concerns only with the current single file.</p>
  245. </blockquote>
  246. <div id="download-button" class="section level3">
  247. <h3><span class="header-section-number">3.4.1</span> Download button</h3>
  248. <p>When you open a single file, you will see buttons on the top-right of the file:</p>
  249. <div class="figure">
  250. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/file-actions.png" alt="Location of buttons" />
  251. <p class="caption">Location of buttons</p>
  252. </div>
  253. <p>These buttons represent the actions that you can execute on this specific file, including:</p>
  254. <ul>
  255. <li>Obtaining the link to this specific version of the file (<strong>Permalink</strong>)</li>
  256. <li>Browsing different versions of this file (<strong>History</strong>)</li>
  257. <li>Downloading the file (<strong>Download</strong>)</li>
  258. <li>Editing the file (<strong>the pencil symbol</strong>; it may not be available in the case of read-only repositories, or Gin does not have a way to edit the file e.g. PDF)</li>
  259. <li>Deleting the file from the repository (<strong>the trash-can simbol</strong>; may not be available)</li>
  260. </ul>
  261. <p>For downloading the file, click on the “download” button:</p>
  262. <div class="figure">
  263. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/download-button.png" alt="Download button" />
  264. <p class="caption">Download button</p>
  265. </div>
  266. <p>Then your browser will start downloading the file.</p>
  267. </div>
  268. </div>
  269. <div id="uploading-files" class="section level2">
  270. <h2><span class="header-section-number">3.5</span> Uploading files</h2>
  271. <p>The Gin web-interface allows you to:</p>
  272. <ul>
  273. <li><a href="web-interface.html#create-a-new-text-file">create</a> a new text-based file,</li>
  274. <li><a href="web-interface.html#edit-a-text-file">edit</a> a text-based file, or</li>
  275. <li><a href="web-interface.html#uploading-a-set-of-files">upload</a> a new set of files.</li>
  276. </ul>
  277. <p>All of the above procedures share some features in common:</p>
  278. <ul>
  279. <li>You can start both of the procedures easily by <a href="web-interface.html#location-of-the-buttons">a click of a button</a>.</li>
  280. <li>You can <a href="web-interface.html#specifying-the-directory-to-be-uploaded">specify the sub-directory in the repository</a> for the file(s) to be uploaded.</li>
  281. <li>You can <a href="web-interface.html#committing-new-files">specify the commit options</a>.</li>
  282. </ul>
  283. <div id="location-of-the-buttons" class="section level3">
  284. <h3><span class="header-section-number">3.5.1</span> Location of the buttons</h3>
  285. <p>When the web interface shows a list of files in a repository, you can see blue buttons in the middle, above the file list.</p>
  286. <blockquote>
  287. <p>Note that, if you don’t have the “write” permission to the repository, these buttons will not appear. If you still want to create or upload files, contact the person responsible for the repository to <a href="collaboration.md">add you as a Collaborator</a>.</p>
  288. </blockquote>
  289. <div class="figure">
  290. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/upload-actions.png" alt="Where you can find the buttons for file-creation / upload" />
  291. <p class="caption">Where you can find the buttons for file-creation / upload</p>
  292. </div>
  293. <p>There, you have two types of buttons:</p>
  294. <ul>
  295. <li><strong><a href="web-interface.html#uploading-a-set-of-files">“Upload file” button</a></strong>: used to upload a set of files.</li>
  296. <li><strong><a href="#create-new-files">“New file” button</a></strong>: used to create a new file in the repository.</li>
  297. </ul>
  298. <div class="figure">
  299. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/upload-actions-buttons.png" alt="Two buttons for new files" />
  300. <p class="caption">Two buttons for new files</p>
  301. </div>
  302. </div>
  303. <div id="common-features-for-file-upload" class="section level3">
  304. <h3><span class="header-section-number">3.5.2</span> Common features for file-upload</h3>
  305. <p>No matter which button you use, there are some features shared in common.</p>
  306. <div id="specifying-the-directory-to-be-uploaded" class="section level4">
  307. <h4><span class="header-section-number">3.5.2.1</span> Specifying the directory to be uploaded</h4>
  308. <p>On top of the view, an empty text field will show up:</p>
  309. <div class="figure">
  310. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/directory-selector-empty.png" alt="Directory selector" />
  311. <p class="caption">Directory selector</p>
  312. </div>
  313. <p>This is for specifying the directory to upload the file(s).</p>
  314. <p>For instance:</p>
  315. <ul>
  316. <li>Enter the name of the subdirectory (within the repository) in this field:</li>
  317. </ul>
  318. <div class="figure">
  319. <img src="images/directory-selector-subdir.png" alt="A subdirectory is specified" />
  320. <p class="caption">A subdirectory is specified</p>
  321. </div>
  322. <ul>
  323. <li>Gin will automatically create a new directory with the given name (in case it does not exist) as you <a href="web-interface.html#committing-new-files">commit uploads (see the section below)</a>:</li>
  324. </ul>
  325. <div class="figure">
  326. <img src="images/created-subdir.png" alt="Created subdirectory" />
  327. <p class="caption">Created subdirectory</p>
  328. </div>
  329. <ul>
  330. <li>Inside the subdirectory, you will find the uploaded file(s):</li>
  331. </ul>
  332. <div class="figure">
  333. <img src="images/subdir-content.png" alt="The uploaded file in the sub-directory" />
  334. <p class="caption">The uploaded file in the sub-directory</p>
  335. </div>
  336. <p>You can also specify the <em>path</em> to the directory of interest, by connecting a hierarchy of directories by a <code>/</code> (slash):</p>
  337. <p>TODO</p>
  338. </div>
  339. <div id="committing-new-files" class="section level4">
  340. <h4><span class="header-section-number">3.5.2.2</span> Committing new files</h4>
  341. <p>TODO</p>
  342. </div>
  343. </div>
  344. <div id="uploading-a-set-of-files" class="section level3">
  345. <h3><span class="header-section-number">3.5.3</span> Uploading a set of files</h3>
  346. <p>When you click on the “Upload file” button, the file upload view will appear:</p>
  347. <div class="figure">
  348. <img src="images/upload-view.png" alt="File-upload view" />
  349. <p class="caption">File-upload view</p>
  350. </div>
  351. <p>The dotted region in the middle of the page is the <em>upload area</em>:</p>
  352. <div class="figure">
  353. <img src="images/upload-view-upload-area.png" alt="The upload area" />
  354. <p class="caption">The upload area</p>
  355. </div>
  356. <p>You can add the files to be uploaded by either:</p>
  357. <ul>
  358. <li><strong>Clicking on the area</strong>: the file chooser dialog will appear so that you can select files from it.</li>
  359. <li><strong>Drag and drop</strong> individual files or a directory containing a set of files. In the latter case, you can upload the whole directory structure easily.</li>
  360. </ul>
  361. <p>In either case, the upload process will start immediately, and you will see the progress on the area:</p>
  362. <div class="figure">
  363. <img src="https://gin.g-node.org/larkumlab/Dealing_with_Gin/raw/book/web-interface/images/upload-progress.png" alt="Progress of upload" />
  364. <p class="caption">Progress of upload</p>
  365. </div>
  366. <p>You can specify the directory to be uploaded from the <a href="web-interface.html#specifying-the-directory-to-be-uploaded">directory selector (see the section above)</a>.</p>
  367. <p>After completion of the upload processes for all files, you can proceed to finish the <a href="web-interface.html#committing-new-files">commit process (see the section above)</a>.</p>
  368. <blockquote>
  369. <p>Note, by using this upload view, you can only upload 100 files at once, with each file being less than 10 GB in size. If you want to upload more files at once, or upload larger files, you will have to use the command-line interface or WinGIN.</p>
  370. </blockquote>
  371. </div>
  372. <div id="create-a-new-text-file" class="section level3">
  373. <h3><span class="header-section-number">3.5.4</span> Create a new (text) file</h3>
  374. <p>TODO</p>
  375. </div>
  376. <div id="edit-a-text-file" class="section level3">
  377. <h3><span class="header-section-number">3.5.5</span> Edit a (text) file</h3>
  378. <p>TODO</p>
  379. </div>
  380. </div>
  381. </div>
  382. </section>
  383. </div>
  384. </div>
  385. </div>
  386. <a href="intro.html" class="navigation navigation-prev " aria-label="Previous page"><i class="fa fa-angle-left"></i></a>
  387. <a href="using-application-made-for-git.html" class="navigation navigation-next " aria-label="Next page"><i class="fa fa-angle-right"></i></a>
  388. </div>
  389. </div>
  390. <script src="libs/gitbook-2.6.7/js/app.min.js"></script>
  391. <script src="libs/gitbook-2.6.7/js/lunr.js"></script>
  392. <script src="libs/gitbook-2.6.7/js/clipboard.min.js"></script>
  393. <script src="libs/gitbook-2.6.7/js/plugin-search.js"></script>
  394. <script src="libs/gitbook-2.6.7/js/plugin-sharing.js"></script>
  395. <script src="libs/gitbook-2.6.7/js/plugin-fontsettings.js"></script>
  396. <script src="libs/gitbook-2.6.7/js/plugin-bookdown.js"></script>
  397. <script src="libs/gitbook-2.6.7/js/jquery.highlight.js"></script>
  398. <script src="libs/gitbook-2.6.7/js/plugin-clipboard.js"></script>
  399. <script>
  400. gitbook.require(["gitbook"], function(gitbook) {
  401. gitbook.start({
  402. "sharing": {
  403. "github": false,
  404. "facebook": true,
  405. "twitter": true,
  406. "linkedin": false,
  407. "weibo": false,
  408. "instapaper": false,
  409. "vk": false,
  410. "all": ["facebook", "twitter", "linkedin", "weibo", "instapaper"]
  411. },
  412. "fontsettings": {
  413. "theme": "white",
  414. "family": "sans",
  415. "size": 2
  416. },
  417. "edit": {
  418. "link": null,
  419. "text": null
  420. },
  421. "history": {
  422. "link": null,
  423. "text": null
  424. },
  425. "view": {
  426. "link": null,
  427. "text": null
  428. },
  429. "download": null,
  430. "toc": {
  431. "collapse": "subsection"
  432. }
  433. });
  434. });
  435. </script>
  436. </body>
  437. </html>