Topic on Extension talk:MintyDocs

An example of usage would be really great.

10
Serdar.sanri (talkcontribs)

Hi Yaron, I have been trying trying to figure out this for days now and still did not succeed. I have also installed Canasta with Tech Docs addon ( simply creates all the categories, forms and templates for minty docs ). My problem is as in instructions, I created Product Page, then version as sub page. I can see versions listed in Product page. Then I created Manual Page under version. Version also shows manuals. All good until this point. But in manual page if I create the list of topics, doesn't show anything. When I debug the code, getPossiblyInheritedParam and getInheritedParam functions gets called and they return null for $paramValues null for MintyDocsTopicsList. I tried to add topics in Manual Page and/or as sub page of Manual but still couldn't figure out how to do this part. If you can add a short usage example either here or in repo that would be great. Thanks for your help

Yaron Koren (talkcontribs)

Hi - you can see an example of a MintyDocs topic page here, and the associated manual page is here. in both cases, the pages call the respective MintyDocs parser function through a template.

It's great that you tried out the Canasta Tech Docs package! Although it's unfortunate that the topics stuff isn't working for you. I don't know if that's an error in your implementation, or in the package, or in MintyDocs itself. We're actually planning to add another package, this one of a sample set of documentation pages that use the main "Tech Docs" package - which will hopefully make the MintyDocs stuff easier to understand, and maybe uncover any bugs that exist.

As for the problem you're currently seeing - could it be that you didn't actually create the page for each topic?

47.195.28.182 (talkcontribs)

Hi Yaron, I think I figured out the issue. The theme I was using ( Timeless ) seems to be not supporting sidebarTOC so even though I create the topics nothing was shown. I did some modification and now able to generate a toc.

My other question will be usage of ToC links. So in some cases I have a top level topic with barely any content but several sub-topics with content. Is there a way to link all those sub topics to single page. For instance


....

2. General Overview and Design Guidelines & Approach

2.1 General Overview

2.2 Assumptions & Constraints & Risks

2.2.1 Assumptions

2.2.2 Constraints

2.2.3 Risks

2.3 Alignment with Federal Laws

.....


on above topics `2. General Overview and Design Guidelines & Approach` doesn't have any content. but sub topics has. Instead of creating a page for this, can I link this page to General Overview?

or add 2.1 General Overview, 2.2 , 2.3 contents in 2. General Overview and Design Guidelines & Approach but link the sub items in TOC to General Overview page?

Yaron Koren (talkcontribs)

I don't think there's any way to do that kind of customization, unfortunately.

Serdar.sanri (talkcontribs)

That's what I thought. Looking at implementation in php code, it can be done where it checks if a page exists or not. It may check if is there a pipe ( | ) character exists then link to first part use text as second part ( similar to how MediaWiki:Sidebar page works )


Another unrelated question. I created different groups for different departments with assigned admin, editor, reviewer permissions. I couldn't really find any information if it is possible to limit tokens field with users assigned to those groups. I am using SMW and with Page_Forms I can get all users by either

`{{{field|Admins|input type=tokens|values from namespace=User}}}`

or

`{{{field|Admins|input type=tokens|values from query=((:User:+))}}}`


which brings all users but I couldn't figure out a way to filter down users who are assigned in one of those permissions ( admin, editor, previewer ). Is there any way to do it in filters or does this need to be implemented in code base?

Yaron Koren (talkcontribs)

No, there's no way to do that, unless the group information is stored via (in your case) SMW.

Serdar.sanri (talkcontribs)

Yeah I figured. Unless there is some code changes it seems to be not possible. Totally sidetrack, after installing Canasta, I noticed few things doesn't work as it is in documentation. It might be an error on my end with configuration, One of them is there is no Special page for creating drafts. When I try to load that page by url it says there is no special page such as that. But I can see in source codes. Probably something missing. Another one is, probably indirectly related, if I go Draft:PageName and create the page all seems to be working for existing pages, but when I publish ( PageName exists or not ) it shows the list of items will be published but somehow it doesn't update the pages. for instance if I create Draft:FirstManual, and add {{Manual}} in it, then save. it works as expected as Draft page. When I click on Publish, it shows FirstManual and checkboxes then after I confirm I get a note says /wiki/FirstManual page will be created/updated. but when I go to the page, it doesn't transferred any content from Draft page. I need to re-check if it is only non-existing pages or existing ones too. but definitely not for first-time publishing.

Yaron Koren (talkcontribs)

For the first issue - what was the page you were trying to load?

Serdar.sanri (talkcontribs)

I was following this instruction

"For pages that don't yet have a draft page, but for which you want to create a draft page, you can go to Special:MintyDocsCreatePage/PageName and create that draft page or pages. It works essentially the same as "publishing", but going the other way, and it can only be done if the target page does not exist yet."


I created a page called TestPage. then tried to load Special:MintyDocsCreatePage/TestPage returns

No such special page

Page actions

  • Refresh

You have requested an invalid special page.

A list of valid special pages can be found at Special pages.

Return to Main Page.

Yaron Koren (talkcontribs)

Sorry about that - that was an error in the documentation, that was there for five years! The page is actually Special:MintyDocsCreateDraft, not Special:MintyDocsCreatePage. I just fixed it, finally.

Reply to "An example of usage would be really great."