Skip to content

Commit

Permalink
Merge pull request #530 from yast/all-in-one-overview
Browse files Browse the repository at this point in the history
Declare simple_mode for make_proposal (FATE#322328)
  • Loading branch information
mvidner committed Jan 17, 2017
2 parents 2bff540 + e97976f commit f23b545
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions library/general/src/lib/installation/proposal_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ def run
# submodules that translate any strings internally based on internal maps
# (e.g., keyboard etc.) need to take more action.
#
# @option attrs [Boolean] "simple_mode"
# Propose in a different format,
# pioneered in the CASP/CaaSP all-in-one dialog: we are short of space,
# and employ labels instead of RichText.
# The result must include `label_proposal`.
#
# @return [Hash] containing:
#
# * **`"links"`** [Array<String>] ---
Expand All @@ -126,12 +132,17 @@ def run
# Human readable proposal preformatted in HTML. It is possible to use
# the {Yast::HTMLClass Yast::HTML} module for such formatting.
#
# * **`"raw_proposal"`** [Array<String>, nil]
# (only used if `preformatted_proposal` is not present) ---
# * **`"raw_proposal"`** [Array<String>, nil] ---
# (only used if `preformatted_proposal` is not present)
# Human readable proposal, not formatted yet.
# The caller will format each item as a HTML list item (`<li>`). The
# proposal can contain hyperlinks with IDs listed in the list `links`.
#
# * **`"label_proposal"`** [Array<String>, nil] ---
# (only used for `simple_mode`)
# Human readable proposal.
# The caller will format each item as Label.
#
# * **`"warning"`** [String, nil] ---
# Warning in human readable format without HTML tags other than `\<br>`.
# The warning will be embedded in appropriate HTML format specifications
Expand Down

0 comments on commit f23b545

Please sign in to comment.