Skip to content

Improved HTML output of sidebarlogo and simplfied user interface#33

Closed
ogerlach wants to merge 6 commits intos9y:masterfrom
ogerlach:master
Closed

Improved HTML output of sidebarlogo and simplfied user interface#33
ogerlach wants to merge 6 commits intos9y:masterfrom
ogerlach:master

Conversation

@ogerlach
Copy link
Copy Markdown
Contributor

These are the most important changes and the reason for each change:

  1. Changed application of stylesheets: Old version added a style-tag into the body which works in most browsers but violates HTML rules. New version now uses the style attribute instead or uses id or classes from the theme stylesheet. This method is preferred over inline styles.
  2. Added an alt-tag option for the image since this is required by HTML.
  3. Made only the most basic field visible by default. This is true for backend, where advanced options are now placed in groups as well as the frontend where only title, logo and description are visible by default. The backend contains a group for all the styles needed and a group for the advanced fields as well as sorting of all elements inside the plugin. This makes the plugin easier to start with while preserving the full functionality.

I believe that these changes provides a good compromise between required features and complexity. Different to HTML nugget it already provides the basic formatting and elements of a common sidebar item (title, description block). With the option to provide a logo, it is definitely sufficient to provide an about box many blogs use. While more advanced options are possible, the average user is not overwhelmed by a large set of options. This is especially true after dropping the style-tag, thereby creating the need for a style configuration field for each extra element present in the plugin. Yet all the options are available.

Oliver

…into the body

   which works in most browsers but violates HTML rules (validator complains).
   New version now uses the style attribute instead.
2. Allowed the use of IDs or classes instead of custom styledefinitions by starting
   the style definition with '.' or '#'. This makes it easier to match the design of
   the currently selected theme.
3. Added an alt-tag option for the image since this is required by HTML (validator
   complains).
4. Reduced the plugin to title, image and description. This allows the plugin to work
   using only styles found within the theme stylesheet and fits more closely to about
   boxes found on many blogs. Copyright and other information can easily be integrated
   into description providing more flexiblity and a more straight forward configuration
   interface at the same time.
Introducing changes from upstream to my fork
…ht and contact.

   Some users might use them and we do not want to break compatability for them.
   Additionally those users chose the plugin to not use HTML. Therefore the initial
   approach of adding these fields via HTML in description is not acceptable.
2. Since many users might not want to use the extra fields (most about boxes contain
   nothing more but a image with some text), those extra fields are grouped together.
   The group is only unfolded upon request. This avoids overwhelming the user. The
   plugin now starts with a very basic set of options and offers more on request.
3. The sequence of elements was added again. It is also part of the group mentioned
   above for the same reasons. It now contains the option to enable or disable each
   element and by default only shows the most basic elements.
4. A delimiter element was added to remove the default HTML code from description.
   The delimiter is needed for text flow control. Otherwise the image might extent
   beyond the sidebar element if not enough other content is visible. The HTML
   normally used for that is hidden within the delimiter.
5. CSS configuration options were added for all elements that have been reintroduced.
   They were move into a group together with all other styling elements. It is
   assumed that most of the time the user does not want to change styling of his or
   her page but focusses on content. The styling option should therefore not be
   visible by default.
6. Language files for English (default) and German were updated to support the new
   features. Serbian and Czech translation are lacking some of the new features.
@ghost ghost assigned garvinhicking Nov 25, 2013
@onli
Copy link
Copy Markdown
Member

onli commented Nov 25, 2013

Discussion on the forum: http://board.s9y.org/viewtopic.php?f=4&p=10437631

@garvinhicking
Copy link
Copy Markdown
Member

Sadly the code is very hard to review due to the upstream change and the removal and then readdition of the sequence things. Would you be able to create a fresh pull request that contains the final version of the patch only? That would be great :-)

@ogerlach
Copy link
Copy Markdown
Contributor Author

Sure. I'll try to do it within the next few days.

@ogerlach
Copy link
Copy Markdown
Contributor Author

Hello Garvin,
I created a new pull request from a fresh fork of the repo. I cannot assign it myself, though.

@garvinhicking
Copy link
Copy Markdown
Member

Great work! I'll commit this asap.

On 27.11.2013, at 19:10, ogerlach notifications@github.com wrote:

Hello Garvin,
I created a new pull request from a fresh fork of the repo. I cannot assign it myself, though.


Reply to this email directly or view it on GitHub.

@th-h
Copy link
Copy Markdown
Member

th-h commented Jun 9, 2014

I think this pull request could be closed as its contents was applied with #34 ?

@yellowled yellowled closed this Jun 10, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants