Jump to content
Sign in to follow this  
josh1178

Pagelines - Bad Documentation

Recommended Posts

josh1178    10
josh1178

I've been away from Pagelines for a while now. I came back and was very impressed with all the new features and the new web design.

But then, as I dig around further I notice that things are still a mess.

For example:

Scroll Spy - I'd like to know what it is and how to use it.

I go to: http://demo.pagelines.me/sections/ to get a feel for what it is

The description mentions unicorns and spies in an effort to be cute

While cute, it's not helpful and quickly becomes frustrating when you read the 'explanation'

Explanation

.scroll-header is the class that triggers the scrolling. The class can be added to any element, and is not restricted to headings.

Ok great. But what the heck is Scroll Spy?

Let's look it up in the pagelines documentation:

So, I go to: http://www.pagelines.com/wiki/Main_Page

I click on How to Use ScrollSpy:

In PageLines Framework 2.2, we have added a new Section called ScrollSpy. The ScrollSpy section adds an additional navigation bar that automatically updates nav targets based on scroll position. It is also useful for jumping from one section of your page to another instantly.

Great, a practical definition!

Let's look at the images. Wait, why do all the images say "

Placeholder image for ScrollSpy Content sreenshots"

Wait, scroll down a bit and there is Latin!

Integer pharetra, tortor nec volutpat accumsan, ligula enim consectetur erat, porta imperdiet felis orci eget purus. Phasellus non auctor magna. Vestibulum at augue sit amet quam scelerisque rutrum. Aliquam erat volutpat. Cras lectus dolor, tincidunt laoreet molestie ac, vehicula sed ante.

So, I hunt around for more info on the page and find these this:

ScrollSpy works within your Page's editor, as long as ScrollSpy is enabled on the template your page is using. For a more in depth look and tutorial on how to get ScrollSpy working on your page, please visit the new PageLines Framework 2.2 Demo Site.

But that link goes here!

http://www.iana.org/domains/example/

WTF

I find some more links that say:

In order to get ScrollSpy working on your page, it needs to be enabled in the Drag and Drop menu, and in the Template Setup area.

More info on template setup here

I click that and it takes me to a page that says:

Redirect page

redirectltr.pngHow to use Drag & Drop

WTF

You guys really need to get it together. I just wanted a picture and definition of what the ScrollSpy section does. Next time I'll google it or just post to the forum or try to figure it out on my own, because the documentation/wiki is an obvious afterthought. Or maybe I'm supposed to buy Pagelines plus to deal with the headache?

The attribute title="Usage" is used as the actual label that sits inside the menu.

Share this post


Link to post
Share on other sites
josh1178    10
josh1178

So, I figured out Scroll Spy and in the end it was quite simple. Shame it took ages to decipher what could have been simple instructions that looked something like this:

Scroll Spy use the grey navigation menu on this very page to see Scroll Spy in action!

Basics: Scroll Spy allows you to make a menu that sticks to the top of the page when you scroll.

To use: Activate the Scroll Spy section in your template setup to determine where on your page the menu sits in relation to other sections. Then just add the following code on your page.

  • <h4 class="scroll-header" title="Boxes"></h4>
  • <p>Box section description</p>
  • <h4 class="scroll-header" title="Banners"></h4>
  • <p>Banner section description</p>

  • <h4 class="scroll-header" title="Masthead"></h4>
  • <p>Banner section description</p>

Notice that the text you use as the 'title' automatically becomes an entry in the navigation menu in the Scroll Spy section.

Explanation

.scroll-header is the class that triggers the scrolling. The class can be added to any element, and is not restricted to headings.

The attribute title="Usage" is used as the actual label that sits inside the menu.

Add a Styled Heading

If you want to make styled headings, like the ones used throughout this page, wrap the markup in a div like in the example.

Explanation

.page-header is the class that makes the heading and subheading look great.

Share this post


Link to post
Share on other sites
Danny    1,327
Danny

Hi Josh,

