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

Create meta-data file for scribus scripts #3

Open
Exirel opened this issue May 18, 2014 · 4 comments
Open

Create meta-data file for scribus scripts #3

Exirel opened this issue May 18, 2014 · 4 comments

Comments

@Exirel
Copy link

Exirel commented May 18, 2014

I open this issue only to track ideas and changes to create a meta-data file for scripts into a scribus's script repository.

The basic meta-data should be:

  • script name
  • licence
  • author name
  • script version
  • scribus version number (compatibility)
  • script summary
  • script url

May be some optional meta-data could be useful:

  • script long description (or may be see README.md in the same package/folder?)
  • script site/doc URL
  • script source URL
  • author email
  • categories (tag for search purpose)
  • status (dev, stable, etc.)
  • other files/data (such as readme, or else)

As I suppose one can provide a script requiring dependencies, listing such dependencies could be useful too.

@aoloe
Copy link
Owner

aoloe commented May 20, 2014

i want to add a demo meta-data file to the grid script...

since it's a hand written file, i would go for a yaml file... but json being overall more popular it might also be an option...

any further hints/ideas?

@aoloe
Copy link
Owner

aoloe commented May 20, 2014

the meta-data file should list all the files of the script.

if no files list is given, a file with the same name as the directory (+.py) and the README.md are automatically used.

@aoloe
Copy link
Owner

aoloe commented Aug 13, 2014

I've put a a specification proposal in the script-download's README file

@JLuc
Copy link

JLuc commented Aug 14, 2014

Should there not be an optional entry for script version ?

Script versioning raises another issue : how should various versions of the same script be dealt with ?

[edit]
PS : you might be interested in http://blog.smellup.net/spip.php?article7

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

No branches or pull requests

3 participants