nci-create-assignment.1

   1 .Dd 2016-06-12
   2 .Dt NCI-CREATE-ASSIGNMENT 1
   3 .Os
   4 .Sh NAME
   5 .Nm nci-create-assignment
   6 .Nd Create a new assignment in a Canvas installation
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Fl c
  10 .Ar course-id
  11 .Fl n
  12 .Ar name
  13 .Fl m
  14 .Ar max-points
  15 .Oo
  16 .Fl d
  17 .Ar due-date
  18 .Oc
  19 .Oo
  20 .Fl g
  21 .Ar group-id
  22 .Oc
  23 .Sh DESCRIPTION
  24 .Nm
  25 connects to a Canvas installation as described at
  26 .Xr nci 1
  27 and creates an assignment with the given parameters. If successful,
  28 the id of the created assignment will be printed.
  29 .Pp
  30 Canvas supports many, many options for assignments. This program
  31 always uses the following options:
  32 .Pp
  33 .Bl -bullet -compact
  34 .It
  35 .Em submission_type
  36 is
  37 .Em Dq on_paper ,
  38 .It
  39 .Em grading_type
  40 is
  41 .Em Dq points ,
  42 .It
  43 the assignment will not be a group assignment,
  44 .It
  45 the assignment is not
  46 .Em locked ,
  47 .Em muted ,
  48 or a
  49 .Em draft ,
  50 .It
  51 .Em notify_of_update
  52 is
  53 .Em false
  54 .Pq no notifications about creation of this assignment will be sent .
  55 .El
  56 .Sh OPTIONS
  57 .Bl -tag -width Ds
  58 .It Fl c
  59 The
  60 .Ar course-id ,
  61 as returned by
  62 .Xr nci-list-courses 1 .
  63 .It Fl n
  64 Set the name of the new assignment.
  65 .It Fl m
  66 Set the maximum points
  67 .Pq floating point allowed
  68 for this assignment, although when entering grades, numbers above this
  69 value can be entered, representing extra credit.
  70 .It Fl d
  71 Set the date
  72 .Pq which must be in ISO 8601 format
  73 at which this assignment will be shown as due.
  74 .It Fl g
  75 Set the assignment group to which this assignment is associated. If
  76 not specified, Canvas will pick a group.
  77 .El
  78 .Sh EXAMPLES
  79 .Dl % nci-create-assignment -c 1187637 -g 1560872 -n "HW 01" -m 10 -d 2020-09-04T12:00:00
  80 .Dl 400395381
  81 .Sh SEE ALSO
  82 .Xr nci 1
  83 .Xr nci-list-courses 1
  84 .Sh AUTHORS
  85 .An S. Gilles Aq Mt sgilles@math.umd.edu