We are currently in the process of updating the documentation for you guys (I'm the one doing it) and if you can provide me with any feedback, that would be awesome. Please send me a PM on the forums with anything you think should be added, improved upon etc...


Please search our forums, before posting!

Share this post


Link to post
Share on other sites
Danny    1,327
Danny

The topic was marked as resolved.


Please search our forums, before posting!

Share this post


Link to post
Share on other sites
fotoramonzi    0
fotoramonzi

Ninja, you claimed almost a year ago that the documentation was being updated. I bought Pagelines a little less than a year ago and I have to say that the documentation is horrible. It's unfinished, confusing and seems to be written solely for developers and not designers. Another good example would be the bootstrap implementation. Why not just include the entire menu? Specifically, why the hell didn't you guys add the bootstrap affix plugin? I didn't pay 2 bones to be this fucking frustrated.

Share this post


Link to post
Share on other sites
Danny    1,327
Danny

Hi,

 

You can find our documentation here - http://support.pagelines.me/docs/

I am still in the process of adding the images and adding new articles to help everyone, but these are an improvement on the previous docs. If you have any feedback, please let me know, any feedback is most welcome.


Please search our forums, before posting!

Share this post


Link to post
Share on other sites
fotoramonzi    0
fotoramonzi

Thanks for the link Danny. Can't believe I haven't seen this yet, considering that the link is on the main pagelines page

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

Sign in to follow this  

  • Similar Content

    • tdiaz
      By tdiaz+
      When are the docs pages going to refilled? 
      ..and will the content they have replaced be made available somewhere else?
      A bit too far into a DMS2 project to drop it for Platform 5,  but it certainly gives the impression it will be a lot more of a peppy, positive experience, so I'll shoot for that as the second rollout of the site, but until then- the inbuilt links to content (Docs, sections, answers..) in DMS 2 are either 404 or empty. Perhaps a revision that redirects those pages to the old content so it's available where it's needed and not on the current site / product offering where it would could cause confusion and such.
      I will say, I got into Pagelines because my interpretation of it was that it combines the easy (better) parts of NationBuilder, Webly, et al- and allows one to still have ultimate control, where with the aforementioned platforms, you are basically .. SOL. 
       
      -BUT- it took a while for exactly what was going on, what all the pieces were, and what exactly the product really was, to click with me. 
      I might add that, it was looking at the Platform 5 preview that it all started to make sense. Because Platform 5 is not a huge clusterfudge of a pile of stuff that is all essentially the same thing.
      I wanted a theme, (WHP), then I saw the options, "oh, well if I get this, then I have 'more'" as the lineup gave me the impression that I can get "the theme" -or- I can get the theme and the framework, along with the PSDs and similarly related assets. 
       
      Platform 5 doesn't do any of that at all, but rather say "Here I am, this is going to be great!, Let's go!"
       
    • Danny
      By Danny
      Hello, everyone.

      As you're aware, I am in the process of writing the documentation for the Platform plugin as well as creating introduction videos for all sections.

      Although this is a rough draft of the video, it should give you some idea as to what to expect from them. Please check it out on the link below, please do not share the video, as it is a draft and contains some mistakes.

      Another idea for the section docs after they're finished was to add the following:

      A reference to the shortcode that generates the section, so you can quickly see the shortcode that generates that section. Like so:
      [pl_section section="boxes" id="Unique ID"] Another idea was to include some of the sections classes, as a reference:
      .pl-sn-boxes .box-title .boxes-pad .boxes-media .boxes-icon Let me know what you think of these ideas and the video please.

      https://www.youtube.com/watch?v=nDSxOGFQbE0
    • micstepl
      By micstepl+
      the logo sizing option is
      not expalined not logical
    • dawsonbarber
      By dawsonbarber+
      Currently, the main heading for an element is automatically wrapped with a <h1> tag.
      That's okay if the content its wrapping around is, in fact, meant to be the main heading for the page.
      But I suspect there may be people who will already have a heading on the page wrapped with <h1> tags, so that's going to create a bit of a semantic issue (theoretically, from what I understand about HTML5 spec, it is possible to have more than one <h1> tag on a page, but you really need to know what you're doing).
      So I think that designers should have the option to select that tag for each text part that makes up an element.
      Additionally, if the main heading of an element is being used as the <h1> heading for a page, if designers are able to select the tag, then it should automatically wrap the <h1> tag with <header> tags (and maybe even the appropriate classes - e.g., entry-heading, entry-title).
      When you look at the other text parts that make up an element, you see that the subheading is automatically wrapped in a <h3> tag.
      If the main heading tag is a <h1> tag (as it is at present) then, logically/semantically, the subheading should be wrapped in <h2> tags or <p> tags (perhaps it could be set conditionally - depending on designer selection of main heading).
      Further, the subheading <h3> tag actually wraps around <p> tags that contain the subheading content.
      That makes no sense whatsoever.
      Finally when you specify a tag in the paragraph textbox of an element, it doesn't actually that tag as HTML. Instead, it adds a class - using the specified tag (e.g., class="h2") to a span.
      That also does not make sense.
    • Buishi
      By Buishi
      Hi there,
       
      I'm having the following problem: I set up a scroll spy on my homepage, and put several sections throughout the homepage with .scroll-headers (for example: <h4 class="scroll-header" title="Testimonials">Testimonials</h4>). The problem is, the menu highlighting doesn't change as I scroll, only the last menu item remains highlighted. Any idea what's going on? See here:
       
      http://designmancan.com/CLL/
×