about summary refs log tree commit diff
path: root/uploader/templates/macro-csv-fields.html
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2026-09-14 14:27:57 -0500
committerFrederick Muriuki Muriithi2026-09-14 14:58:37 -0500
commit56aeafa7a3cb23fb9befd999f95a74d5ed15c7b6 (patch)
tree1835a597bbd7e06961efd79546f2933c4391e8cc /uploader/templates/macro-csv-fields.html
parent0e857e973a1d41499d26f23312e050f7e5088ffa (diff)
downloadgn-uploader-main.tar.gz
Implement basic UI for "Add Genotypes Records" feature. HEAD main
Diffstat (limited to 'uploader/templates/macro-csv-fields.html')
-rw-r--r--uploader/templates/macro-csv-fields.html102
1 files changed, 102 insertions, 0 deletions
diff --git a/uploader/templates/macro-csv-fields.html b/uploader/templates/macro-csv-fields.html
new file mode 100644
index 0000000..d4b0f57
--- /dev/null
+++ b/uploader/templates/macro-csv-fields.html
@@ -0,0 +1,102 @@
+{%macro display_csv_fields()%}
+<div class="form-group">
+  <label for="txt-file-separator" class="form-label">File Separator</label>
+  <div class="input-group">
+    <input id="txt-file-separator"
+           name="file-separator"
+           type="text"
+           value="&#9;"
+           class="form-control"
+           maxlength="1" />
+    <span class="input-group-btn">
+      <button id="btn-reset-file-separator" class="btn btn-info">Reset Default</button>
+    </span>
+  </div>
+  <span class="form-text text-muted">
+    Provide the character that separates the fields in your file(s). It should
+    be the same character for all files (if more than one is provided).<br />
+    A tab character will be assumed if you leave this field blank. See
+    <a href="#docs-file-separator"
+       title="Documentation for file-separator characters">
+      documentation for more information</a>.
+  </span>
+</div>
+
+<div class="form-group">
+  <label for="txt-file-comment-character" class="form-label">File Comment-Characters</label>
+  <div class="input-group">
+    <input id="txt-file-comment-character"
+           name="file-comment-character"
+           type="text"
+           value="#"
+           class="form-control" />
+    <span class="input-group-btn">
+      <button id="btn-reset-file-comment-character" class="btn btn-info">
+        Reset Default</button>
+    </span>
+  </div>
+  <span class="form-text text-muted">
+    This specifies that lines that begin with the character(s) provided will be
+    considered comment lines and ignored in their entirety. See
+    <a href="#docs-file-comment-character"
+       title="Documentation for comment characters">
+      documentation for more information</a>.
+  </span>
+</div>
+
+<div class="form-group">
+  <label for="txt-file-na" class="form-label">File "No-Value" Indicators</label>
+  <div class="input-group">
+    <input id="txt-file-na"
+           name="file-na"
+           type="text"
+           value="- NA N/A"
+           class="form-control" />
+    <span class="input-group-btn">
+      <button id="btn-reset-file-na" class="btn btn-info">Reset Default</button>
+    </span>
+  </div>
+  <span class="form-text text-muted">
+    This specifies strings in your file indicate that there is no value for a
+    particular cell (a cell is where a column and row intersect). Provide a
+    space-separated list of strings if you have more than one way of
+    indicating no values. See
+    <a href="#docs-file-na" title="Documentation for no-value fields">
+      documentation for more information</a>.</span>
+</div>
+{%endmacro%}
+
+
+{%macro display_csv_fields_documentation()%}
+<dl>
+  <dt id="docs-file-separator">File separator</dt>
+  <dd>The files you provide should be character-separated value (CSV) files.
+    We need to know what character you used to separate the values in your
+    file. Some common ones are the Tab character, the comma, etc.<br />
+    Providing that information makes it possible for the system to parse and
+    process your files correctly.<br>
+    <strong>NOTE:</strong> All the files you upload MUST use the same
+    separator.</dd>
+
+  <dt id="docs-file-comment-character">Comment characters</dt>
+  <dd>We support use of comment lines in your files. We only support one type
+    of comment style, the <em>line comment</em>.<br />
+    This mean the comment begins at the start of the line, and the end of that
+    line indicates the end of that comment. If you have a really long comment,
+    then you need to break it across multiple lines, marking each line a
+    comment line.<br />
+    The "comment character" is the character at the start of the line that
+    indicates that the line is a line comment.<br />
+    You can provide more than one comment character, separated by spaces.</dd>
+
+  <dt id="docs-file-na">No-Value indicator(s)</dt>
+  <dd>Data in the real world is messy, and in some cases, entirely absent. You
+    need to indicate, in your files, that a particular field did not have a
+    value, and once you do that, you then need to let the system know how you
+    mark such fields. Common ways of indicating "empty values" are, leaving
+    the field blank, using a character such as '-', or using strings like
+    "NA", "N/A", "NULL", etc.<br />
+    Providing this information will help with parsing and processing such
+    no-value fields the correct way.</dd>
+</dl>
+{%endmacro%}