ReNamer: Making of new manual

narayan · 2009-06-20 07:41

The first is better: If the left menus are not available to jump to any other random topic in the manual, we can reach there in two jumps: First jump to the top (the main page) and from there jump to the desired page.

The "title" can be the product name (ReNamer in this case).

The color scheme can be made purple (to match Renamer logo)

Last edited by narayan (2009-06-20 08:13)

narayan · 2009-06-20 07:54

Can the left menus be expandable/collapsible, like the explorer tree pane?

den4b · 2009-06-20 09:30

I have another idea, we can use the entire Help TOC as navigation at each page.

I have already created a template for ReNamer Help topics and put it in the first few rules. Check it out, it looks much better. And the current page will always be highlighted in the TOC because wiki does that to links which address the current page.

What do you think?

narayan · 2009-06-20 10:48

Like it!

BTW I have added all images (would be completed today).

I added some images twice by mistake, but there is no delete control.
I am linking all images as I add them.

So, after 2 days, you can remove all unused images safely.

****
How to search an image with some keyword?
All authors would need such a search (otherwise they will end up creating their own images and uploading essentially duplicate images).

Last edited by narayan (2009-06-20 11:05)

den4b · 2009-06-20 11:38

You can use Search function, and when it opens at the bottom of the page you can also tell it to search only "File" section. You can also browse "file list" in the special pages.

Normal users do are not allowed to delete pages, so I am going to create a template which will mark pages as "requested for deletion". In fact, I just did it. Put {{Delete}} at the top of the page which you want to delete.

den4b · 2009-06-20 11:51

Also, few things to note:

Files should have been prefixed with ReNamer, because other programs might need AddButton.png for example.
Words in uploaded file names should be separated with spaces, so they can be searched by words.
Table of contents will have to be edited in the template {{ReNamer Help}}, instead of section in the main page, which soon would be replaced by a template anyway.
Try to minimize the length of article names and make them more general, for example: "Placing files and folders in Renamer's work area" could be named "Adding files and folders".

narayan · 2009-06-20 13:06

Too late! Before I read that, I had already (almost) finished uploading and linking.

See if the files can be renamed without breaking the links. I have used the Each word Capitalized format, as spaces have given me huge problems in some network transfers (FTP), and I was not sure how Mediawiki handles them. So I went for the safest option.

But all is not lost: Since the wikified manuals for the other products are yet not started, you can implement this file-naming scheme there. The other product-names as prefix would distinguish them from the files for ReNamer (which do not have any prefix).

Last edited by narayan (2009-06-20 13:23)

narayan · 2009-06-20 13:21

BTW I modify the index on the main page, as I was not aware of any templates in use. In fact I wanted to alert you that the box you have used should be dynamically updated, so that any change in the main index reflects there.

The titles are short enough I guess. But at the same time the ribbon display in the title (showing the path till the root) does not look pretty. That should be obvious from the index (on the left), where the current page is in a different color (and the only entry without a hyperlink).

narayan · 2009-06-20 13:26

Idea! Move the entire html+png bunch to a separate Renamer folder. Start the other products in their own folders.

There is absolutely no benefit in mixing everything up in a single folder
(Even the forum for each product should have been separate for that matter).

*****
I have left some requests in the discussion tabs. 9e.g. need to rename a page from "Detailed use" to 'basic steps". In fact, I would rather name it "quick start" and delete the old "quick start" page.)

P.S. Denis, I tried to follow tips given for renaming a wiki page (it says use the move tab, and enter a new name.) This did rename the page, but I am unable to link it with the rest of the pages. Now the page is named Quick Guide.

Last edited by narayan (2009-06-20 17:23)

narayan · 2009-06-21 04:51

Hi all,

I have almost finished translating the manual into wiki; only some formatting corrections remain.

You can go ahead now and start editing the pages.

I have a doubt what to do with the pascal script topic. Another author has loaded pages which have a completely different approach to what I wrote in the manual. Mere editing won't give good results. Should I create my own pages, and then let Denis take his pick? Any ideas?

I have entered @@@ where some things are to be done yet.

Last edited by narayan (2009-06-21 09:06)

den4b Forum

#71 2009-06-20 07:41

Re: ReNamer: Making of new manual

#72 2009-06-20 07:54

Re: ReNamer: Making of new manual

#73 2009-06-20 09:30

Re: ReNamer: Making of new manual

#74 2009-06-20 10:48

Re: ReNamer: Making of new manual

#75 2009-06-20 11:38

Re: ReNamer: Making of new manual

#76 2009-06-20 11:51

Re: ReNamer: Making of new manual

#77 2009-06-20 13:06

Re: ReNamer: Making of new manual

#78 2009-06-20 13:21

Re: ReNamer: Making of new manual

#79 2009-06-20 13:26

Re: ReNamer: Making of new manual

#80 2009-06-21 04:51

Re: ReNamer: Making of new manual

Board footer