CINXE.COM

tips:good_style [DokuWiki]

<!DOCTYPE html> <html lang="en" dir="ltr" class="no-js"> <head> <meta charset="utf-8" /> <title>tips:good_style [DokuWiki]</title> <meta name="generator" content="DokuWiki"/> <meta name="theme-color" content="#008800"/> <meta name="robots" content="index,follow"/> <meta name="keywords" content="tips,good_style"/> <link rel="search" type="application/opensearchdescription+xml" href="/lib/exe/opensearch.php" title="DokuWiki"/> <link rel="start" href="/"/> <link rel="contents" href="/tips:good_style?do=index" title="Sitemap"/> <link rel="manifest" href="/lib/exe/manifest.php"/> <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/feed.php"/> <link rel="alternate" type="application/rss+xml" title="Current namespace" href="/feed.php?mode=list&amp;ns=tips"/> <link rel="edit" title="Edit this page" href="/tips:good_style?do=edit"/> <link rel="alternate" type="text/html" title="Plain HTML" href="/_export/xhtml/tips:good_style"/> <link rel="alternate" type="text/plain" title="Wiki Markup" href="/_export/raw/tips:good_style"/> <link rel="canonical" href="https://www.dokuwiki.org/tips:good_style"/> <link rel="stylesheet" href="/lib/exe/css.php?t=dokuwiki&amp;tseed=f1005bad3d81fc9c803c7f93d32a390e"/> <link rel="alternate" hreflang="de" href="https://www.dokuwiki.org/de:tips:good_style"/> <link rel="alternate" hreflang="el" href="https://www.dokuwiki.org/el:tips:good_style"/> <link rel="alternate" hreflang="es" href="https://www.dokuwiki.org/es:tips:good_style"/> <link rel="alternate" hreflang="fr" href="https://www.dokuwiki.org/fr:tips:good_style"/> <link rel="alternate" hreflang="it" href="https://www.dokuwiki.org/it:tips:good_style"/> <link rel="alternate" hreflang="ja" href="https://www.dokuwiki.org/ja:tips:good_style"/> <link rel="alternate" hreflang="ko" href="https://www.dokuwiki.org/ko:tips:good_style"/> <link rel="alternate" hreflang="nl" href="https://www.dokuwiki.org/nl:tips:good_style"/> <link rel="alternate" hreflang="pl" href="https://www.dokuwiki.org/pl:tips:good_style"/> <link rel="alternate" hreflang="pt-br" href="https://www.dokuwiki.org/pt-br:tips:good_style"/> <link rel="alternate" hreflang="ru" href="https://www.dokuwiki.org/ru:tips:good_style"/> <link rel="alternate" hreflang="zh" href="https://www.dokuwiki.org/zh:tips:good_style"/> <link rel="alternate" hreflang="zh-tw" href="https://www.dokuwiki.org/zh-tw:tips:good_style"/> <link rel="alternate" hreflang="x-default" href="https://www.dokuwiki.org/tips:good_style"/> <script >var NS='tips';var JSINFO = {"plugins":{"edittable":{"default columnwidth":""}},"id":"tips:good_style","namespace":"tips","ACT":"show","useHeadingNavigation":0,"useHeadingContent":0};(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement);</script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.4/jquery.min.js" defer="defer"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js" defer="defer"></script> <script src="/lib/exe/js.php?t=dokuwiki&amp;tseed=f1005bad3d81fc9c803c7f93d32a390e&amp;lang=en" defer="defer"></script> <meta name="viewport" content="width=device-width,initial-scale=1" /> <link rel="shortcut icon" href="/lib/tpl/dokuwiki/images/favicon.ico" /> <link rel="apple-touch-icon" href="/lib/tpl/dokuwiki/images/apple-touch-icon.png" /> <meta name="verify-v1" content="OVxl3gsCv2MhZqh1cBQyl0JytWXSwXMjyvwc+4w3WtA=" /> <meta name="google-site-verification" content="YhTVK69hW94ZXUtc2zSLPxTkZKbZIn0zK67mz5WQB-E" /> <!-- Global site tag (gtag.js) - Google Analytics --> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-83791-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-83791-1', { 'anonymize_ip': true }); </script> </head> <body> <div id="dokuwiki__site"><div id="dokuwiki__top" class="site dokuwiki mode_show tpl_dokuwiki showSidebar hasSidebar"> <!-- ********** HEADER ********** --> <header id="dokuwiki__header"><div class="pad group"> <div class="headings group"> <ul class="a11y skip"> <li><a href="#dokuwiki__content">skip to content</a></li> </ul> <h1 class="logo"><a href="/start" accesskey="h" title="Home [h]"><img src="/lib/tpl/dokuwiki/images/logo.png" width="64" height="64" alt="" /><span>DokuWiki</span></a></h1> <p class="claim">It's better when it's simple</p> </div> <div class="tools group"> <!-- USER TOOLS --> <div id="dokuwiki__usertools"> <h3 class="a11y">User Tools</h3> <ul> <li class="action login"><a href="/tips:good_style?do=login&amp;sectok=" title="Log In" rel="nofollow"><span>Log In</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10 17.25V14H3v-4h7V6.75L15.25 12 10 17.25M8 2h9a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2v-4h2v4h9V4H8v4H6V4a2 2 0 0 1 2-2z"/></svg></a></li> </ul> </div> <!-- SITE TOOLS --> <div id="dokuwiki__sitetools"> <h3 class="a11y">Site Tools</h3> <form action="/start" method="get" role="search" class="search doku_form" id="dw__search" accept-charset="utf-8"><input type="hidden" name="do" value="search" /><input type="hidden" name="id" value="tips:good_style" /><div class="no"><input name="q" type="text" class="edit" title="[F]" accesskey="f" placeholder="Search" autocomplete="on" id="qsearch__in" value="" /><button value="1" type="submit" title="Search">Search</button><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form> <div class="mobileTools"> <form action="/doku.php" method="get" accept-charset="utf-8"><div class="no"><input type="hidden" name="id" value="tips:good_style" /><select name="do" class="edit quickselect" title="Tools"><option value="">Tools</option><optgroup label="Page Tools"><option value="edit">Edit this page</option><option value="revisions">Old revisions</option><option value="backlink">Backlinks</option></optgroup><optgroup label="Site Tools"><option value="recent">Recent Changes</option><option value="media">Media Manager</option><option value="index">Sitemap</option></optgroup><optgroup label="User Tools"><option value="login">Log In</option></optgroup></select><button type="submit">&gt;</button></div></form> </div> <ul> <li class="action recent"><a href="/tips:good_style?do=recent" title="Recent Changes [r]" rel="nofollow" accesskey="r">Recent Changes</a></li><li class="action media"><a href="/tips:good_style?do=media&amp;ns=tips" title="Media Manager" rel="nofollow">Media Manager</a></li><li class="action index"><a href="/tips:good_style?do=index" title="Sitemap [x]" rel="nofollow" accesskey="x">Sitemap</a></li> </ul> </div> </div> <!-- BREADCRUMBS --> <div class="breadcrumbs"> <div class="trace"><span class="bchead">Trace:</span> <span class="bcsep">•</span> <span class="curid"><bdi><a href="/tips:good_style" class="breadcrumbs" title="tips:good_style">good_style</a></bdi></span></div> </div> <hr class="a11y" /> </div></header><!-- /header --> <div class="wrapper group"> <!-- ********** ASIDE ********** --> <nav id="dokuwiki__aside" aria-label="Sidebar"><div class="pad aside include group"> <h3 class="toggle">Sidebar</h3> <div class="content"><div class="group"> <div class="plugin_translation is-dropdown"><span class="title">Translations of this page<sup><a href="/localization" class="wikilink1" title="localization" data-wiki-id="localization">?</a></sup>: </span><ul><li class="span"><span class="wikilink1" title="English">English (en)</span></li><li class="a"><a class="wikilink2" title="|العربية" href="/ar:tips:good_style">|العربية (ar)</a></li><li class="a"><a class="wikilink2" title="Català" href="/ca:tips:good_style">Català (ca)</a></li><li class="a"><a class="wikilink2" title="Česky" href="/cs:tips:good_style">Česky (cs)</a></li><li class="a"><a class="wikilink2" title="Dansk" href="/da:tips:good_style">Dansk (da)</a></li><li class="a"><a class="wikilink1" title="Deutsch" href="/de:tips:good_style">Deutsch (de)</a></li><li class="a"><a class="wikilink1" title="Ελληνικά" href="/el:tips:good_style">Ελληνικά (el)</a></li><li class="a"><a class="wikilink2" title="Esperanto" href="/eo:tips:good_style">Esperanto (eo)</a></li><li class="a"><a class="wikilink1" title="Español" href="/es:tips:good_style">Español (es)</a></li><li class="a"><a class="wikilink2" title="فارسی" href="/fa:tips:good_style">فارسی (fa)</a></li><li class="a"><a class="wikilink1" title="Français" href="/fr:tips:good_style">Français (fr)</a></li><li class="a"><a class="wikilink2" title="עברית" href="/he:tips:good_style">עברית (he)</a></li><li class="a"><a class="wikilink2" title="Magyar" href="/hu:tips:good_style">Magyar (hu)</a></li><li class="a"><a class="wikilink1" title="Italiano" href="/it:tips:good_style">Italiano (it)</a></li><li class="a"><a class="wikilink1" title="日本語" href="/ja:tips:good_style">日本語 (ja)</a></li><li class="a"><a class="wikilink1" title="한국어" href="/ko:tips:good_style">한국어 (ko)</a></li><li class="a"><a class="wikilink2" title="Lietuvių Kalba" href="/lt:tips:good_style">Lietuvių Kalba (lt)</a></li><li class="a"><a class="wikilink1" title="Nederlands" href="/nl:tips:good_style">Nederlands (nl)</a></li><li class="a"><a class="wikilink2" title="Norsk" href="/no:tips:good_style">Norsk (no)</a></li><li class="a"><a class="wikilink1" title="Polski" href="/pl:tips:good_style">Polski (pl)</a></li><li class="a"><a class="wikilink1" title="Português" href="/pt-br:tips:good_style">Português (pt-br)</a></li><li class="a"><a class="wikilink2" title="Română" href="/ro:tips:good_style">Română (ro)</a></li><li class="a"><a class="wikilink1" title="Русский" href="/ru:tips:good_style">Русский (ru)</a></li><li class="a"><a class="wikilink2" title="Српски Језик" href="/sr:tips:good_style">Српски Језик (sr)</a></li><li class="a"><a class="wikilink2" title="Svenska" href="/sv:tips:good_style">Svenska (sv)</a></li><li class="a"><a class="wikilink2" title="ไทย" href="/th:tips:good_style">ไทย (th)</a></li><li class="a"><a class="wikilink2" title="Українська" href="/uk:tips:good_style">Українська (uk)</a></li><li class="a"><a class="wikilink1" title="中文" href="/zh:tips:good_style">中文 (zh)</a></li><li class="a"><a class="wikilink1" title="繁體中文" href="/zh-tw:tips:good_style">繁體中文 (zh-tw)</a></li></ul></div> <p> <strong>Learn about DokuWiki</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/features" class="wikilink1" title="features" data-wiki-id="features">Features</a> &amp; <a href="/blogroll" class="wikilink1" title="blogroll" data-wiki-id="blogroll">reviews</a> </div> </li> <li class="level1"><div class="li"> <a href="/install" class="wikilink1" title="install" data-wiki-id="install">Installation guide</a></div> </li> <li class="level1"><div class="li"> <a href="/manual" class="wikilink1" title="manual" data-wiki-id="manual">User manual</a> &amp; <a href="/wiki:syntax" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">syntax</a></div> </li> <li class="level1"><div class="li"> <a href="/changes" class="wikilink1" title="changes" data-wiki-id="changes">Release notes</a></div> </li> <li class="level1"><div class="li"> <a href="/faq" class="wikilink1" title="faq" data-wiki-id="faq">FAQ</a></div> </li> </ul> <p> <strong>Advanced Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/extensions" class="wikilink1" title="extensions" data-wiki-id="extensions">Extensions</a></div> </li> <li class="level1"><div class="li"> <a href="/development" class="wikilink1" title="development" data-wiki-id="development">Development manual</a></div> </li> </ul> <p> <strong>Corporate Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/faq:support" class="wikilink1" title="faq:support" data-wiki-id="faq:support">Get support</a></div> </li> <li class="level1"><div class="li"> <a href="/donate" class="wikilink1" title="donate" data-wiki-id="donate">Donations</a></div> </li> </ul> <p> <strong>Our Community</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/teams:getting_involved" class="wikilink1" title="teams:getting_involved" data-wiki-id="teams:getting_involved">Get involved</a></div> </li> <li class="level1"><div class="li"> <a href="/dokuinstall" class="wikilink1" title="dokuinstall" data-wiki-id="dokuinstall">Users</a></div> </li> <li class="level1"><div class="li"> <a href="http://forum.dokuwiki.org" class="urlextern" title="http://forum.dokuwiki.org">User forum</a></div> </li> <li class="level1"><div class="li"> <a href="/mailinglist" class="wikilink1" title="mailinglist" data-wiki-id="mailinglist">Development mailinglist</a></div> </li> </ul> <hr /> <p> Follow us on <a href="https://phpc.social/@dokuwiki" class="urlextern" title="https://phpc.social/@dokuwiki">Mastodon</a> and other <a href="/social" class="wikilink1" title="social" data-wiki-id="social">social networks</a>. </p> <p> <a href="/privacy" class="wikilink1" title="privacy" data-wiki-id="privacy">Our Privacy Policy</a> </p> </div></div> </div></nav><!-- /aside --> <!-- ********** CONTENT ********** --> <main id="dokuwiki__content"><div class="pad group"> <div class="pageId"><span>tips:good_style</span></div> <div class="page group"> <!-- wikipage start --> <!-- TOC START --> <div id="dw__toc" class="dw__toc"> <h3 class="toggle">Table of Contents</h3> <div> <ul class="toc"> <li class="level1"><div class="li"><a href="#hints_on_good_style">Hints on good style</a></div> <ul class="toc"> <li class="level2"><div class="li"><a href="#page_structures">Page structures</a></div></li> <li class="level2"><div class="li"><a href="#text_formatting">Text formatting</a></div></li> <li class="level2"><div class="li"><a href="#language">Language</a></div></li> <li class="level2"><div class="li"><a href="#references">References</a></div></li> <li class="level2"><div class="li"><a href="#images_and_other_media">Images and other media</a></div></li> </ul></li> </ul> </div> </div> <!-- TOC END --> <h1 class="sectionedit1" id="hints_on_good_style">Hints on good style</h1> <div class="level1"> <p> These are a few hints on how to write a good wiki page. See also our <a href="/tips:good_content" class="wikilink1" title="tips:good_content" data-wiki-id="tips:good_content">hints on good content</a>. </p> </div> <div class="secedit editbutton_section editbutton_1"><form class="button btn_secedit" method="post" action="/tips:good_style"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1640658827" /><input type="hidden" name="summary" value="[Hints on good style] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="hints_on_good_style" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1-151" /><button type="submit" title="Hints on good style">Edit</button></div></form></div> <h2 class="sectionedit2" id="page_structures">Page structures</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> Begin your page with a first level heading with a meaningful title.</div> </li> <li class="level1"><div class="li"> Nest headline levels in their correct order, sections in the second level should start with a second level headline.</div> </li> <li class="level1"><div class="li"> Break up your text in paragraphs by leaving an empty line between them. An average paragraph should not be longer than 10-20 lines.</div> </li> <li class="level1"><div class="li"> If your text is longer than a few (3-5) paragraphs, consider dividing it up into <a href="/wiki:syntax#sectioning" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">sections</a> by adding second-to-fifth level headings.</div> </li> <li class="level1"><div class="li"> When your text gets longer than 2-3 screen pages, put a short abstract of the contents of the page after the first heading. When your page gets significantly longer consider splitting it up in multiple pages.</div> </li> <li class="level1"><div class="li"> If you have many links to other wiki pages or external resources, add a special section with further references (see <a href="#references" title="tips:good_style ↵" class="wikilink1">below</a>).</div> </li> <li class="level1"><div class="li"> If most of the pages of a <a href="/namespaces" class="wikilink1" title="namespaces" data-wiki-id="namespaces">namespace</a> share a common structure add a <a href="/namespace_templates" class="wikilink1" title="namespace_templates" data-wiki-id="namespace_templates">namespace template</a> so any new page can begin with that skeleton structure.</div> </li> <li class="level1"><div class="li"> Try to avoid overcomplicated namespace structures. Try to use short, easy to remember namespace names.</div> </li> <li class="level1"><div class="li"> Consider utilizing the <a href="/plugin:qc" class="wikilink1" title="plugin:qc" data-wiki-id="plugin:qc">Quality Check Plugin</a> as a wiki owner or contributor to assist in page structure and text formatting. </div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_2"><form class="button btn_secedit" method="post" action="/tips:good_style"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1640658827" /><input type="hidden" name="summary" value="[Page structures] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="page_structures" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="152-1439" /><button type="submit" title="Page structures">Edit</button></div></form></div> <h2 class="sectionedit3" id="text_formatting">Text formatting</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> Emphasize single words or short passages of text by using <strong>bold</strong> or <em>italics</em>. Choose one of them and stick to your choice.</div> </li> <li class="level1"><div class="li"> Choose a style for representing screen output and text on the screen like buttons or menu labels and use it consistently. It might be a good idea to add a page with an explanation of your style conventions to your wiki.</div> </li> <li class="level1"><div class="li"> Use <a href="/wiki:syntax#lists" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">unordered lists</a> for statements that are independent of each other. If you are developing a line of thought, write in a continuous sequence of sentences.</div> </li> <li class="level1"><div class="li"> Use <a href="/wiki:syntax#footnotes" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">footnotes</a> sparingly and only for very short additional remarks. If there is much more to say on a specific topic, put it on a new wiki page. If you want to refer to other (external) information sources, use <a href="/wiki:syntax#links" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">links</a> instead.</div> </li> <li class="level1"><div class="li"> Tables can greatly enhance the readability of structured data. If you insert a table, make sure it has meaningful cell headers and provide a caption that clearly states the contents of the table (e.g. “Table 1.2: Average distances between the planets”).</div> </li> <li class="level1"><div class="li"> Large tables tend to be very hard to edit. Consider representing its data in a nested list instead.</div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_3"><form class="button btn_secedit" method="post" action="/tips:good_style"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1640658827" /><input type="hidden" name="summary" value="[Text formatting] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="text_formatting" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1440-2651" /><button type="submit" title="Text formatting">Edit</button></div></form></div> <h2 class="sectionedit4" id="language">Language</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> Write proper sentences and use articles for nouns when necessary.</div> </li> <li class="level1"><div class="li"> Begin each sentence with a capital letter and end it with a full stop or other appropriate punctuation.</div> </li> <li class="level1"><div class="li"> Try to write short, clear sentences without too much recourse to subordinate clauses. When you think that you have finished your page, read it again and revise any sentence that has an overly complicated structure.</div> </li> <li class="level1"><div class="li"> Decide on how to address your readers. Since DokuWiki is geared towards writing documentation, you will often have to instruct your readers, how to do certain things. You can use the <em>imperative</em> form (“<em>Do</em> this!”), the <em>we/you</em> form (“Then <em>we/you</em> click on…”) or the <em>I</em> form (“<em>I</em> then add the foo to bar, using…”). Do not mix these forms.</div> </li> <li class="level1"><div class="li"> Check your page for grammatical or spelling errors before saving it. If your text shows many errors, it will decrease the credibility of your statements, regardless of how well-thought they may be.</div> </li> <li class="level1"><div class="li"> Develop your own style. Don&#039;t force yourself to write in a manner you are not comfortable with. This would only sound unnatural and be unpleasant to read.</div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_4"><form class="button btn_secedit" method="post" action="/tips:good_style"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1640658827" /><input type="hidden" name="summary" value="[Language] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="language" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="2652-3795" /><button type="submit" title="Language">Edit</button></div></form></div> <h2 class="sectionedit5" id="references">References</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> When you come across a term that needs more explanation, add a new wiki page for the term and link to it.</div> </li> <li class="level1"><div class="li"> Re-check your page before you finish it, and add links to existing wiki pages to the central terms of your page.</div> </li> <li class="level1"><div class="li"> Don&#039;t add a link to every occurrence of a specific term. Make the first/most prominent occurrence on the page a link and maybe add a link to the reference section.</div> </li> <li class="level1"><div class="li"> Provide links to the sources of images, data and quotes.</div> </li> <li class="level1"><div class="li"> Consider adding a “See also:” line at the end of your page. Provide links to wiki pages that are <em>closely</em> related to the topic of your page there.</div> </li> <li class="level1"><div class="li"> If you want to give pointers to external resources that have further information on your topic or that you used in writing your page, add a section called “References” or “Further information” at the end and give a list of links or other pointers (e.g. ISBN numbers). If you have not already done so in the main text, state the intent of the reference.</div> </li> <li class="level1"><div class="li"> Setting up <a href="/interwiki" class="wikilink1" title="interwiki" data-wiki-id="interwiki">interwiki</a> shortcuts can help with linking to common resources.</div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_5"><form class="button btn_secedit" method="post" action="/tips:good_style"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1640658827" /><input type="hidden" name="summary" value="[References] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="references" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="3796-4870" /><button type="submit" title="References">Edit</button></div></form></div> <h2 class="sectionedit6" id="images_and_other_media">Images and other media</h2> <div class="level2"> <ul> <li class="level1"><div class="li"> “An image says more than a thousand words.” It might even mean <em>more than you intended</em> to say.<sup><a href="#fn__1" id="fnt__1" class="fn_top">1)</a></sup> Humans tend to question the authenticity of images less than that of language. A short textual description is better than an inaccurate picture.</div> </li> <li class="level1"><div class="li"> As with tables, always provide a caption for images, that states what you want to show with the image.</div> </li> <li class="level1"><div class="li"> If you did not create the picture yourself, state the source (possibly with a link) and the copyright.</div> </li> <li class="level1"><div class="li"> Don&#039;t link images from external sites, unless when allowed to do so explicitly. This is firstly a matter of copyright but can also be a matter of bandwidth stealing when <a href="/config:fetchsize" class="wikilink1" title="config:fetchsize" data-wiki-id="config:fetchsize">caching for external images</a> is disabled.</div> </li> <li class="level1"><div class="li"> If the picture is bigger than roughly a third of a screen page, use a <a href="/wiki:syntax#media_files" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">link with resizing instructions</a> to insert a thumbnail.</div> </li> </ul> </div> <div class="secedit editbutton_section editbutton_6"><form class="button btn_secedit" method="post" action="/tips:good_style"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1640658827" /><input type="hidden" name="summary" value="[Images and other media] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="images_and_other_media" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="4871-" /><button type="submit" title="Images and other media">Edit</button></div></form></div><div class="footnotes"> <div class="fn"><sup><a href="#fnt__1" id="fn__1" class="fn_bot">1)</a></sup> <div class="content">Also, you can not express this quote as a picture, can you?</div></div> </div> <!-- wikipage stop --> </div> <div class="docInfo"><bdi>tips/good_style.txt</bdi> · Last modified: <time datetime="2021-12-28T03:33:47+0100">2021-12-28 03:33</time> by <bdi>andi</bdi></div> <hr class="a11y" /> </div></main><!-- /content --> <!-- PAGE ACTIONS --> <nav id="dokuwiki__pagetools" aria-labelledby="dokuwiki__pagetools__heading"> <h3 class="a11y" id="dokuwiki__pagetools__heading">Page Tools</h3> <div class="tools"> <ul> <li class="edit"><a href="/tips:good_style?do=edit" title="Edit this page [e]" rel="nofollow" accesskey="e"><span>Edit this page</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg></a></li><li class="revs"><a href="/tips:good_style?do=revisions" title="Old revisions [o]" rel="nofollow" accesskey="o"><span>Old revisions</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M11 7v5.11l4.71 2.79.79-1.28-4-2.37V7m0-5C8.97 2 5.91 3.92 4.27 6.77L2 4.5V11h6.5L5.75 8.25C6.96 5.73 9.5 4 12.5 4a7.5 7.5 0 0 1 7.5 7.5 7.5 7.5 0 0 1-7.5 7.5c-3.27 0-6.03-2.09-7.06-5h-2.1c1.1 4.03 4.77 7 9.16 7 5.24 0 9.5-4.25 9.5-9.5A9.5 9.5 0 0 0 12.5 2z"/></svg></a></li><li class="backlink"><a href="/tips:good_style?do=backlink" title="Backlinks" rel="nofollow"><span>Backlinks</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10.59 13.41c.41.39.41 1.03 0 1.42-.39.39-1.03.39-1.42 0a5.003 5.003 0 0 1 0-7.07l3.54-3.54a5.003 5.003 0 0 1 7.07 0 5.003 5.003 0 0 1 0 7.07l-1.49 1.49c.01-.82-.12-1.64-.4-2.42l.47-.48a2.982 2.982 0 0 0 0-4.24 2.982 2.982 0 0 0-4.24 0l-3.53 3.53a2.982 2.982 0 0 0 0 4.24m2.82-4.24c.39-.39 1.03-.39 1.42 0a5.003 5.003 0 0 1 0 7.07l-3.54 3.54a5.003 5.003 0 0 1-7.07 0 5.003 5.003 0 0 1 0-7.07l1.49-1.49c-.01.82.12 1.64.4 2.43l-.47.47a2.982 2.982 0 0 0 0 4.24 2.982 2.982 0 0 0 4.24 0l3.53-3.53a2.982 2.982 0 0 0 0-4.24.973.973 0 0 1 0-1.42z"/></svg></a></li><li class="top"><a href="#dokuwiki__top" title="Back to top [t]" rel="nofollow" accesskey="t"><span>Back to top</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg></a></li> </ul> </div> </nav> </div><!-- /wrapper --> <!-- ********** FOOTER ********** --> <footer id="dokuwiki__footer"><div class="pad"> <div class="license">Except where otherwise noted, content on this wiki is licensed under the following license: <bdi><a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license" class="urlextern">CC Attribution-Share Alike 4.0 International</a></bdi></div> <div class="buttons"> <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license"><img src="/lib/images/license/button/cc-by-sa.png" alt="CC Attribution-Share Alike 4.0 International" /></a> <a href="https://www.dokuwiki.org/donate" title="Donate" ><img src="/lib/tpl/dokuwiki/images/button-donate.gif" width="80" height="15" alt="Donate" /></a> <a href="https://php.net" title="Powered by PHP" ><img src="/lib/tpl/dokuwiki/images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a> <a href="//validator.w3.org/check/referer" title="Valid HTML5" ><img src="/lib/tpl/dokuwiki/images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a> <a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" ><img src="/lib/tpl/dokuwiki/images/button-css.png" width="80" height="15" alt="Valid CSS" /></a> <a href="https://dokuwiki.org/" title="Driven by DokuWiki" ><img src="/lib/tpl/dokuwiki/images/button-dw.png" width="80" height="15" alt="Driven by DokuWiki" /></a> </div> <div style="margin-top: 2em; font-size:90%" class="dokuwiki"><div style="float:right"><a href="http://www.splitbrain.org/personal#imprint" style="float:right; text-decoration: none; color:#333">Imprint</a></div></div><!-- Include for DokuWiki site wide top bar --> <style type="text/css"> @media screen { body { padding-top: 30px; } #global__header { position: absolute; top: 0; left: 0; text-align: left; vertical-align: middle; line-height: 1.5; background-color: #333; box-shadow: 0 0 8px rgba(0,0,0,0.5); width: 100%; margin: 0; padding: 5px 20px; -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; white-space: nowrap; overflow: hidden; } #global__header h2 { position: absolute; left: -99999em; top: 0; overflow: hidden; display: inline; } #global__header ul, #global__header li { margin: 0; padding: 0; list-style: none; display: inline; line-height: 1.5; } #global__header a { color: #bbb; text-decoration: none; margin-right: 20px; font-size: 14px; font-weight: normal; } #global__header a:hover, #global__header a:active, #global__header a:focus { color: #fff; text-decoration: underline; } #global__header form { float: right; margin: 0 0 0 20px; } #global__header input { background-color: #333; background-image: none; border: 1px solid #bbb; color: #fff; box-shadow: none; border-radius: 2px; margin: 0; line-height: normal; padding: 1px 0 1px 0; height: auto; } #global__header input.button { border: none; color: #bbb; } #global__header input.button:hover, #global__header input.button:active, #global__header input.button:focus { color: #fff; text-decoration: underline; } } /* /@media */ @media only screen and (min-width: 601px) { /* changes specific for www.dokuwiki.org */ #dokuwiki__header { padding-top: 3em; } #dokuwiki__usertools { top: 3em; } /* changes specific for bugs.dokuwiki.org */ div#container div#showtask { top: 40px; } } /* /@media */ @media only screen and (max-width: 600px) { body { padding-top: 0; } #global__header { position: static; white-space: normal; overflow: auto; } #global__header form { float: none; display: block; margin: 0 0 .4em; } } /* /@media */ @media print { #global__header { display: none; } } /* /@media */ </style> <div id="global__header"> <h2>Global DokuWiki Links</h2> <form method="get" action="https://search.dokuwiki.org/" target="_top"> <input type="text" name="q" title="Search all DokuWiki sites at once" class="input" /> <input type="submit" title="Search all DokuWiki sites at once" value="Search" class="button" /> </form> <ul> <li><a href="https://download.dokuwiki.org" title="Download the latest release" target="_top">Download</a></li> <li><a href="https://www.dokuwiki.org" title="Read the DokuWiki documentation" target="_top">Wiki</a></li> <li><a href="https://forum.dokuwiki.org" title="Ask questions in the DokuWiki forum" target="_top">Forum</a></li> <li><a href="https://irc.dokuwiki.org" title="Check IRC chat logs or join the chat" target="_top">IRC</a></li> <li><a href="https://github.com/splitbrain/dokuwiki/issues" title="Report and track bugs" target="_top">Bugs</a></li> <li><a href="https://translate.dokuwiki.org/" title="Help translating the DokuWiki interface" target="_top">Translate</a></li> <li><a href="https://github.com/splitbrain/dokuwiki" title="Access the most recent git commits" target="_top">Git</a></li> <li><a href="https://xref.dokuwiki.org/reference/dokuwiki/" title="Cross-Reference of the DokuWiki source code" target="_top">XRef</a></li> <li><a href="https://codesearch.dokuwiki.org/" title="Search through the sources of DokuWiki, plugins and templates" target="_top">Code Search</a></li> </ul> </div> <!-- end of DokuWiki top bar include --> </div></footer><!-- /footer --> </div></div><!-- /site --> <div class="no"><img src="/lib/exe/taskrunner.php?id=tips%3Agood_style&amp;1742678114" width="2" height="1" alt="" /></div> <div id="screen__mode" class="no"></div></body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10