CAZypedia needs your help! We have many unassigned GH, PL, CE, AA, GT, and CBM pages in need of Authors and Responsible Curators.
Scientists at all career stages, including students, are welcome to contribute to CAZypedia. Read more here, and in the 10th anniversary article in Glycobiology.
New to the CAZy classification? Read this first.
*
Consider attending the 15th Carbohydrate Bioengineering Meeting in Ghent, 5-8 May 2024.
Difference between revisions of "Help:Editing"
Harry Brumer (talk | contribs) (New page: == CAZypedia and WYSIWYG editing == The nature of the wiki format which forms the basis of CAZypedia ''does not'' lend itself very well to WYSIWYG (what you see is what you get) editing th...) |
Harry Brumer (talk | contribs) |
||
| Line 2: | Line 2: | ||
The nature of the wiki format which forms the basis of CAZypedia ''does not'' lend itself very well to WYSIWYG (what you see is what you get) editing that most of us are used to. Unlike word processing software, where what you type is immediately formatted on the screen and later appears on the printed page, wiki editing is a bit more like making a web page. In the latter case, text is typed in an unformatted form, which is later formatted on the fly according to specific formatting "tags" embedded in the text itself. | The nature of the wiki format which forms the basis of CAZypedia ''does not'' lend itself very well to WYSIWYG (what you see is what you get) editing that most of us are used to. Unlike word processing software, where what you type is immediately formatted on the screen and later appears on the printed page, wiki editing is a bit more like making a web page. In the latter case, text is typed in an unformatted form, which is later formatted on the fly according to specific formatting "tags" embedded in the text itself. | ||
| − | The reasons wikis, and thus CAZYpedia, use this less user-friendly way are mainly technical, having to do with using a web browser as an input tool and a remote web server as the data storage device. People who are used to "mark-up" computer languages (like HTML) will have little trouble getting used to the wiki way of formatting text. To ease the pain for everyone else, CAZypedia | + | The reasons wikis, and thus CAZYpedia, use this less user-friendly way are mainly technical, having to do with using a web browser as an input tool and a remote web server as the data storage device. People who are used to "mark-up" computer languages (like HTML) will have little trouble getting used to the wiki way of formatting text. To ease the pain for everyone else, CAZypedia implements an ''almost'' WYSIWYG editor called [http://en.wikipedia.org/wiki/User:Cacycle/wikEd wikEd]. wikEd was develped to make life easier for Wikipedia contributors, and since CAZypedia runs the same wiki software (MediaWiki), we can benefit from wikEd, too. |
== Using wikEd on CAZypedia == | == Using wikEd on CAZypedia == | ||
| − | wikEd is a javascript program that runs by default on all CAZypedia user accounts. Therefore, there's nothing to install or configure. All you need is a '''Mozilla browser''' (Firefox 1.5 or higher, Mozilla 1.3 or higher, or SeaMonkey) | + | [http://en.wikipedia.org/wiki/User:Cacycle/wikEd wikEd] is a javascript program that runs by default on all CAZypedia user accounts. Therefore, there's nothing to install or configure. All you need is a [http://www.mozilla.org/ '''Mozilla browser''' (Firefox 1.5 or higher, Mozilla 1.3 or higher, or SeaMonkey) with javascript enabled; ''Microsoft Internet Explorer and Opera Browser currently don't work with wikEd''. |
=== MediaWiki syntax === | === MediaWiki syntax === | ||
| Line 15: | Line 15: | ||
=== wikEd === | === wikEd === | ||
| − | wikEd can be used to add most of the markup listed on the pages above, and therefore greatly simplifies making and editing CAZypedia pages. Some current features include: | + | wikEd can be used to add most of the markup listed on the pages above, and therefore greatly simplifies making and editing CAZypedia pages. Some current features include (from the [http://en.wikipedia.org/wiki/User:Cacycle/wikEd main wikEd page]: |
| + | <blockquote> | ||
| − | Wikicode syntax highlighting | + | |
| − | Pasting, import, and conversion of formatted text, e.g. from Microsoft-Word and web pages | + | * Wikicode syntax highlighting |
| − | Regular expression search and replace | + | |
| − | Edit preview and show changes on the same page without reloading | + | |
| − | Fullscreen editing mode | + | * Pasting, import, and conversion of formatted text, e.g. from Microsoft-Word and web pages |
| − | Single-click fixing of common mistakes | + | * Regular expression search and replace |
| − | History for summary, search, and replace fields | + | * Edit preview and show changes on the same page without reloading |
| − | Jump to selected heading | + | * Fullscreen editing mode |
| − | Type-ahead find | + | * Single-click fixing of common mistakes |
| − | + | * History for summary, search, and replace fields | |
| − | + | * Jump to selected heading | |
| + | * Type-ahead find | ||
| + | |||
| + | </blockquote> | ||
| + | |||
| + | [http://en.wikipedia.org/wiki/User:Cacycle/wikEd_help The wikEd help page] contains a tutorial and full details on the function of all of the buttons in wikEd. | ||
| + | |||
| + | |||
| + | '''Although wikEd is both quite good and quite powerful, ''patiently'' bear in mind that you will have to understand the MediaWiki markup to fix things when they don't look ''quite'' right. Soon enough, editing pages in CAZypedia will become second nature.''' | ||
Revision as of 12:21, 13 May 2007
CAZypedia and WYSIWYG editing
The nature of the wiki format which forms the basis of CAZypedia does not lend itself very well to WYSIWYG (what you see is what you get) editing that most of us are used to. Unlike word processing software, where what you type is immediately formatted on the screen and later appears on the printed page, wiki editing is a bit more like making a web page. In the latter case, text is typed in an unformatted form, which is later formatted on the fly according to specific formatting "tags" embedded in the text itself.
The reasons wikis, and thus CAZYpedia, use this less user-friendly way are mainly technical, having to do with using a web browser as an input tool and a remote web server as the data storage device. People who are used to "mark-up" computer languages (like HTML) will have little trouble getting used to the wiki way of formatting text. To ease the pain for everyone else, CAZypedia implements an almost WYSIWYG editor called wikEd. wikEd was develped to make life easier for Wikipedia contributors, and since CAZypedia runs the same wiki software (MediaWiki), we can benefit from wikEd, too.
Using wikEd on CAZypedia
wikEd is a javascript program that runs by default on all CAZypedia user accounts. Therefore, there's nothing to install or configure. All you need is a [http://www.mozilla.org/ Mozilla browser (Firefox 1.5 or higher, Mozilla 1.3 or higher, or SeaMonkey) with javascript enabled; Microsoft Internet Explorer and Opera Browser currently don't work with wikEd.
MediaWiki syntax
MediaWiki is the engine that drives CAZypedia, rendering all of the ugly data into the nice-looking format that your web browser presents. These links provide an overview of the basic "markup" (formatting rules) that CAZypedia uses:
- Basic editing & markup
- More markup examples - including inserting pictures
- Advanced editing - all kinds of cool stuff, including making links, math, special characters, and templates.
wikEd
wikEd can be used to add most of the markup listed on the pages above, and therefore greatly simplifies making and editing CAZypedia pages. Some current features include (from the main wikEd page:
- Wikicode syntax highlighting
- Pasting, import, and conversion of formatted text, e.g. from Microsoft-Word and web pages
- Regular expression search and replace
- Edit preview and show changes on the same page without reloading
- Fullscreen editing mode
- Single-click fixing of common mistakes
- History for summary, search, and replace fields
- Jump to selected heading
- Type-ahead find
The wikEd help page contains a tutorial and full details on the function of all of the buttons in wikEd.
Although wikEd is both quite good and quite powerful, patiently bear in mind that you will have to understand the MediaWiki markup to fix things when they don't look quite right. Soon enough, editing pages in CAZypedia will become second nature.