Difference between revisions of "Help:Editing/Readability"
(created) |
m (→Blank lines for better structuring: formattings) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 6: | Line 6: | ||
The IntactiWiki source code interpreter understands template data in various notations, such as: all parameters in one line, leading or missing blanks for parameters, etc. But the human eye likes a more splendid layout. Here's a bad and a good example for how to write templates: | The IntactiWiki source code interpreter understands template data in various notations, such as: all parameters in one line, leading or missing blanks for parameters, etc. But the human eye likes a more splendid layout. Here's a bad and a good example for how to write templates: | ||
| − | + | Bad: | |
<pre>{{REFweb|url=https://www.mediawiki.org/wiki/MediaWiki|title=MediaWiki|accessdate=2019-09-25}}</pre> | <pre>{{REFweb|url=https://www.mediawiki.org/wiki/MediaWiki|title=MediaWiki|accessdate=2019-09-25}}</pre> | ||
| − | + | Good: | |
<pre>{{REFweb | <pre>{{REFweb | ||
|url=https://www.mediawiki.org/wiki/MediaWiki | |url=https://www.mediawiki.org/wiki/MediaWiki | ||
| Line 19: | Line 19: | ||
Various IntactiWiki article sections can be created by using templates, like '''<nowiki>{{PUB}}</nowiki>''', '''<nowiki>{{SEEALSO}}</nowiki>''', '''<nowiki>{{LINKS}}</nowiki>''', '''<nowiki>{{REF}}</nowiki>''', etc. The relevant templates have been build in a way that the source text interpreter doesn't require leading blank lines for the templates to work properly. But it helps the human eye to see the structure of an article. | Various IntactiWiki article sections can be created by using templates, like '''<nowiki>{{PUB}}</nowiki>''', '''<nowiki>{{SEEALSO}}</nowiki>''', '''<nowiki>{{LINKS}}</nowiki>''', '''<nowiki>{{REF}}</nowiki>''', etc. The relevant templates have been build in a way that the source text interpreter doesn't require leading blank lines for the templates to work properly. But it helps the human eye to see the structure of an article. | ||
| − | + | Bad: | |
<pre>{{PUB}}* some content{SEEALSO}}*some seealso links{{LINKS}}* some external links{{REF}}</pre> | <pre>{{PUB}}* some content{SEEALSO}}*some seealso links{{LINKS}}* some external links{{REF}}</pre> | ||
| − | + | Good: | |
<pre>{{PUB}} | <pre>{{PUB}} | ||
* some content | * some content | ||
Latest revision as of 18:00, 22 March 2024
Perhaps you have already looked at the source code of a Wikipedia article. For people who do not speak any programming languages, such source code is often confusing and confusing.
In the IntactiWiki we try to make the source text more readable with some simple means.
One template parameter per line
The IntactiWiki source code interpreter understands template data in various notations, such as: all parameters in one line, leading or missing blanks for parameters, etc. But the human eye likes a more splendid layout. Here's a bad and a good example for how to write templates:
Bad:
{{REFweb|url=https://www.mediawiki.org/wiki/MediaWiki|title=MediaWiki|accessdate=2019-09-25}}
Good:
{{REFweb
|url=https://www.mediawiki.org/wiki/MediaWiki
|title=MediaWiki
|accessdate=2019-09-25
}}
Blank lines for better structuring
Various IntactiWiki article sections can be created by using templates, like {{PUB}}, {{SEEALSO}}, {{LINKS}}, {{REF}}, etc. The relevant templates have been build in a way that the source text interpreter doesn't require leading blank lines for the templates to work properly. But it helps the human eye to see the structure of an article.
Bad:
{{PUB}}* some content{SEEALSO}}*some seealso links{{LINKS}}* some external links{{REF}}
Good:
{{PUB}}
* some content
{SEEALSO}}
*some seealso links
{{LINKS}}
* some external links
{{REF}}