SpecSpec

Differences between revisions 14 and 18 (spanning 4 versions)
Revision 14 as of 2006-05-25 09:32:07
Size: 5630
Editor: phsys
Comment: oops
Revision 18 as of 2008-04-26 18:48:41
Size: 3018
Editor: pool-72-83-104-211
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
 * '''Launchpad Entry''': https://launchpad.net/distros/ubuntu/+spec/foo  * '''Launchpad Entry''': UbuntuSpec:foo
Line 9: Line 9:
This specification describes the way we would like Ubuntu specifications to be written. It takes the form of a specification itself.  Gnome is completely lacking a font installer. If you double click a ttf font, you can preview it, but no indication is given to the user for how to get the font into applications. KDE already does this out of the the box. On the wiki there are some instructions explaining to create a .fonts folder and stick your fonts in there, but this has issues:

1) Shouldn't be necessary in the first place
2) Isn't system wide, and to do so system wide requires using the terminal
3) Doesn't work for joe blow user because when he tries to create the .fonts folder Nautilus tells him it already exists, he looks for it but doesn't see it, and gives up using Ubuntu out of frustration (he doesn't see it because it's hidden, nautilus doesn't explain this either).
Line 19: Line 23:
Bottom line: the better your spec, the better the chances that your ideas will clearly understood by the review team. Bottom line: the better your spec, the better the chances that your ideas will be clearly understood by the review team.
Line 23: Line 27:
  * Bob is the maintainer for the boot process for Ubuntu. In the Dapper cycle, he would like to work on getting the boot time down to two seconds from boot manager to GDM screen. He creates an entry for the specification in Launchpad, proposes it for the UBZ sprint, and starts writing out a braindump of it in the Ubuntu wiki. Magnus, who is in charge of UBZ scheduling, thinks it sounds fishy but approves it to make sure that the change is discussed and documented properly. He marks it as priority Medium because he isn't sure Bob will have time free for implementing it during Dapper.   * Joe the graphics designer wants to install a font just for himself, so that he can make cool-looking documents in AbiWord
Line 25: Line 29:
  * Pedro works on Malone, in Launchpad. Before UBZ, he remembers that the dependency handling in the bug tracker is really not optimal. He writes out a Summary and Rationale in a Launchpad wiki page, registers it as a specification in Launchpad, and suggests it for UBZ. Monica, Launchpad manageress, thinks that this is really not the time to be talking about it and rejects the application for UBZ. He then indicates it for the next conference, UBB, and marks its priority is Low.

  * Jason is an Ubuntu and Rosetta user. He has noticed that changes made to translations are making their way into language packs but not to the upstream versions, and adds a specification that describes a way for getting upstream to use language packs. Monica also has a plan for this but hadn't described it in a spec, so she adds it to the UBZ spec list, and adds Carlos, Rosetta maintainer, as drafter for it.
  * Alice the SysOp finds a nice font, and wants all the people on her system to be able to use it.
Line 31: Line 33:
This specification covers feature specifications for Ubuntu and Launchpad. It is not meant as a more general specification format. This specification covers a simple way to add fonts to Ubuntu using a simple GUI.
Line 35: Line 37:
A specification should be built with the following considerations: The following considerations should be kept in mind:
Line 37: Line 39:
  * The person implementing it may not be the person writing it. It should be clear enough for someone to be able to read it and have a clear path towards implementing it. If it doesn't, it needs more detail.

  * That the use cases covered in the specification should be practical situations, not contrived issues.

  * Limitations and issues discovered during the creation of a specification should be clearly pointed out so that they can be dealt with explicitly.

  * If you don't know enough to be able to competently write a spec, you should either get help or research the problem further. Avoid spending time making up a solution: base yourself on your peers' opinions and prior work.

Specific issues related to particular sections are described further below.
* The user should not have to open a terminal
* PolicyKit should be used to add system fonts
* Separation should be kept between user and system fonts.
Line 51: Line 47:
Line 53: Line 50:
This should be the description of '''why''' this spec is being defined. Currently the only way to add a font as a user is to create (if not already in existence ) a ~/.fonts folder and to put your fonts in there. This is not immediately obvious, and such a directory is hidden by default.
Line 55: Line 52:
=== Scope and Use Cases === Adding a system font is very difficult without terminal usage.
Line 57: Line 54:
While not always required, but in many cases they bring much better clarity to the scope and scale of the specification than could be obtained by talking in abstract terms. ==== Use Cases ====
Line 61: Line 58:
This section is usually broken down into subsections, such as the packages being affected, data and system migration where necessary, user interface requirements and pictures (photographs of drawings on paper work well).

== Implementation ==

To implement a specification, the assignee should observe the use cases carefully, and follow the design specified. He should make note of places in which he has strayed from the design section, adding rationale describing why this happened. This is important so that next iterations of this specification (and new specifications that touch upon this subject) can use the specification as a reference.

The implementation is very dependent on the type of feature to be implemented. Refer to the team leader for further suggestions and guidance on this topic.

== Outstanding Issues ==

The specification process requires experienced people to drive it. More documentation on the process should be produced.

The drafting of a specification requires english skills and a very good understanding of the problem. It must also describe things to an extent that someone else could implement. This is a difficult set of conditions to ensure throughout all the specifications added.

There is a lot of difficulty in gardening obsolete, unwanted and abandoned specifications in the Wiki.

== BoF agenda and discussion ==

We'll have a first public session on this on the first Monday in UBZ.
Ideally, this will appear in System>Preferences>Appereance under "Fonts", where a "add new" button would exist to add a font simply.
(Mockup to be created shortly)

Summary

  • Gnome is completely lacking a font installer. If you double click a ttf font, you can preview it, but no indication is given to the user for how to get the font into applications. KDE already does this out of the the box. On the wiki there are some instructions explaining to create a .fonts folder and stick your fonts in there, but this has issues:

1) Shouldn't be necessary in the first place 2) Isn't system wide, and to do so system wide requires using the terminal 3) Doesn't work for joe blow user because when he tries to create the .fonts folder Nautilus tells him it already exists, he looks for it but doesn't see it, and gives up using Ubuntu out of frustration (he doesn't see it because it's hidden, nautilus doesn't explain this either).

Rationale

As we develop new ideas for features in Ubuntu, it's important to be able to communicate them clearly. This serves the purpose of making it clear what the feature is about, and allowing people to evolve an implementation strategy for it.

Publishing this content gives our community a chance to participate in the discussion and design of a feature, and increases the chance that community members will feel confident enough to start work on the implementation of the feature.

A good specification also allows community members who were not physically present at meetings discussing a topic to participate in the implementation of the spec.

Bottom line: the better your spec, the better the chances that your ideas will be clearly understood by the review team.

Use Cases

  • Joe the graphics designer wants to install a font just for himself, so that he can make cool-looking documents in AbiWord

  • Alice the SysOp finds a nice font, and wants all the people on her system to be able to use it.

Scope

This specification covers a simple way to add fonts to Ubuntu using a simple GUI.

Design

The following considerations should be kept in mind:

* The user should not have to open a terminal * PolicyKit should be used to add system fonts * Separation should be kept between user and system fonts.

Summary

The summary should not attempt to say why the spec is being defined, just what is being specified.

Rationale

Currently the only way to add a font as a user is to create (if not already in existence ) a ~/.fonts folder and to put your fonts in there. This is not immediately obvious, and such a directory is hidden by default.

Adding a system font is very difficult without terminal usage.

Use Cases

Implementation Plan

Ideally, this will appear in System>Preferences>Appereance under "Fonts", where a "add new" button would exist to add a font simply. (Mockup to be created shortly)


CategorySpec

SpecSpec (last edited 2010-05-30 17:13:07 by dsl-185-83-10)