{"action":"created","issue":{"url":"https://api.github.com/repos/interfasys/galleryplus/issues/93","labels_url":"https://api.github.com/repos/interfasys/galleryplus/issues/93/labels{/name}","comments_url":"https://api.github.com/repos/interfasys/galleryplus/issues/93/comments","events_url":"https://api.github.com/repos/interfasys/galleryplus/issues/93/events","html_url":"https://github.com/interfasys/galleryplus/issues/93","id":61630303,"number":93,"title":"Configure an album via a simple text file","user":{"login":"oparoz","id":323220,"avatar_url":"https://avatars.githubusercontent.com/u/323220?v=3","gravatar_id":"","url":"https://api.github.com/users/oparoz","html_url":"https://github.com/oparoz","followers_url":"https://api.github.com/users/oparoz/followers","following_url":"https://api.github.com/users/oparoz/following{/other_user}","gists_url":"https://api.github.com/users/oparoz/gists{/gist_id}","starred_url":"https://api.github.com/users/oparoz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oparoz/subscriptions","organizations_url":"https://api.github.com/users/oparoz/orgs","repos_url":"https://api.github.com/users/oparoz/repos","events_url":"https://api.github.com/users/oparoz/events{/privacy}","received_events_url":"https://api.github.com/users/oparoz/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/interfasys/galleryplus/labels/feature%20request","name":"feature request","color":"c7def8"},{"url":"https://api.github.com/repos/interfasys/galleryplus/labels/user%20experience","name":"user experience","color":"f7c6c7"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":42,"created_at":"2015-03-14T15:45:49Z","updated_at":"2015-03-24T15:19:11Z","closed_at":null,"body":"Maybe you want to include a an album description? #85 \r\nOr you want to make your sorting preferences for this album permanent? #91 \r\nYou're required to add a copyright notice to your public gallery?\r\netc.\r\n\r\nA simple [yaml](https://en.wikipedia.org/wiki/YAML) file could be looked for and the information used to format the album being currently looked at.\r\n\r\nThe advantage of using a file, vs using the database is that you'll get the exact same view on another ownCloud using the same app. You can also quickly change the settings on your desktop, without having to log into ownCloud itself.\r\n\r\n### File format\r\nUTF-8, without BOM\r\n\r\n### Supported configuration\r\n\r\n```\r\n---\r\ndescription: readme.md\r\ncopyright: Copyright 2003-2015 interfaSys sàrl, Switzerland\r\ncopyright_link: copyright.md\r\nsorting: date\r\nsort_order: des\r\n```\r\n\r\n### Supported variables\r\n* `description`: a markdown file. See [this page](http://www.markitdown.net/markdown) for the syntax\r\n* `copyright`: a string (text)\r\n* `copyright_link`: any file (in the album itself)\r\n* `sorting`: date or name. date only works for files\r\n* `sort_order`: asc or des\r\n\r\n### Sorting\r\nAfter careful consideration, it has been decided that :\r\n* the script would look for sorting configurations in parent folders in order to make it easier to define a global sorting order. Exception configurations would have to be defined in sub-folders. More testing is required in order to determine if that's a solution which would cover most use cases\r\n* a valid configuration must contain both the `sorting` and `sort_order` variables\r\n* in case only the `sorting` variable has been set, the default sort order will be used\r\n* in case only the `sort_order` variable has been found, the sort configuration will be ignored and the script will keep looking for a valid configuration in upper folders\r\n\r\n### Next steps\r\n### Feasibility study\r\n- [x] Collect requirements\r\n- [x] Calculate effort required - 2 days\r\n- [x] Build proof of concept\r\n\r\n### Development\r\n- [x]  Secure funding - Sponsored by [Cute cut](http://www.cute-cut.ch)\r\n- [ ]  Finalise specifications\r\n\r\n### QA\r\n- [ ] Define tests\r\n- [ ] Write tests (optional)\r\n- [ ] Pass all tests\r\n\r\n### Documentation\r\n- [ ] Create documentation\r\n- [ ] Deliver training\r\n\r\n<bountysource-plugin>\r\n---\r\nWant to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/9557874-configure-an-album-via-a-simple-text-file?utm_campaign=plugin&utm_content=tracker%2F9328526&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F9328526&utm_medium=issues&utm_source=github).\r\n</bountysource-plugin>"},"comment":{"url":"https://api.github.com/repos/interfasys/galleryplus/issues/comments/85548543","html_url":"https://github.com/interfasys/galleryplus/issues/93#issuecomment-85548543","issue_url":"https://api.github.com/repos/interfasys/galleryplus/issues/93","id":85548543,"user":{"login":"oparoz","id":323220,"avatar_url":"https://avatars.githubusercontent.com/u/323220?v=3","gravatar_id":"","url":"https://api.github.com/users/oparoz","html_url":"https://github.com/oparoz","followers_url":"https://api.github.com/users/oparoz/followers","following_url":"https://api.github.com/users/oparoz/following{/other_user}","gists_url":"https://api.github.com/users/oparoz/gists{/gist_id}","starred_url":"https://api.github.com/users/oparoz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oparoz/subscriptions","organizations_url":"https://api.github.com/users/oparoz/orgs","repos_url":"https://api.github.com/users/oparoz/repos","events_url":"https://api.github.com/users/oparoz/events{/privacy}","received_events_url":"https://api.github.com/users/oparoz/received_events","type":"User","site_admin":false},"created_at":"2015-03-24T15:19:11Z","updated_at":"2015-03-24T15:19:11Z","body":"The feature is complete now, but I'm not a 100% happy with the sliding panel, so I need to see if I can improve it..."}}