Jump to content

Pages SuperHelp support topic


opentype
 Share

Recommended Posts

Support topic for: 

Pages SuperHelp is a set of Pages templates for help/FAQ sections, tutorials, online courses and similar content. 

What’s needed: 

  • IPS 4.1 in its most recent version with the Pages application
  • A Pages databases that uses several levels of categories. 

Benefits of SuperHelp:

The Pages stock templates are limited to show only one level at a time: One level of categories; one level of record links in one category; one full record. SuperHelp is based on IPS’ Help Guide Section and can show much more information and make browsing your database much easier. The template set has a beautiful and clean look and is of course fully responsive. It adopts to almost all IPS sites and the included settings plugin lets you edit the template appearance without any HTML knowledge.  

What is included:

  • A Frontpage category listing template which shows main and sub categories. 
  • A Listing template which shows sub categories, records in sub-categories and records in the current category.
  • Record View template with a sidebar, which shows other records in the same category.
  • A Plugin which lets you change the settings of the templates easily. 
  • An installation PDF with detailed instructions and tips to set up your SuperHelp database. 

Plugin Settings:

  • Show category follow button: Yes/No
  • Show record images in listing view: Yes/No
  • Show record image in record view: Yes/No
  • Number of lines after which the preview text gets cut off
  • Number of records to show in a sub-category list
  • Type of icon to use for help steps: Automatic numbering or user-defined FontAwesome pictogram
  • Text alignment for title/description on frontpage
  • Text alignment for title/description on listing page
  • Text alignment for category title/description on frontpage

Expert options:

  • Add category image to your main categories
  • Override the styling (e.g. icon colors) in your theme’s custom.css
Link to comment
Share on other sites

@opentype Thanks for offering this into the Marketplace.  I'm about to get this up and running in less than 3 minutes; your instructions were very helpful.

Note: If anybody is using the application "Advanced Tags & Prefixes" by @Ryan H., you will need to disable the application first in order to save SuperHelp's templates to the database.  Then after saving, enable the application.  This is a known problem with Advanced Tags & Prefixes.

Another Note: This really does work better with a mix of sub-categories and records.  The layout is much better.  

Questions:

  • Category Images.  I'm able to get the record image to work on my articles, but not sure where I upload the category image??  I've looked through all tabs of the category settings, and do not see anything.  This would be your "Apple Watch" photo or the "2 Mac computers" in your Marketplace listing's screenshot.  

Suggestions:

  • Customize fa-icon per category.  I don't really use steps in my help database, so I've defaulted to the fa-information icon.  It can be kind of bland when it's the same fa-icon for every category.  
  • Suggestions on wording: In the language for the Plugin settings, I'd like to suggest changes to the language string to make it more clear:
    • Frontpage: Category Title / Description Alignment
    • Frontpage: Subcategory Title / Description Alignment
    • Listing: Category Title / Description Alignment.  

 

 

Link to comment
Share on other sites

7 minutes ago, CP_User said:

@opentype I've set the plugin to center everything, but the categories shown on a 1 column page make them sit all to the left, is there a way to keep them as floating left but centered?

can you post a screenshot of the section you are referring to?

If you mean the sub categories which can have records with the step counter list, then no – they will always be left-aligned, because the lists need to be left aligned and a centered headline over that left-aligned list just looks terrible. I actually started putting in that option, but then removed it again after seeing the result. ;-)

Link to comment
Share on other sites

2 minutes ago, opentype said:

If you mean the sub categories which can have records with the step counter list, then no – they will always be left-aligned, because the lists need to be left aligned and a centered headline over that left-aligned list just looks terrible. I actually started putting in that option, but then removed it again after seeing the result. ;-)

I guess that's the answer lol, I find it looks a little weird shift to the left, leaving a gap on the right. But if it's got to be like that then that's fine. :-)

Link to comment
Share on other sites

Looks great! I wonder why IPS themselves don't offer a template collection....

First question:

I'd like to realize several different FAQs, f.e.

  • FAQ for admins
  • FAQ for mods
  • FAQ for member
  • FAQ for prize games

And I'm not sure if I can operate these different FAQs with different view & read permissions. My members shouldn't view the administration instructions a.s.o.

Second question:

Do the templates have easy options for reordering FAQs, 1st level and 2nd level titles?

And f.e. move a section from admin FAQ to mod FAQ easily?

Thanks for response!

Link to comment
Share on other sites

31 minutes ago, Cyboman said:

I'd like to realize several different FAQs, f.e.

And I'm not sure if I can operate these different FAQs with different view & read permissions. My members shouldn't view the administration instructions a.s.o.

You can set the permissions per category if you want. So yes, that’s doable. 

 

31 minutes ago, Cyboman said:

Second question:

Do the templates have easy options for reordering FAQs, 1st level and 2nd level titles?

And f.e. move a section from admin FAQ to mod FAQ easily?

You can move the categories via drag and drop in the ACP as with any Pages database. That allows you a quick and easy reordering of the FAQ categories. 
The records themselves are ordered through the Pages database settings. You can add an ordering field to the database if you need better control. The installation PDFs gives some tips about that. 

Link to comment
Share on other sites

Hello

sorry to bother with something so basic but i don't understand the instructions for a clean new installation

There are two xml files, do i need to install them both? in any particular order? what do i do afterwards and where?

I installed the  pages_superhelp_plugin.xml file and I dont have any Pages menu anywhere , from the instructions i assume it should show on the ACP main categories menu?

 

 

 

Link to comment
Share on other sites

6 minutes ago, Kenneth Baker said:

There are two xml files, do i need to install them both? in any particular order? what do i do afterwards and where?

Just go by the included instruction PDF. It’s all explained in there. 

6 minutes ago, Kenneth Baker said:

I installed the  pages_superhelp_plugin.xml file and I dont have any Pages menu anywhere , from the instructions i assume it should show on the ACP main categories menu?

Pages is an IPS app and a requirement to use Pages templates like SuperGrid/SuperHelp. If you don’t have it yet, SuperHelp will be worthless. 

Link to comment
Share on other sites

Adding Category images - <img src=”http://myserver.com/uploads/first_category.jpg”> 

I've added this to the description box (main) but, the image doesn't show as the image isn't linking properly.
 

In the URL it shows - https://www.myserver.co.uk/admin/”http://www.myserver.co.uk/images/image1.jpg”

 

Edited by CP_User
Link to comment
Share on other sites

7 minutes ago, opentype said:

Then your IMG HTML code is wrong. But you would need to show me the original description or the actual site so I can see what it might be. 

The examples above use the wrong quotes. instead of ". Maybe it’s related to that. 

I simply copied the text from the help document and edited the url, I've PM'd you.

Link to comment
Share on other sites

I'd just like to gush my thanks for creating these templates. I pretty much purchased IPS because I loved their Guides section so much and was very disappointed to discover that their guide to how to make guides didn't exist. I'd been making do without them but I'm so happy to have been able to move my content over to this format. So thank you so much!!!

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.

×
×
  • Create New...