Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating documentation and simplifying the command-line example #174

Merged
merged 1 commit into from
Jan 8, 2016

Conversation

nicola
Copy link
Contributor

@nicola nicola commented Jan 7, 2016

This may help towards #173

-sE, --suffix-sse Suffix for SSE files (default: '.events')
--no-error-pages Disable custom error pages (use Node.js default pages instead)
--error-pages Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)
--skin URI to a skin to load (default: https://linkeddata.github.io/warp/#/list/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does skin refer to?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point.. Tabulator or Warp are skins.. they are like default viewer. It is like a default app that you want to use to browse the data, you can also pass --no-skin to have none

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. :) Would you be opposed to renaming them to apps, instead of skins?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skin is a confusing word, but it's important to capture the idea that sometimes an app is invoked as a viewer for particular resource, as opposed to its usual mode. "Viewer" isn't right, though, because it doesn't have to be read-only. It's like how operating systems pick some app to run when you indicate you want to open a file (e.g.by double clicking). What do you call that app? The "default opener" or something.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re: "Default application" for file types. Tabulator/Warp are part of a class of "file browser" or "file manager" applications. If for instance, the default application to open is a "photo manager", it will act like a personal photo management software, displaying and offering special controls to only the file types in knows what to do with. I think renaming to something like --default-app seems intuitive enough and the terminology is closer to what's used in OSs, and with no special binding to a particular class of applications. --skin on the other hand comes across like a theme, decoration, or appearance.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving the 'skin'/'default app' discussion to solid/solid-spec#65

@dmitrizagidulin
Copy link
Contributor

Aside from renaming skin to default-app (which should be its own issue), +1 on this PR, looks good to me. :)

@dmitrizagidulin
Copy link
Contributor

Merging.

dmitrizagidulin added a commit that referenced this pull request Jan 8, 2016
Updating documentation and simplifying the command-line example
@dmitrizagidulin dmitrizagidulin merged commit ed7e845 into master Jan 8, 2016
@dmitrizagidulin dmitrizagidulin deleted the doc-examples branch January 8, 2016 21:28
@deiu deiu removed the in progress label Jan 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants