Blueprint changed by Christopher Adams:

Whiteboard changed:
+ ISSUES
+   Q:  What happens if a zip file contains OTF and TTF versions of the same 
font?
+   A:  Both of them will show up on the font family page.
  
- ***OLD WHITEBOARD***
+   Q:  What happens if the ZIP file contains both a TTF/OTF and a corresponding
+       webfont with a subset of the glyph coverage?
+   A:  Both of them will show up on the font family page!
  
- I think this sounds super super complicated!
+   Q:  What happens if the zip file already contains other webfonts?
+   A:  We'll ignore them - we are not in the business of decompiling woff
+       or eot files and figuring out where they belong.
  
- == TODO ==
+   Q:  What should happen if the font contains no license information?
+   A:  We should probably abort the download.
  
- Figure out how to detect the ${fontFamilyName} from the font files
+ FILTERING
+   » Accepted files include:
+     - jpg, png, txt, ttf, otf, sfd, vfb, enc, cfg, py, c, pe, rb, tex, latex, 
pdf, ps
  
- Figure out how to deal with families of fonts to generate the CSS
- properly
+   » Unaccepted files include:
+     - hidden files and folders
  
- Figure out how to deal with remixes properly - when you visit a parent
- it should be very obvious that child versions are available, especially
- if they have similar names - we want to provide version control
- properly, eventually, but the simple thing to do in the mean time is to
- just freeze uploads when they happen, and make it obvious that a new
- version is available.
+   At present the policy is to accept everything but hidden folders. Everything
+   else will be checked into our git repository. The original contents of the
+   zip will always be available by downloading the zip directly.
  
- Allow the user to specify the preview text used to generate the PCFP
- images, and the font preview CSS on the family page, during the upload
- process, and make the text smarter based on fontaine's language support
- of the font
+ USEFUL COPY
  
- Figure out how to deal with TTF (if OTF), SVG, EOT, WOFF web font
- formats - generate if not already included? OFL renaming issue! "Your
- ZIP file does not contain versions of your fonts suitable for all web
- browsers. We can generate TTF, SVG, EOT and WOFF format fonts for you
- now, if you'd like. We add "OFLB" to the fonts' names to make it clear
- they are derivatives made by this site. Please tick this box to agree to
- this use of your Reserved Font Names [x]"?
+ "Use this form to upload a single ZIP file containing all the fonts
+ (TTF, OTF) in the family. Be sure to include <a>source files</a> (SFD,
+ VFB, etc), a FONTLOG.txt and LICENSE.txt and sample images (PNG/JPEG).
+ Please consult our <a>guidebook</a> for further instructions."
  
- Update fontaine to detect ubuntu font license
+ "The Open Font Library only hosts fonts that are lovingly prepared to be
+ shared. The uploaded file was not a ZIP file, so please read our
+ Uploading documentation, prepare a ZIP file with the font files, source
+ files and text files that we want everyone to have, and try again."
  
- ###
+ "Your ZIP file contains the following file[s] with the extensions[s]
+ $unknownExtensionsList: [<ul> list of file names with extensions in
+ <strong>] The Open Font Library only hosts font files, so we kindly ask
+ you to remove [that file,those files] from your ZIP and try again. If
+ this is a mistake and your file is part of your font project, please
+ email <a>[email protected]</a> with your ZIP
+ attached, and we'll change the site to allow those files straight away!"
  
- more:
- 
- It's very annoying to get an OFL font and not know where it's coming
- from or even if it claims reserved names. Some authors just specify
- "OFL" as if that was sufficient. The OFLB upload form should therefore
- have checkboxes for uploaders to confirm they have done their homework
- applying the license in an ideal way. Including a copy of the license in
- the font. TrueType and OpenType allow for this easily and FontForge has
- made it very easy to add the OFL to fonts. The upload form should
- prominently link to a page on [[Font metadata|how to include a license
- inside font files]] that gives a step-by-step guide to doing this;
- ideally this would be screenshot-illustrated.
- 
- ###
- 
- still more:
- 
- We need to agree if files should be filtered on an include or exclude
- bases. Exclude may be better than include. We need to decide a
- definitive list if it's include-based. For an exclude list, we should
- exclude files with .exe .php and so on, and include any files not
- matching this ban-list. But, one can always change a file name extension
- to something else, so testing against the file extension is probably not
- very useful.... PHP's $_FILES['userfile']['type'] will indicate the
- file's mime type if provided by the browser, but how do browsers
- determine the mime type for uploaded files? The *nix "file" command
- reads the file headers and determines file type based on the pattern of
- bytes in the headers of files -- that is the most reliable way to do it.
- But browsers may not use a similar method. Perhaps the "Report possible
- License violation" feature could be duplicated/extended to "Report
- possible malicious file" so a simple machine filter like file extensions
- would have a social safety net. In the supposed "upload zip, uncompress
- zip, if other files added, compress all the files into a new zip"
- process, running the "file" command on the files to check their type
- matches their file extension at the "uncompress zip" and "files added"
- stages would be great.
- 
- $fontlog field should complain if empty. Adding a FONTLOG.txt should
- work - TXT to become an allowed file type. Uploading a FONTLOG.txt when
- the $fontlog box is null should make the contents of the TXT be copied
- to the field. Fontlog field should process markdown when rendered, and
- when edited, should have a note saying that it has no rich text like the
- Description field because its often distributed as plain text, but link
- to Markdown and explain it briefly.
- 
- Extract reliable information about the Unicode coverage of typeface
- families and use that metadata to add type-centric statistics to the
- site, such as signposting which orthographies need better coverage by
- free software fonts.
- 
- Allow a form of version control of the fonts, so that users have the
- ability to see changes in the filesets of each typeface and retrieve
- older versions of the typeface. It has been suggested that we adapt
- existing ccHost features for this purpose.
- 
- Have the Upload forms upload a font file as soon as it is selected, and
- parse its metadata and auto-complete other fields in the form. This is a
- pretty speculative idea, but would make the upload forms easier.
- 
- It seems we want two upload forms: "One click/Easy upload form" -
- provide a TTF, a name, read a notice confirming that its OFL, click
- upload - and, "Detailed upload form" - all the stuff required for a
- typeface family covering multiple scripts with multiple weights and
- variants and some unusual but free license. A JS library can be used to
- make the easy upload form transform like an Transformers Autobot into
- the detailed one.
- 
- The upload form/docs should encourage '''authors themselves''' to upload
- their own fonts. If others who are not authors post a font it should be
- clearly marked as such ("on behalf of" or something like that -
- [http://openfontlibrary.org/media/files/davelab6/325 OFLBv1 has
- "featuring"]) to indicate who the upstream author is, and provide a link
- to the upstream site when it is known. A tickbox "I have checked that
- this font isn't violating any author rights" or similar could be useful.
- Or fields for admins only on the upload form that allows admins to
- denote a font is importing from an existing project on their behalf, eg
- Liberation or DejaVu. The effect would be to remove the byline on the
- typeface page (such as incorrectly shown in
- http://openfontlibrary.fontly.org/files/crossland/4 )
- 
- Remix: auto-add the stuff from the original sources to the new FONTLOG?
+ "License Check. The Open Font Library is a home for quality open fonts.
+ We want all fonts to have their copyright licenses included inside the
+ fonts, so its always clear to people who have copies what their rights
+ are. You must add metadata to the font embedding a licence that we
+ accept, or at least declare which license is included in the ZIP. We
+ recommend: The SIL Open Font License v1.1, the GNU GPL v3 with Font
+ Exception, or the Creative Commons CC-0 license. Our wiki has more
+ information about these licenses, and we hope you will read our
+ Uploading documentation and try again."

-- 
Complete Upload Form
https://blueprints.launchpad.net/openfontlibrary/+spec/complete-upload-form

_______________________________________________
Mailing list: https://launchpad.net/~aikiframework.admins
Post to     : [email protected]
Unsubscribe : https://launchpad.net/~aikiframework.admins
More help   : https://help.launchpad.net/ListHelp

Reply via email to