Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
/NeonPublic
Yinan Zhou edited this pageSep 20, 2023 ·3 revisions

Introduction

The Dashboard is a file system GUI for organizing uploaded files in Neon.

It can be broken down into the

  • model (src/Dashboard/FileSystem)
  • view (All the HTML elements)
  • controller (event listeners and logic insrc/Dashboard/Dashboard.ts and referenced)

Naming schema

View

ATile refers to theHTMLDivElement in theview that corresponds to an entry that the user can interact with (via opening, drag and dropping into a folder, right click, etc).

Model

AnEntry is referring to a file or folder inmodel.

AFile is an uploaded resource meant to be opened in the Neon Editor.

AFolder is a folder in the dashboard file system that can contain other entries.

AFolio is a file that contains single page folio.

AManuscript is a file that contains a multi-page manuscript.

Reference

FileSystem (model)

export interface IEntry {  name: string;  type: EntryType;  id: string;  children: IEntry[];  metadata: { [key: string]: unknown };}export interface IFolder extends IEntry {  type: EntryType.Folder;  id: string;  children: IEntry[];}export interface IFile extends IEntry {  type: EntryType.File  id: string;}

Notes:

  • The unique identifier for an entry is a generated uuid.
  • The metadata field contains any number of key-value pairs. A few of the current reserved keys are:
  • "type": "folio" or "manuscript"
  • "document": "sample". if present, indicates that the file is a non-user uploaded resource and how to open it inopenFile() andopenEditorTab()
  • "immutable": true. if present, indicated that the file is not to be deleted or moved depending on context.

© 2018-2020 Distributed Digital Archives and Libraries Lab

Clone this wiki locally

[8]ページ先頭

©2009-2025 Movatter.jp