{"id":271,"date":"2011-06-12T19:31:19","date_gmt":"2011-06-12T18:31:19","guid":{"rendered":"http:\/\/lydgate.org\/blogs\/?p=271"},"modified":"2011-06-13T12:59:49","modified_gmt":"2011-06-13T11:59:49","slug":"make-it-easy-for-yourself","status":"publish","type":"post","link":"http:\/\/lydgate.org\/blogs\/2011\/06\/make-it-easy-for-yourself\/","title":{"rendered":"Make it Easy for Yourself"},"content":{"rendered":"<h1>You start to write about your application &#8211;<\/h1>\n<p>OK, you will need a front page and a couple of sub-pages &#8211; that doesn&#8217;t sound so bad, does it? \u00a0Many people have done just this on <a href=\"http:\/\/userbase.kde.org\">UserBase<\/a>. \u00a0Some write directly onto new pages, some are happier to draft their work first, so use sub-pages of their User-space pages, and that works fine. \u00a0With our without the help of the UserBase Admins, the content can then be pasted into the correct tree structure and the draft removed &#8211; and everyone&#8217;s happy. \u00a0But what if you want to write a whole manual?<\/p>\n<p>As the <a href=\"http:\/\/amarok.kde.org\/\">Amarok<\/a> team have discovered, it&#8217;s a whole new ball-game. \u00a0You start with a Contents page, listing all the pages you think you&#8217;ll need, and you start to build. \u00a0Before you finish I&#8217;ll guarantee that you&#8217;ve thought of something that would have been better on a page of its own. \u00a0As it happens, that&#8217;s not a big problem &#8211; you can edit the contents page and create a new page that way. \u00a0But wait &#8211; what seemed good organisation to start with is less convincing now, and maybe it would be better to move things around, re-organise a little. \u00a0Hmm &#8211; not so bad! \u00a0There&#8217;s a little icon for Move &#8211; ah yes, it moves the page to the structure you want and even leaves a re-direct behind, in case someone uses the old link.<\/p>\n<p>Sounds pretty good, doesn&#8217;t it? \u00a0Unfortunately this is where it starts to come unstuck. \u00a0Once you&#8217;ve finished, the Translators move in &#8211; and where should their links point? \u00a0If they translate from the original they probably will use the original link, which is now a re-direct. \u00a0That&#8217;s not good. \u00a0We have to clean up re-directs, in that case, and that&#8217;s when we find that moved pages have been moved yet again, causing double-redirects &#8211; an even bigger job for cleaning up. \u00a0You see, we can&#8217;t just delete them &#8211; there could be a number of pages that link to the old page, so we have to track all links, and in the case of the double-redirect we have to do that for both levels of old pages. \u00a0It can be quite difficult to follow, but it&#8217;s a necessary part. \u00a0Happily we have almost finished the double-redirects &#8211; heaven preserve us from triple-redirects!<\/p>\n<h1>&#8220;So you said I could make it easy for myself?&#8221;<\/h1>\n<p>We think so. \u00a0It&#8217;s experimental, yes, but it should help anyone starting new documentation. \u00a0Most of what you see on UserBase is in the &#8220;Main&#8221; namespace, but today we have opened up a new namespace called &#8220;Draft&#8221;. \u00a0You can start your documentation there without worrying about the issues I&#8217;ve just talked about. \u00a0Move things around as much as you like &#8211; just remember that in the end any page links will need sorting!<\/p>\n<p>The idea is that when the pages are ready we can simply move the whole structure into the Main namespace if any redirects have been dealt with, but if it has proved more complex and things have been moved around a lot we can use Copy\/Paste to create the Main pages from the Draft ones, fixing links as we go and losing all the redirects on the way.<\/p>\n<p>One last thing &#8211; you have to be the main writer for your documentation, and you are used to an entirely different kind of mark-up, finding that attempting Mediawiki mark-up gets you utterly confused. \u00a0We can handle that too &#8211; and again the Draft namespace is the best place to do it. \u00a0Put your plain text there. \u00a0Add any markup that will be obvious to us, for instance &lt;bullets&gt;, \u00a0and we will help you get it looking the way you want.<\/p>\n<p>Using Draft\u00a0<a href=\"http:\/\/userbase.kde.org\/Draft:Draft\"><\/a> should remove a good deal of anxiety and hassle, but we need you to try it out. \u00a0Take a look at <a href=\"http:\/\/userbase.kde.org\/Draft:Draft\">Draft<\/a> and let us know what you need to make it even better for you to draft your documentaion. \u00a0See you there!<\/p>\n<p>&nbsp;<\/p>\n<p><a href=\"http:\/\/lydgate.org\/blogs\/wp-content\/uploads\/2011\/06\/UserBaseLogo.png\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-272\" title=\"UserBaseLogo\" src=\"http:\/\/lydgate.org\/blogs\/wp-content\/uploads\/2011\/06\/UserBaseLogo.png\" alt=\"\" width=\"204\" height=\"64\" \/><\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>You start to write about your application &#8211; OK, you will need a front page and a couple of sub-pages &#8211; that doesn&#8217;t sound so bad, does it? \u00a0Many people have done just this on UserBase. \u00a0Some write directly onto new pages, some are happier to draft their work first, so use sub-pages of their [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[14,6],"class_list":["post-271","post","type-post","status-publish","format-standard","hentry","category-kde","tag-kde","tag-userbase"],"_links":{"self":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts\/271","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/comments?post=271"}],"version-history":[{"count":8,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts\/271\/revisions"}],"predecessor-version":[{"id":282,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/posts\/271\/revisions\/282"}],"wp:attachment":[{"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/media?parent=271"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/categories?post=271"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/lydgate.org\/blogs\/wp-json\/wp\/v2\/tags?post=271"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}