Show More
@@ -246,6 +246,8 b' Failed execution may show a traceback' | |||
|
246 | 246 | ``pyerr`` renamed to ``error`` |
|
247 | 247 | |
|
248 | 248 | |
|
249 | .. _raw nbconvert cells: | |
|
250 | ||
|
249 | 251 | Raw NBConvert cells |
|
250 | 252 | ------------------- |
|
251 | 253 | |
@@ -274,3 +276,53 b' regardless of format.' | |||
|
274 | 276 | }, |
|
275 | 277 | "source" : ["some nbformat mime-type data"] |
|
276 | 278 | } |
|
279 | ||
|
280 | Metadata | |
|
281 | ======== | |
|
282 | ||
|
283 | Metadata is a place that you can put arbitrary JSONable information about | |
|
284 | your notebook, cell, or output. Because it is a shared namespace, | |
|
285 | any custom metadata should use a sufficiently unique namespace, | |
|
286 | such as `metadata.kaylees_md.foo = "bar"`. | |
|
287 | ||
|
288 | Metadata fields officially defined for Jupyter notebooks are listed here: | |
|
289 | ||
|
290 | Notebook metadata | |
|
291 | ----------------- | |
|
292 | ||
|
293 | The following metadata keys are defined at the notebook level: | |
|
294 | ||
|
295 | =========== =============== ============== | |
|
296 | Key Value Interpretation | |
|
297 | =========== =============== ============== | |
|
298 | kernelspec dict A kernel specification. More detail :ref:`here <kernelspecs>` | |
|
299 | signature str A hashed signature of the notebook | |
|
300 | =========== =============== ============== | |
|
301 | ||
|
302 | ||
|
303 | Cell metadata | |
|
304 | ------------- | |
|
305 | ||
|
306 | The following metadata keys are defined at the cell level: | |
|
307 | ||
|
308 | =========== =============== ============== | |
|
309 | Key Value Interpretation | |
|
310 | =========== =============== ============== | |
|
311 | collapsed bool Whether the cell's output container should be collapsed | |
|
312 | autoscroll bool or 'auto' Whether the cell's output is scrolled, unscrolled, or autoscrolled | |
|
313 | deletable bool If False, prevent deletion of the cell | |
|
314 | format 'mime/type' The mime-type of a :ref:`Raw NBConvert Cell <raw nbconvert cells>` | |
|
315 | name str A name for the cell. Should be unique | |
|
316 | tags list of str A list of string tags on the cell. Commas are not allowed in a tag | |
|
317 | =========== =============== ============== | |
|
318 | ||
|
319 | Output metadata | |
|
320 | --------------- | |
|
321 | ||
|
322 | The following metadata keys are defined for code cell outputs: | |
|
323 | ||
|
324 | =========== =============== ============== | |
|
325 | Key Value Interpretation | |
|
326 | =========== =============== ============== | |
|
327 | isolated bool Whether the output should be isolated into an IFrame | |
|
328 | =========== =============== ============== |
General Comments 0
You need to be logged in to leave comments.
Login now