Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Metadata editing #159

Closed
lxbarth opened this Issue Jul 3, 2012 · 5 comments

Comments

Projects
None yet
4 participants
Owner

lxbarth commented Jul 3, 2012

Goal: improve the editing experience particularly for individuals not familiar with Jekyll front matter.

prose.io already supports metadata defaults, which is an important step in the right direction.

In addition, the following improvements would be great:

  1. provide a UI for configuring post metadata
  2. validation of input

This will need more thinking, but OTOH, here is what I'm seeing:

1 metadata UI

First step: preconfigured fields and textfield widgets to populate them. Support multi value fields (e. g. tags).

Pretty soon options support will be interesting. E. g: provide a set of valid values for categories.

2 validation

First step: support required fields. Next up: validate dates. Date pickers are sucky, a free form date field with light validation just does the job.

Extensibility

It might make sense to delegate metadata editing to a certain degree to the Jekyll site. A Jekyll site could provide a metadata editor as a JS plugin, delegating full responsibility for parsing and generating frontmatter to the site. This could circumvent issues where providing a general UI for frontmatter is a not well bounded problem which in turn wouldn't allow us to build a tight UI for it.

/cc @dhcole @michael @gundersen

Owner

michael commented Jul 20, 2012

We've had some extensive discussion about this. For the 0.3.0 release we stepped back on implementing that generic metadata editor as there were serious doubts about the UX gains this would bring compared to the resources to implement it. Saman was not available to for this release, so I had to postpone it and focus on search + the save -> review -> commit workflow.

Eric and I was planning a "Prose Future" meetup on Wednesday, so this will be a topic again.

@michael michael closed this Jul 20, 2012

@michael michael reopened this Jul 20, 2012

@lxbarth lxbarth was assigned Jul 20, 2012

zakkain commented Oct 17, 2012

I landed here via a google search for "prose.io metadata defaults" - @lxbarth, you say that is supported? How do I set that up? I'd like to always set the Author metadata field to my name, since I'm working on a personal blog.

Owner

michael commented Oct 17, 2012

There's a section "Metadata Defaults" in the handbook.

http://prose.io/help/handbook.html

Here's another example:

prose:
  rooturl: "_posts"
  metadata:
    "_posts/projects": |
      layout: project
      title: Enter project title
      abstract: Enter project summary
      author: John Doe
      image: "http://f.cl.ly/items/1o363t351s47371R3X2f/polished-off.png"
      subjects:
      - Animation
      - Visual effects
      assets:
        videos:
        - name: Video 1
          url: http://vimeo.com/video1
        documents: 
        - name: Document 1
          url: http://example.com/document1.pdf
        - name: Document 2
          url: http://example.com/document2.pdf
        images:
        - name: Image 1
          url: http://example.com/image2
      categories:
      - projects
      published: true

zakkain commented Oct 17, 2012

Aha, fantastic - thank you!

On Wed, Oct 17, 2012 at 4:08 AM, Michael Aufreiter <notifications@github.com

wrote:

There's a section "Metadata Defaults" in the handbook.

http://prose.io/help/handbook.html

Here's another example:

prose:
rooturl: "_posts"
metadata:
"_posts/projects": |
layout: project
title: Enter project title
abstract: Enter project summary
author: John Doe
image: "http://f.cl.ly/items/1o363t351s47371R3X2f/polished-off.png"
subjects:
- Animation
- Visual effects
assets:
videos:
- name: Video 1
url: http://vimeo.com/video1
documents:
- name: Document 1
url: http://example.com/document1.pdf
- name: Document 2
url: http://example.com/document2.pdf
images:
- name: Image 1
url: http://example.com/image2
categories:
- projects
published: true


Reply to this email directly or view it on GitHubhttps://github.com/prose/prose/issues/159#issuecomment-9519172.

– Zachary Kain

Designer, Creative Technologist
416-712-8895
zakkain@gmail.com
→ view my resume/profile http://zerply.com/zakkain/public

Owner

dhcole commented Mar 25, 2013

New metadata editor planned in #295

@dhcole dhcole closed this Mar 25, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment