mirror of
https://github.com/SerenityOS/serenity
synced 2024-07-21 18:15:58 +00:00
Documentation: Merge UsingFontEditor into existing FontEditor manpage
The generate-manpages script needs to be updated again to handle the new PNGs in section 1. (I'm intentionally not making this a multi-directory glob.)
This commit is contained in:
kleines Filmröllchen
Linus Groh
parent
8558a6b83b
commit
fb7cd7b340
|
|
@ -12,11 +12,125 @@ $ FontEditor [file]
|
|||
|
||||
## Description
|
||||
|
||||
FontEditor is a font editing application for Serenity.
|
||||
FontEditor is the font editing application to create and edit bitmap font files in SerenityOS.
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
```sh
|
||||
$ FontEditor /res/fonts/CsillaRegular10.font
|
||||
### Basic Parts
|
||||
FontEditor has the following basic parts:
|
||||
1. The menu bar at the top
|
||||
2. The toolbar
|
||||
3. The main workspace
|
||||
4. The status bar at the bottom
|
||||
|
||||
Presently, you can resize the entire FontEditor form to your liking. You can turn the visibility of Font Metadata and Unicode Blocks on or off. You can change the glyph editor window zoom factor. All of these things are currently available in FontEditor automatically.
|
||||
|
||||
### Contents of the Menu Bar
|
||||
```
|
||||
File -> New Font
|
||||
File -> Open
|
||||
File -> Save
|
||||
File -> Save As...
|
||||
File -> Quit
|
||||
|
||||
Edit -> Undo
|
||||
Edit -> Redo
|
||||
Edit -> Cut
|
||||
Edit -> Copy
|
||||
Edit -> Paste
|
||||
Edit -> Delete
|
||||
Edit -> Select All
|
||||
Edit -> Copy as Text
|
||||
|
||||
Go -> Previous Glyph
|
||||
Go -> Next Glyph
|
||||
Go -> Go to Glyph...
|
||||
|
||||
View -> Preview Font
|
||||
View -> Font Metadata
|
||||
View -> Unicode Blocks
|
||||
View -> Scale -> 500% | 1000% | 1500%
|
||||
|
||||
Help -> Contents
|
||||
Help -> About Font Editor
|
||||
```
|
||||
|
||||
### The Toolbar
|
||||
The Toolbar contains the same functional entries as that of the Menubar and is represented as clickable icons. Hovering on each icon will display additional information listed at the status bar which further states what each icon does.
|
||||
|
||||
### The Main Workspace
|
||||
The main workspace has three partitions:
|
||||
|
||||
- The ***left section*** contains the glyph editor window. This window has three different zoom factors for ease of use and for your viewing comfort. They are 500%, 1000% and 1500%. You can freely switch to any zoom level at anytime while creating your font. Don't let the size of the glyph editor window fool you. This is where you will spend about 95% of the time. And the task is that of shaping each glyph by left+clicking on the mouse. You can form a dot, a line, or a complete glyph just by connecting the dots. If you need to undo a certain location with a black dot, you can right+click on top of the target area and it will revert back to empty. Each grid area can hold any of the three states: 1) on or black 2) off or white 3) empty or gray. On state is displayed as black by default. Off state is displayed as white by default. Empty state is displayed as gray by default. Off state or white is relevant most specially if the font is fixed-width as it dictates the distance a glyph will have from left, center or right. Empty state or gray is important for variable-width font as it affects the overall width of the glyph. For variable width fonts, you move the glyph flushed left on the glyph editor window and remove any extra empty grids by decrementing the present column counter located right under the glyph editor window and thereby leaving only the entire glyph all by itself. Below the glyph editor is the glyph tool which contains the following: pen icon for creating glyph itself, move icon to enable the entire glyph move to top, down, left or right from within the glyph editor window. Below the glyph tool are the transform icons which are flip horizontal, flip vertical, rotate counter-clockwise 90°and rotate clockwise 90°. Transform tools are most helpful when copying over existing glyphs and transforming them to form a new glyph. A becomes V, M becomes W, c becomes e, n becomes u, etcetera.
|
||||
|
||||
- The ***middle section*** contains two parts: the upper part which holds the entire glyph content of the font, or lack thereof if you are making a new one. And the lower part which contains ***Metadata*** information such as name, family, weight, slope, presentation size, mean line, baseline, glyph spacing and if the font is either fixed-width or variable-width. You can still further tweak your font paramaters via the Metadata section. The ` Fixed width ` toggle located at the right side next to Glyph spacing is of special note. It applies to the entire font file. It does not only apply to a single glyph or group of glyphs. It is the differentiating factor that informs the system if the font is or is not fixed-width. Fixed-width fonts are mostly used for Terminals and for displaying program source codes.
|
||||
|
||||
- The ***right section*** which displays both search input for unicode blocks and the unicode block selection list.
|
||||
Metadata and unicode blocks can be turned on or off via ` Menu -> View ` option. Unicode block filters only what to display contained within the range of the block. Basic Latin covers 000-007F, Latin-1 Supplement covers 0080-00FF, Latin Extended-A covers 0100-017F and so on and so forth. Global search for a glyph is affected when a certain block is currently selected. Only by selecting ` Show All ` will the global glyph search work as expected. So make it a habit of confirming that Show All is active before searching for a glyph.
|
||||
|
||||
### The status bar
|
||||
The status bar displays additional information describing what each menu entry and toolbar icon does. It identifies the unicode value of the glyph currently under the cursor. It shows the glyph's visual representation (if available), description and dimensions. Second only to the glyph editor window, the status bar is your next best friend on your path to becoming a font master.
|
||||
|
||||
### Create New Font
|
||||
|
||||
|
||||
To create a new font, you can either click on New Font icon on the Toolbar or go to ` File -> New Font ` on the Menubar.
|
||||
A wizard will walk you through preparing the needed parameters for your new font.
|
||||
|
||||
### Typeface Properties
|
||||
|
||||
|
||||
You can try out the default values just to get the feel of the program.
|
||||
|
||||
### Glyph Properties
|
||||
|
||||
|
||||
Just click **Finish** when you are so inclined.
|
||||
|
||||
### Edit Glyph Properties
|
||||
|
||||
|
||||
Adjust the values to suit your needs. The higher the value, the larger the font size.
|
||||
|
||||
### Untitled font
|
||||
|
||||
|
||||
Congratulations on your successful initial font setup. Now you are ready to begin. And begin you shall. There is more to font creation than simply scribbling away. You need to always remind yourself this question: "Where is the fun in that?". Start with what you need to do while striving to achieve fun in the process. Let's be honest, font creation is one of the many thankless jobs, unless and until there is fun in it, why bother?
|
||||
|
||||
### Launch another instance
|
||||
|
||||
|
||||
Figure above shows where you can find FontEditor from inside the SerenityOS desktop.
|
||||
|
||||
|
||||
### Side by side
|
||||
|
||||
|
||||
Having another instance of FontEditor can help boost productivity. This is most noticeable when one is just starting out on using FontEditor and is trying out how to best make use of the application. Don't be afraid to experiment, let your inner font master slowly shine through. It is best to maintain the feeling of having fun while silently grinning from ear to ear as you steadily create form and personality into your font. Don't be afraid to start again, if you must. As with the entire workflow, being aware when to start, when to stop and when to reset is crucial. With FontEditor to assist you, starting from scratch is no longer an arduous process.
|
||||
|
||||
### Save font
|
||||
|
||||
|
||||
Save your font by following the recommended ` FontName + FontStyle + FontPresentationSize + .font ` naming convention.
|
||||
|
||||
### Continue Editing
|
||||
|
||||
|
||||
The figure above shows some glyphs already created. Those with sharp eyes can immediately see that the glyphs for M and W, O and Q came from the same base. W was copied over from M and was flipped horizontally. Q was copied over from O and a descender was added to achieve the final glyph. Continue editing your font by adding more glyphs into it. Take your time in creating the font, only you know the reason why the glyph is formed the way it is. You know why the height and the width is so, why the curvature is just so. Aside from achieving balance, maintain the spirit of fun in making your font. The more glyphs are added, the easier it is to get the general feel and character of the font. Remember to always save and to save often.
|
||||
|
||||
### fonts.serenityos.net
|
||||
|
||||
|
||||
It is highly recommended to use our own [fonts portal](https://fonts.serenityos.net) as one of your primary resource for glyph and font information. The others are [Unicode charts [unicode.org]](https://www.unicode.org/charts/) and our [wiki](https://wiki.serenityos.net).
|
||||
|
||||
### Search glyph
|
||||
|
||||
|
||||
Figure above depicts a search session on the [fonts.serenityos.net](https://fonts.serenityos.net) portal.
|
||||
|
||||
### Search detail
|
||||
|
||||
|
||||
The same search session displaying result of the previous query.
|
||||
|
||||
So there you have it, by now you have at least an idea of how to make ***SerenityOS*** fonts using **FontEditor**. For any font-related questions or inquiries, just drop by the official [SerenityOS Discord #fonts](https://discord.com/channels/830522505605283862/927893781968191508).
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 127 KiB |
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
|
Before Width: | Height: | Size: 187 KiB After Width: | Height: | Size: 187 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 156 KiB After Width: | Height: | Size: 156 KiB |
|
Before Width: | Height: | Size: 132 KiB After Width: | Height: | Size: 132 KiB |
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
|
|
@ -1,124 +0,0 @@
|
|||
# Using Font Editor
|
||||
|
||||
### Welcome to Font Editor. This is the official app to create and edit bitmap font files in SerenityOS.
|
||||
|
||||
|
||||
|
||||
### Basic Parts
|
||||
FontEditor has the following basic parts:
|
||||
1. The menu bar at the top
|
||||
2. The toolbar
|
||||
3. The main workspace
|
||||
4. The status bar at the bottom
|
||||
|
||||
Presently, you can resize the entire FontEditor form to your liking. You can turn the visibility of Font Metadata and Unicode Blocks on or off. You can change the glyph editor window zoom factor. All of these things are currently available in FontEditor automatically.
|
||||
|
||||
### Contents of the Menu Bar
|
||||
```
|
||||
File -> New Font
|
||||
File -> Open
|
||||
File -> Save
|
||||
File -> Save As...
|
||||
File -> Quit
|
||||
|
||||
Edit -> Undo
|
||||
Edit -> Redo
|
||||
Edit -> Cut
|
||||
Edit -> Copy
|
||||
Edit -> Paste
|
||||
Edit -> Delete
|
||||
Edit -> Select All
|
||||
Edit -> Copy as Text
|
||||
|
||||
Go -> Previous Glyph
|
||||
Go -> Next Glyph
|
||||
Go -> Go to Glyph...
|
||||
|
||||
View -> Preview Font
|
||||
View -> Font Metadata
|
||||
View -> Unicode Blocks
|
||||
View -> Scale -> 500% | 1000% | 1500%
|
||||
|
||||
Help -> Contents
|
||||
Help -> About Font Editor
|
||||
```
|
||||
|
||||
### The Toolbar
|
||||
The Toolbar contains the same functional entries as that of the Menubar and is represented as clickable icons. Hovering on each icon will display additional information listed at the status bar which further states what each icon does.
|
||||
|
||||
### The Main Workspace
|
||||
The main workspace has three partitions:
|
||||
|
||||
- The ***left section*** contains the glyph editor window. This window has three different zoom factors for ease of use and for your viewing comfort. They are 500%, 1000% and 1500%. You can freely switch to any zoom level at anytime while creating your font. Don't let the size of the glyph editor window fool you. This is where you will spend about 95% of the time. And the task is that of shaping each glyph by left+clicking on the mouse. You can form a dot, a line, or a complete glyph just by connecting the dots. If you need to undo a certain location with a black dot, you can right+click on top of the target area and it will revert back to empty. Each grid area can hold any of the three states: 1) on or black 2) off or white 3) empty or gray. On state is displayed as black by default. Off state is displayed as white by default. Empty state is displayed as gray by default. Off state or white is relevant most specially if the font is fixed-width as it dictates the distance a glyph will have from left, center or right. Empty state or gray is important for variable-width font as it affects the overall width of the glyph. For variable width fonts, you move the glyph flushed left on the glyph editor window and remove any extra empty grids by decrementing the present column counter located right under the glyph editor window and thereby leaving only the entire glyph all by itself. Below the glyph editor is the glyph tool which contains the following: pen icon for creating glyph itself, move icon to enable the entire glyph move to top, down, left or right from within the glyph editor window. Below the glyph tool are the transform icons which are flip horizontal, flip vertical, rotate counter-clockwise 90°and rotate clockwise 90°. Transform tools are most helpful when copying over existing glyphs and transforming them to form a new glyph. A becomes V, M becomes W, c becomes e, n becomes u, etcetera.
|
||||
|
||||
- The ***middle section*** contains two parts: the upper part which holds the entire glyph content of the font, or lack thereof if you are making a new one. And the lower part which contains ***Metadata*** information such as name, family, weight, slope, presentation size, mean line, baseline, glyph spacing and if the font is either fixed-width or variable-width. You can still further tweak your font paramaters via the Metadata section. The ` Fixed width ` toggle located at the right side next to Glyph spacing is of special note. It applies to the entire font file. It does not only apply to a single glyph or group of glyphs. It is the differentiating factor that informs the system if the font is or is not fixed-width. Fixed-width fonts are mostly used for Terminals and for displaying program source codes.
|
||||
|
||||
- The ***right section*** which displays both search input for unicode blocks and the unicode block selection list.
|
||||
Metadata and unicode blocks can be turned on or off via ` Menu -> View ` option. Unicode block filters only what to display contained within the range of the block. Basic Latin covers 000-007F, Latin-1 Supplement covers 0080-00FF, Latin Extended-A covers 0100-017F and so on and so forth. Global search for a glyph is affected when a certain block is currently selected. Only by selecting ` Show All ` will the global glyph search work as expected. So make it a habit of confirming that Show All is active before searching for a glyph.
|
||||
|
||||
### The status bar
|
||||
The status bar displays additional information describing what each menu entry and toolbar icon does. It identifies the unicode value of the glyph currently under the cursor. It shows the glyph's visual representation (if available), description and dimensions. Second only to the glyph editor window, the status bar is your next best friend on your path to becoming a font master.
|
||||
|
||||
### Create New Font
|
||||
|
||||
|
||||
To create a new font, you can either click on New Font icon on the Toolbar or go to ` File -> New Font ` on the Menubar.
|
||||
A wizard will walk you through preparing the needed parameters for your new font.
|
||||
|
||||
### Typeface Properties
|
||||
|
||||
|
||||
You can try out the default values just to get the feel of the program.
|
||||
|
||||
### Glyph Properties
|
||||
|
||||
|
||||
Just click **Finish** when you are so inclined.
|
||||
|
||||
### Edit Glyph Properties
|
||||
|
||||
|
||||
Adjust the values to suit your needs. The higher the value, the larger the font size.
|
||||
|
||||
### Untitled font
|
||||
|
||||
|
||||
Congratulations on your successful initial font setup. Now you are ready to begin. And begin you shall. There is more to font creation than simply scribbling away. You need to always remind yourself this question: "Where is the fun in that?". Start with what you need to do while striving to achieve fun in the process. Let's be honest, font creation is one of the many thankless jobs, unless and until there is fun in it, why bother?
|
||||
|
||||
### Launch another instance
|
||||
|
||||
|
||||
Figure above shows where you can find FontEditor from inside the SerenityOS desktop.
|
||||
|
||||
|
||||
### Side by side
|
||||
|
||||
|
||||
Having another instance of FontEditor can help boost productivity. This is most noticeable when one is just starting out on using FontEditor and is trying out how to best make use of the application. Don't be afraid to experiment, let your inner font master slowly shine through. It is best to maintain the feeling of having fun while silently grinning from ear to ear as you steadily create form and personality into your font. Don't be afraid to start again, if you must. As with the entire workflow, being aware when to start, when to stop and when to reset is crucial. With FontEditor to assist you, starting from scratch is no longer an arduous process.
|
||||
|
||||
### Save font
|
||||
|
||||
|
||||
Save your font by following the recommended ` FontName + FontStyle + FontPresentationSize + .font ` naming convention.
|
||||
|
||||
### Continue Editing
|
||||
|
||||
|
||||
The figure above shows some glyphs already created. Those with sharp eyes can immediately see that the glyphs for M and W, O and Q came from the same base. W was copied over from M and was flipped horizontally. Q was copied over from O and a descender was added to achieve the final glyph. Continue editing your font by adding more glyphs into it. Take your time in creating the font, only you know the reason why the glyph is formed the way it is. You know why the height and the width is so, why the curvature is just so. Aside from achieving balance, maintain the spirit of fun in making your font. The more glyphs are added, the easier it is to get the general feel and character of the font. Remember to always save and to save often.
|
||||
|
||||
### fonts.serenityos.net
|
||||
|
||||
|
||||
It is highly recommended to use our own [fonts portal](https://fonts.serenityos.net) as one of your primary resource for glyph and font information. The others are [Unicode charts [unicode.org]](https://www.unicode.org/charts/) and our [wiki](https://wiki.serenityos.net).
|
||||
|
||||
### Search glyph
|
||||
|
||||
|
||||
Figure above depicts a search session on the [fonts.serenityos.net](https://fonts.serenityos.net) portal.
|
||||
|
||||
### Search detail
|
||||
|
||||
|
||||
The same search session displaying result of the previous query.
|
||||
|
||||
So there you have it, by now you have at least an idea of how to make ***SerenityOS*** fonts using **FontEditor**. For any font-related questions or inquiries, just drop by the official [SerenityOS Discord #fonts](https://discord.com/channels/830522505605283862/927893781968191508).
|
||||
|
|
@ -106,6 +106,7 @@ pandoc -f gfm -t html5 -s \
|
|||
# Copy pre-made files
|
||||
cp Meta/Websites/man.serenityos.org/banner.png output/
|
||||
cp Base/usr/share/man/man7/LibDSP_classes.svg output/
|
||||
cp Base/usr/share/man/man1/*.png output/
|
||||
|
||||
# Copy icons
|
||||
mkdir output/icons
|
||||
|
|
|
|||
Loading…
Reference in a new issue