How about starting to split-off the FAQ into sub-pages?

From OpenFOAMWiki
Fragment of a discussion from Talk:Main FAQ

Hi!

Good idea. Could I propose something. The conventions on this page this page need some reworking anyway. They were written before I know about the concept of sub-pages and never reworked since. The reworking is on me. But what I'd suggest is the following. Let's start a new page FAQ and make subpages FAQ/Paraview etc to that. Copy over the stuff from the old page and leave the old page intact (that way the links will still work). On the page add a reference to the new FAQ-structure and a remark that this information is outdated and they should go there. Move the new structure into the sidebar and make the old page read-only

The only "problem" would be to have a consistent table of contents for the FAQ. I'll have to think about that

Bernhard

PS: It just occurred to me that using the Semantic-Wiki functionality it would be possible to have "long FAQ" with all questions on one page (I love those) in parallel to the small pages. Just every FAQ-subpage has to be marked with a property (for instance faqChapterNumber). The faqLong will be nothing else than an "include all pages with property faqChapterNumber ordered by faqChapterNumber (but it won't work to replace Main_FAQ with this. The links mentioned above will probably be broken anyway)

Bgschaid (talk)17:53, 14 September 2013

Hi Bernhard,

OK, I'm in! If you can pre-up a quick example with the Semantic-thingamabob for the new FAQ + FAQ/ParaView, I'll populate it with some heavy-duty copy-pasting mission :)

Best regards, Bruno

Wyldckat (talk)21:53, 14 September 2013

I've added a page FAQ and FAQLong which are basically queries. The page FAQ/General is the first section of the old Main_FAQ copied over. The way stuff looks needs some work:

  • in FAQ I'll change the format of the query so that instead of the tables it will have a list of sections
  • in FAQLong the main section title should be constructed from the properties (I'll have a look on how to do that)
Bgschaid (talk)11:38, 16 September 2013

I've finished the mission of copy-paste-adjusting all of the other sections for the new FAQ. I'll try to take take to start adding new stuff regarding ParaView next weekend.

In the mean time, the section breaks are looking a bit strange in the FAQLong page, because the description seems to be floating between the section header and its content. Which leads me to this question: should each section and sub-section have a space before the header starts?

It's just that I personally prefer a nice space prepended to each header title, since it makes it a bit easier to see what I'm looking for.


By the way, while editing this reply, there was this strange code below the line with the buttons "Save page" et al:

//<![CDATA[ var GME_SMALL_ICON; var editors_options

and it continues for a while... until:

 addLoadEvent(insertGoogleMapLinks); //]]> 
Wyldckat (talk)23:06, 21 September 2013

Thanks for your work:

Concerning the problem with the FAQLong: had a look at http://semantic-mediawiki.org/wiki/Help:Embedded_format but there seems to be no parameter to add stuff before or after the pages and I'm afraid http://semantic-mediawiki.org/wiki/Help:Template_format doesn't allow me to include whole pages

The strange out: I noticed it too. It seems like the extension for threaded discussions and the new editor clash. I'll have a look

Bgschaid (talk)00:20, 23 September 2013
 

I decided to switch the new FAQ online despite the minor formatting problems. THe old FAQ is now Read-only and will be removed eventually

Bgschaid (talk)11:51, 9 October 2013

Nice!

One quick question: remember the OF version image kit I had prepared and abandoned at Help_talk:Editing? Should/can I move it to the FAQ/Wiki section?

Wyldckat (talk)22:04, 11 October 2013

No: I don't remember it Yes: that's a good idea

Bgschaid (talk)22:13, 11 October 2013